|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openarchitectureware.workflow.lib.AbstractWorkflowComponent
org.openarchitectureware.workflow.container.CompositeComponent
public class CompositeComponent
Field Summary | |
---|---|
protected java.util.List<WorkflowComponent> |
components
All components aggregated by this composite |
protected org.apache.commons.logging.Log |
log
|
Constructor Summary | |
---|---|
CompositeComponent(java.lang.String name)
|
Method Summary | |
---|---|
void |
addBean(java.lang.Object obj)
Adds a bean. |
void |
addCartridge(Workflow cartridge)
Sets the aggregated components of this composite. |
void |
addComponent(WorkflowComponent component)
Sets the aggregated components of this composite. |
void |
addFeature(FeatureComponent comp)
adds a feature components to the list of components |
void |
addIf(IfComponent comp)
adds a conditionalcompositecomponent to the list of components |
void |
checkConfiguration(Issues issues)
Validates the configuration before invocation. |
java.lang.String |
getComponentName()
Override this method by custom components. |
java.util.List<WorkflowComponent> |
getComponents()
Returns a list of aggregated components. |
CompositeComponent |
getContainer()
Returns the containing component, if there is one. |
java.lang.String |
getId()
Returns the ID of the component. |
Location |
getLocation()
Returns the location of the entry in the parent workflow file. |
java.lang.String |
getLogMessage()
Returns the log message, |
java.lang.String |
getName()
Returns the name of the component. |
Location |
getOwnLocation()
Returns the location of the start and closing tags in the actual workflow file. |
java.lang.String |
getResource()
Returns the filename of the workflow. |
void |
invoke(WorkflowContext ctx,
ProgressMonitor monitor,
Issues issues)
Dispatches the invocation to all aggregated components. |
void |
put(WorkflowComponent comp)
Adds a workflow component. |
void |
setContainer(CompositeComponent container)
Sers the containing component. |
void |
setId(java.lang.String id)
Sets the ID of the workflow component. |
void |
setLocation(Location location)
Sets the location of the entry in the parent workflow file. |
void |
setOwnLocation(Location endLocation)
Sets the location of the start and closing tags in the actual workflow file. |
void |
setResource(java.lang.String resource)
Sets the filename of the workflow. |
Methods inherited from class org.openarchitectureware.workflow.lib.AbstractWorkflowComponent |
---|
checkRequiredConfigProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.commons.logging.Log log
protected java.util.List<WorkflowComponent> components
Constructor Detail |
---|
public CompositeComponent(java.lang.String name)
Method Detail |
---|
public java.util.List<WorkflowComponent> getComponents()
public java.lang.String getId()
WorkflowComponentWithID
getId
in interface WorkflowComponentWithID
getId
in class AbstractWorkflowComponent
AbstractWorkflowComponent.getId()
public void setId(java.lang.String id)
WorkflowComponentWithID
setId
in interface WorkflowComponentWithID
setId
in class AbstractWorkflowComponent
id
- the IDAbstractWorkflowComponent.setId(java.lang.String)
public java.lang.String getLogMessage()
WorkflowComponentWithID
getLogMessage
in interface WorkflowComponentWithID
getLogMessage
in class AbstractWorkflowComponent
AbstractWorkflowComponent.getLogMessage()
public void invoke(WorkflowContext ctx, ProgressMonitor monitor, Issues issues)
ctx
- the current workflow contextmonitor
- implementors should provide some feedback about the progress
using this monitorissues
- facility for reporting possible issues that occur during
invocationWorkflowComponent.invoke(org.openarchitectureware.workflow.WorkflowContext,
org.openarchitectureware.workflow.monitor.ProgressMonitor,
org.openarchitectureware.workflow.issues.Issues)
public void checkConfiguration(Issues issues) throws ConfigurationException
WorkflowComponent
issues
- facility for reporting configuration issues.
ConfigurationException
public java.lang.String getName()
public java.lang.String getResource()
public void setResource(java.lang.String resource)
resource
- the filenamepublic Location getLocation()
getLocation
in interface WorkflowComponent
getLocation
in class AbstractWorkflowComponent
AbstractWorkflowComponent.getLocation()
public void setLocation(Location location)
setLocation
in interface WorkflowComponent
setLocation
in class AbstractWorkflowComponent
location
- the locationAbstractWorkflowComponent.setLocation(org.openarchitectureware.workflow.ast.parser.Location)
public Location getOwnLocation()
public void setOwnLocation(Location endLocation)
endLocation
- the locationpublic void addBean(java.lang.Object obj)
obj
- the beanpublic void addComponent(WorkflowComponent component)
components
- Components to aggregate.public void addCartridge(Workflow cartridge)
components
- Components to aggregate.public void addIf(IfComponent comp)
comp
- the conditional componentpublic void addFeature(FeatureComponent comp)
comp
- the feature componentpublic CompositeComponent getContainer()
WorkflowComponent
getContainer
in interface WorkflowComponent
getContainer
in class AbstractWorkflowComponent
AbstractWorkflowComponent.getContainer()
public void setContainer(CompositeComponent container)
WorkflowComponent
setContainer
in interface WorkflowComponent
setContainer
in class AbstractWorkflowComponent
container
- The containing componentAbstractWorkflowComponent.setContainer(org.openarchitectureware.workflow.container.CompositeComponent)
public void put(WorkflowComponent comp)
comp
- the componentpublic java.lang.String getComponentName()
AbstractWorkflowComponent
getComponentName
in interface WorkflowComponent
getComponentName
in class AbstractWorkflowComponent
WorkflowComponent.getComponentName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |