Package net.officefloor.plugin.section.transform

Class TransformSectionDesigner

java.lang.Object

net.officefloor.plugin.section.transform.TransformSectionDesigner

All Implemented Interfaces:

SourceIssues, SectionDesigner

public class TransformSectionDesigner
extends Object
implements SectionDesigner

SectionDesigner to intercept configuration to provide access to the SectionSource configured items.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
TransformSectionDesigner(SectionDesigner delegate)	Initiate.

Method Summary

Modifier and Type	Method	Description
CompileError	addIssue(String issueDescription)	Allows the source to add an issue.
CompileError	addIssue(String issueDescription, Throwable cause)	Allows the source to add an issue along with its cause.
SectionManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, String managedObjectPoolSourceClassName)	Adds an SectionManagedObjectPool.
SectionManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds a SectionManagedObjectPool.
SectionFunctionNamespace	addSectionFunctionNamespace(String namespaceName, String managedFunctionSourceClassName)	Adds a SectionFunctionNamespace to the SectionNode being built.
SectionFunctionNamespace	addSectionFunctionNamespace(String namespaceName, ManagedFunctionSource managedFunctionSource)	Adds a SectionFunctionNamespace to the SectionNode being built.
SectionInput	addSectionInput(String inputName, String parameterType)	Adds a SectionInput to the SectionNode being built.
SectionManagedObjectSource	addSectionManagedObjectSource(String managedObjectSourceName, String managedObjectSourceClassName)	Adds a SectionManagedObjectSource to the SectionNode being built.
SectionManagedObjectSource	addSectionManagedObjectSource(String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource)	Adds a SectionManagedObjectSource to the SectionNode being built.
SectionObject	addSectionObject(String objectName, String objectType)	Adds a SectionObject to the SectionNode being built.
SectionOutput	addSectionOutput(String outputName, String argumentType, boolean isEscalationOnly)	Adds a SectionOutput to the SectionNode being built.
SubSection	addSubSection(String subSectionName, String sectionSourceClassName, String location)	Adds a SubSection to the SectionNode being built.
SubSection	addSubSection(String subSectionName, SectionSource sectionSource, String location)	Adds a SubSection to the SectionNode being built.
SectionInput	getSectionInput(String inputName)	Obtains the SectionInput.
SectionOutput	getSectionOutput(String outputName)	Obtains the SectionOutput.
SubSection	getSubSection(String subSectionName)	Obtains the SubSection.
void	link(FunctionFlow functionFlow, SectionFlowSinkNode sectionSinkNode, boolean isSpawnThreadState)	Links the FunctionFlow to be undertaken by the SectionFlowSinkNode.
void	link(SectionDependencyRequireNode sectionRequireNode, SectionDependencyObjectNode sectionObjectNode)	Links the SectionDependencyRequireNode to be fulfilled by the SectionDependencyObjectNode.
void	link(SectionFlowSourceNode flowSourceNode, SectionFlowSinkNode flowSinkNode)	Links the SectionFlowSourceNode to undertaken by the SectionFlowSinkNode.
void	link(SectionManagedObjectSource managedObjectSource, SectionManagedObjectPool managedObjectPool)	Links the SectionManagedObjectSource to be pooled by the SectionManagedObjectPool.

Methods inherited from class java.lang.Object

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

Constructor Details

TransformSectionDesigner

public TransformSectionDesigner(SectionDesigner delegate)

Initiate.

Parameters:

delegate - Delegate SectionDesigner.

Method Details

getSectionInput

public SectionInput getSectionInput(String inputName)

Obtains the SectionInput.

Parameters:

inputName - Name of the SectionInput.

Returns:

SectionInput.

getSectionOutput

public SectionOutput getSectionOutput(String outputName)

Obtains the SectionOutput.

Parameters:

outputName - Name of the SectionOutput.

Returns:

SectionOutput.

getSubSection

public SubSection getSubSection(String subSectionName)

Obtains the SubSection.

Parameters:

subSectionName - Name of the SubSection.

Returns:

SubSection.

addSectionInput

public SectionInput addSectionInput(String inputName,
 String parameterType)

Description copied from interface: SectionDesigner

Adds a SectionInput to the SectionNode being built.

Specified by:

addSectionInput in interface SectionDesigner

Parameters:

inputName - Name of the SectionInput.

parameterType - Parameter type for the SectionInputType.

Returns:

SectionInput for linking.

addSectionOutput

public SectionOutput addSectionOutput(String outputName,
 String argumentType,
 boolean isEscalationOnly)

Description copied from interface: SectionDesigner

Adds a SectionOutput to the SectionNode being built.

Specified by:

addSectionOutput in interface SectionDesigner

Parameters:

outputName - Name of the SectionOutput.

argumentType - Argument type for the SectionOutputType.

isEscalationOnly - true if only ManagedFunctionEscalationType instances are using the SectionOutputType.

Returns:

SectionOutput for linking.

addSectionObject

public SectionObject addSectionObject(String objectName,
 String objectType)

Description copied from interface: SectionDesigner

Adds a SectionObject to the SectionNode being built.

Specified by:

addSectionObject in interface SectionDesigner

Parameters:

objectName - Name of the SectionObject.

objectType - Type required for the SectionObjectType.

Returns:

SectionObject for linking.

addSectionFunctionNamespace

public SectionFunctionNamespace addSectionFunctionNamespace(String namespaceName,
 String managedFunctionSourceClassName)

Description copied from interface: SectionDesigner

Adds a SectionFunctionNamespace to the SectionNode being built.

Specified by:

addSectionFunctionNamespace in interface SectionDesigner

Parameters:

namespaceName - Name of the SectionFunctionNamespace.

