org.eclipse.emf.mwe.core
Interface WorkflowComponent

All Known Subinterfaces:

WorkflowComponentWithID

All Known Implementing Classes:

AbstractEMFWorkflowComponent, AbstractWorkflowAdvice, AbstractWorkflowComponent, AbstractWorkflowComponent2, CompositeComponent, ConditionalComponent, DirectoryCleaner, FeatureComponent, FileCopy, IfComponent, Reader, Workflow, WorkflowComponentWithModelSlot, Writer

public interface WorkflowComponent

WorkflowComponents are components that can be executed by the Model Workflow Engine.

The Workflow Engine will call the #invoke(WorkflowContext, ProgressMonitor) method at the appropriate time to execute the component's service.

Author:

Sven Efftinge (http://www.efftinge.de)

Method Summary

void	checkConfiguration(Issues issues) Called by the container after configuration so the component can validate the configuration before invocation.
java.lang.String	getComponentName() Returns the name of the component.
CompositeComponent	getContainer() Returns the containing component if there is one.
Location	getLocation() Returns the location in the source file that invokes the current component.
void	invoke(WorkflowContext ctx, ProgressMonitor monitor, Issues issues) Invokes the component.
void	setContainer(CompositeComponent container) Sets the containing component.
void	setLocation(Location location) Sets the location in the source file that invokes the current component.

Method Detail

invoke

void invoke(WorkflowContext ctx,
            ProgressMonitor monitor,
            Issues issues)

Invokes the component.

Parameters:

ctx - current workflow context

monitor - implementors should provide some feedback about the progress using this monitor

issues -

checkConfiguration

void checkConfiguration(Issues issues)

Called by the container after configuration so the component can validate the configuration before invocation.

Parameters:

issues - implementors should report configuration issues to this.

getContainer

CompositeComponent getContainer()

Returns the containing component if there is one.

Returns:

the containing component

setContainer

void setContainer(CompositeComponent container)

Sets the containing component.

Parameters:

container - the containing component

setLocation

void setLocation(Location location)

Sets the location in the source file that invokes the current component.

Parameters:

location - the location

getLocation

Location getLocation()

Returns the location in the source file that invokes the current component.

Returns:

the location

getComponentName

java.lang.String getComponentName()

Returns the name of the component.

Returns:

the component name

Since:

4.3.1