org.eclipse.emf.ecp.emf2web.ui.handler

Class AbstractSchemaExportCommandHandler

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.core.commands.AbstractHandler

org.eclipse.emf.ecp.emf2web.ui.handler.AbstractSchemaExportCommandHandler

All Implemented Interfaces:

org.eclipse.core.commands.IHandler, org.eclipse.core.commands.IHandler2

Direct Known Subclasses:

ExportJSONFormsHandler

public abstract class AbstractSchemaExportCommandHandler
extends org.eclipse.core.commands.AbstractHandler

Abstract implementation for an handler responsible for exporting view models.

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaExportCommandHandler()

Method Summary

Modifier and Type	Method and Description
Object	execute(org.eclipse.core.commands.ExecutionEvent event) This implementation uses the getViews(ExecutionEvent) and openWizard(Collection, ExecutionEvent, Shell) methods to open an export wizard.
protected abstract GenerationController	getGenerationController() Returns the GenerationController which shall be used to generate the files.
protected abstract GenerationExporter	getGenerationExporter() Returns the GenerationExporter responsible for creating the files generated by the GenerationController.
protected org.eclipse.emf.common.util.URI	getLocationProposal(org.eclipse.core.commands.ExecutionEvent event) Returns a proposal for the export location.
protected abstract Collection<VView>	getViews(org.eclipse.core.commands.ExecutionEvent event) Returns the views which shall be exported.
protected void	handleRuntimeException(RuntimeException e) Is called if a RuntimeException occurs during execution.
protected int	openWizard(Collection<VView> views, org.eclipse.core.commands.ExecutionEvent event, org.eclipse.swt.widgets.Shell shell) The default implementation opens the ExportSchemaWizard using the generation handlers returned by getGenerationController() and getGenerationExporter().

Methods inherited from class org.eclipse.core.commands.AbstractHandler

addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, isHandled, removeHandlerListener, setBaseEnabled, setEnabled

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSchemaExportCommandHandler

public AbstractSchemaExportCommandHandler()

Method Detail

execute

public Object execute(org.eclipse.core.commands.ExecutionEvent event)
               throws org.eclipse.core.commands.ExecutionException

This implementation uses the getViews(ExecutionEvent) and openWizard(Collection, ExecutionEvent, Shell) methods to open an export wizard.

Parameters:

event -

Returns:

Throws:

org.eclipse.core.commands.ExecutionException

handleRuntimeException

protected void handleRuntimeException(RuntimeException e)
                               throws org.eclipse.core.commands.ExecutionException

Is called if a RuntimeException occurs during execution.

Parameters:

e - the RuntimeException.

Throws:

org.eclipse.core.commands.ExecutionException - Wraps the given RuntimeException and throws it.

openWizard

protected int openWizard(Collection<VView> views,
                         org.eclipse.core.commands.ExecutionEvent event,
                         org.eclipse.swt.widgets.Shell shell)

The default implementation opens the ExportSchemaWizard using the generation handlers returned by getGenerationController() and getGenerationExporter().

Parameters:

views - The views which shall be exported.

event - The ExecutionEvent which is given by the execute(ExecutionEvent) method.

shell - The shell for the wizard.

Returns:

The return value of the WizardDialog.

getLocationProposal

protected org.eclipse.emf.common.util.URI getLocationProposal(org.eclipse.core.commands.ExecutionEvent event)

Returns a proposal for the export location. The default implementation returns the container of the first selected element.

Parameters:

event - The ExecutionEvent which is given by the execute(ExecutionEvent) method.

Returns:

The location proposal for the export. null if no proposal could be determined.

getViews

protected abstract Collection<VView> getViews(org.eclipse.core.commands.ExecutionEvent event)

Returns the views which shall be exported.

Parameters:

event - The ExecutionEvent which is given by the execute(ExecutionEvent) method.

Returns:

The collection of views which shall be exported.

getGenerationController

protected abstract GenerationController getGenerationController()

Returns the GenerationController which shall be used to generate the files.

Returns:

The GenerationController which shall be used.

getGenerationExporter

protected abstract GenerationExporter getGenerationExporter()

Returns the GenerationExporter responsible for creating the files generated by the GenerationController.

Returns:

The GenerationExporter which shall be used.