managedFunctionSourceClassName - Fully qualified class name of the ManagedFunctionSource. This allows adding the SectionFunctionNamespace without having to worry if the ManagedFunctionSource is available on the class path.

Returns:

SectionFunctionNamespace.

addSectionFunctionNamespace

public SectionFunctionNamespace addSectionFunctionNamespace(String namespaceName,
 ManagedFunctionSource managedFunctionSource)

Description copied from interface: SectionDesigner

Adds a SectionFunctionNamespace to the SectionNode being built.

Specified by:

addSectionFunctionNamespace in interface SectionDesigner

Parameters:

namespaceName - Name of the SectionFunctionNamespace.

managedFunctionSource - ManagedFunctionSource instance to use.

Returns:

SectionFunctionNamespace.

addSectionManagedObjectSource

public SectionManagedObjectSource addSectionManagedObjectSource(String managedObjectSourceName,
 String managedObjectSourceClassName)

Description copied from interface: SectionDesigner

Adds a SectionManagedObjectSource to the SectionNode being built.

Specified by:

addSectionManagedObjectSource in interface SectionDesigner

Parameters:

managedObjectSourceName - Name of the SectionManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource. This allows adding the SectionManagedObject without having to worry if the ManagedObjectSource is available on the class path.

Returns:

SectionManagedObject.

addSectionManagedObjectSource

public SectionManagedObjectSource addSectionManagedObjectSource(String managedObjectSourceName,
 ManagedObjectSource<?,?> managedObjectSource)

Description copied from interface: SectionDesigner

Adds a SectionManagedObjectSource to the SectionNode being built.

Specified by:

addSectionManagedObjectSource in interface SectionDesigner

Parameters:

managedObjectSourceName - Name of the SectionManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

SectionManagedObject.

addManagedObjectPool

public SectionManagedObjectPool addManagedObjectPool(String managedObjectPoolName,
 String managedObjectPoolSourceClassName)

Description copied from interface: SectionDesigner

Adds an SectionManagedObjectPool.

Specified by:

addManagedObjectPool in interface SectionDesigner

Parameters:

managedObjectPoolName - Name of the SectionManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added SectionManagedObjectPool.

addManagedObjectPool

public SectionManagedObjectPool addManagedObjectPool(String managedObjectPoolName,
 ManagedObjectPoolSource managedObjectPoolSource)

Description copied from interface: SectionDesigner

Adds a SectionManagedObjectPool.

Specified by:

addManagedObjectPool in interface SectionDesigner

Parameters:

managedObjectPoolName - Name of the SectionManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

SectionManagedObjectPool.

addSubSection

public SubSection addSubSection(String subSectionName,
 String sectionSourceClassName,
 String location)

Description copied from interface: SectionDesigner

Adds a SubSection to the SectionNode being built.

Specified by:

addSubSection in interface SectionDesigner

Parameters:

subSectionName - Name of the SubSection.

sectionSourceClassName - Fully qualified class name of the SectionSource for the SubSection. This allows adding the SubSection without having to worry if the SectionSource is available on the class path. This should be used over attempting to find the SectionSource - as should leave to the compiler to find the SectionSource.

location - Location of the SubSection.

Returns:

SubSection.

addSubSection

public SubSection addSubSection(String subSectionName,
 SectionSource sectionSource,
 String location)

Description copied from interface: SectionDesigner

Adds a SubSection to the SectionNode being built.

Specified by:

addSubSection in interface SectionDesigner

Parameters:

subSectionName - Name of the SubSection.

sectionSource - SectionSource to enable providing direct instances. This should only be used should the SectionSource want to create a SubSection instance by supplying its own instantiated SectionSource implementation.

location - Location of the SubSection.

Returns:

SubSection.

link

public void link(SectionManagedObjectSource managedObjectSource,
 SectionManagedObjectPool managedObjectPool)

Description copied from interface: SectionDesigner

Links the SectionManagedObjectSource to be pooled by the SectionManagedObjectPool.

Specified by:

link in interface SectionDesigner

Parameters:

managedObjectSource - SectionManagedObjectSource.

managedObjectPool - SectionManagedObjectPool.

link

public void link(SectionFlowSourceNode flowSourceNode,
 SectionFlowSinkNode flowSinkNode)

Description copied from interface: SectionDesigner

Links the SectionFlowSourceNode to undertaken by the SectionFlowSinkNode.

Specified by:

link in interface SectionDesigner

Parameters:

flowSourceNode - SectionFlowSourceNode.

flowSinkNode - SectionFlowSinkNode.

link

public void link(FunctionFlow functionFlow,
 SectionFlowSinkNode sectionSinkNode,
 boolean isSpawnThreadState)

Description copied from interface: SectionDesigner

Links the FunctionFlow to be undertaken by the SectionFlowSinkNode.

Specified by:

link in interface SectionDesigner

Parameters:

functionFlow - FunctionFlow.

sectionSinkNode - SectionFlowSinkNode.

isSpawnThreadState - Indicates if spawns ThreadState for Flow.

link

public void link(SectionDependencyRequireNode sectionRequireNode,
 SectionDependencyObjectNode sectionObjectNode)

Description copied from interface: SectionDesigner

Links the SectionDependencyRequireNode to be fulfilled by the SectionDependencyObjectNode.

Specified by:

link in interface SectionDesigner

Parameters:

sectionRequireNode - SectionDependencyRequireNode.

sectionObjectNode - SectionDependencyObjectNode.

addIssue

public CompileError addIssue(String issueDescription)

Description copied from interface: SourceIssues

Allows the source to add an issue.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

addIssue

public CompileError addIssue(String issueDescription,
 Throwable cause)

Description copied from interface: SourceIssues

Allows the source to add an issue along with its cause.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

cause - Cause of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.