Package net.officefloor.compile.impl.structure

Class SectionNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.SectionNodeImpl

All Implemented Interfaces:

ManagedFunctionRegistry, ManagedObjectRegistry, Node, SectionNode, SourceIssues, PropertyConfigurable, OfficeSection, OfficeSectionTransformerContext, OfficeSubSection, SectionDesigner, SubSection

public class SectionNodeImpl
extends Object
implements SectionNode

SectionNode implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.compile.internal.structure.SectionNode

TYPE

Constructor Summary

Constructors

Constructor	Description
SectionNodeImpl(boolean isSectionNamed, String sectionName, SectionNode parentSection, OfficeNode office, NodeContext context)	Initialises this SectionNode with the basic information.

Method Summary

Modifier and Type	Method	Description
void	addGovernance(OfficeGovernance governance)	Adds Governance for this OfficeSubSection.
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.
ManagedFunctionNode	addManagedFunctionNode(String functionName, String functionTypeName, FunctionNamespaceNode namespaceNode)	Adds an initialised ManagedFunctionNode to the registry.
ManagedObjectNode	addManagedObjectNode(String managedObjectName, ManagedObjectScope managedObjectScope, ManagedObjectSourceNode managedObjectSourceNode)	Adds an initialised ManagedObjectNode to the registry.
SectionManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, String managedObjectPoolSourceClassName)	Adds an SectionManagedObjectPool.
SectionManagedObjectPool	addManagedObjectPool(String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds a SectionManagedObjectPool.
void	addProperty(String name, String value)	Adds a Property to configure the item.
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.
void	autoWireObjects(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext)	Auto-wires the SectionObjectNode instances that are unlinked.
void	autoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto-wires the SectionFunction instances to a possible responsible Team.
void	buildSection(OfficeBuilder officeBuilder, OfficeBindings officeBindings, CompileContext compileContext)	Builds this OfficeSection for this SectionNode.
PropertyList	createPropertyList()	Creates a new PropertyList.
Node[]	getChildNodes()	Obtains the child Node instances.
DeployedOfficeInput	getDeployedOfficeInput(String inputName)	Obtains the DeployedOfficeInput.
GovernanceNode[]	getGoverningGovernances()	Obtains the GovernanceNode instances providing Governance over this SectionNode.
String	getLocation()	Obtains the location of the Node.
ManagedObjectNode	getManagedObjectNode(String managedObjectName)	Obtains the ManagedObjectNode from the registry.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
OfficeNode	getOfficeNode()	Obtains the OfficeNode containing this SectionNode.
OfficeSectionFunction	getOfficeSectionFunction(String functionName)	Obtains the OfficeSectionFunction instance particular to this OfficeSubSection.
OfficeSectionInput	getOfficeSectionInput(String inputName)	Obtains the OfficeSectionInput.
OfficeSectionManagedObject	getOfficeSectionManagedObject(String managedObjectName)	Obtains the OfficeSectionManagedObject particular to this OfficeSubSection.
OfficeSectionManagedObjectSource	getOfficeSectionManagedObjectSource(String managedObjectSourceName)	Obtains the OfficeSectionManagedObjectSource particular to this OfficeSubSection.
String	getOfficeSectionName()	Obtains the name of the OfficeSection.
OfficeSectionObject	getOfficeSectionObject(String objectName)	Obtains the OfficeSectionObject.
OfficeSectionOutput	getOfficeSectionOutput(String outputName)	Obtains the OfficeSectionOutput.
OfficeSubSection	getOfficeSubSection(String sectionName)	Obtains the OfficeSubSection.
Node	getParentNode()	Obtains the Node containing this Node.
SectionNode	getParentSectionNode()	Obtains the parent SectionNode containing this SectionNode.
String	getQualifiedName()	Obtains the qualified name of the Node.
String	getSectionLocation()	Obtains the location of the OfficeSection being transformed.
SectionOutputNode	getSectionOutputNode(String outputName)	Obtains the possible SectionOutputNode.
PropertyList	getSectionProperties()	Obtains the PropertyList of the OfficeSection being transformed.
String	getSectionQualifiedName(String simpleName)	Obtains the SectionNode qualified name within the OfficeNode.
String	getSectionSourceClassName()	Obtains the SectionSource Class name of the OfficeSection being transformed.
SubSectionInput	getSubSectionInput(String inputName)	Obtains the SubSectionInput.
String	getSubSectionName()	Obtains the name of this SubSection.
SubSectionObject	getSubSectionObject(String objectName)	Obtains the SubSectionObject.
SubSectionOutput	getSubSectionOutput(String outputName)	Obtains the SubSectionOutput.
SectionNode	getSuperSection()	Obtains the parent SectionNode to this SectionNode.
void	initialise(String sectionSourceClassName, SectionSource sectionSource, String sectionLocation)	Initialises this SectionNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
void	link(FunctionFlow functionFlow, SectionFlowSinkNode sectionSinkNode, boolean isSpawnThreadState)	Links the FunctionFlow to be undertaken by the SectionFlowSinkNode.
void	link(SectionDependencyRequireNode dependencyRequireNode, SectionDependencyObjectNode dependencyObjectNode)	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.
void	loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer, CompileContext compileContext)	Loads the AutoWire extension targets for the OfficeSectionManagedObject extension targets..
void	loadExternalServicing(Office office)	Loads the FunctionManager instances to externally trigger this SectionNode.
void	loadManagedFunctionNodes(Map<String,ManagedFunctionNode> managedFunctionNodes)	Loads the ManagedFunctionNode instances.
OfficeAvailableSectionInputType[]	loadOfficeAvailableSectionInputTypes(CompileContext compileContext)	Loads the OfficeAvailableSectionInputType instances.
OfficeSectionType	loadOfficeSectionType(CompileContext compileContext)	Loads the OfficeSectionType.
OfficeSectionType	loadOfficeSubSectionType(OfficeSubSectionType parentSectionType, CompileContext compileContext)	Loads the OfficeSubSectionType.
SectionType	loadSectionType(CompileContext compileContext)	Loads the SectionType.
boolean	removeSectionObjectIfUnused(SectionObjectNode sectionObject)	Removes the SectionObjectNode if unused.
boolean	runExecutionExplorers(Map<String,ManagedFunctionNode> managedFunctions, CompileContext compileContext)	Runs the ExecutionExplorer instances.
void	setSuperOfficeSection(OfficeSection superSection)	Specifies an OfficeSection that this OfficeSection will inherit its links from.
void	setTransformedOfficeSection(String sectionSourceClassName, String sectionLocation, PropertyList sectionProperties)	Specifies the transformed OfficeSection.
void	setTransformedOfficeSection(SectionSource sectionSource, String sectionLocation, PropertyList sectionProperties)	Specifies the transformed OfficeSection.
boolean	sourceInheritance(CompileContext compileContext)	Sources the inheritance of the SectionNode.
boolean	sourceSection(ManagedFunctionVisitor managedFunctionVisitor, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext, boolean isLoadingType)	Sources the section into this SectionNode.
boolean	sourceSectionTree(ManagedFunctionVisitor managedFunctionVisitor, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext, boolean isLoadingType)	Sources this SectionNode and all its descendant Node instances recursively.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getQualifiedName

Constructor Details

SectionNodeImpl

public SectionNodeImpl(boolean isSectionNamed,
 String sectionName,
 SectionNode parentSection,
 OfficeNode office,
 NodeContext context)

Initialises this SectionNode with the basic information.

Parameters:

isSectionNamed - Indicates if named.

sectionName - Name of this OfficeSection.

parentSection - Optional parent SectionNode. May be null.

office - Office containing the OfficeSection.

context - NodeContext.

Method Details

getNodeName

public String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getQualifiedName

public String getQualifiedName()

Description copied from interface: Node

Obtains the qualified name of the Node.

Specified by:

getQualifiedName in interface Node

Returns:

Qualified name of the Node.

getNodeType

public String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public String getLocation()

Description copied from interface: Node

Obtains the location of the Node.

Specified by:

getLocation in interface Node

Returns:

Location of the Node. May be null if Node does not support a location.

getParentNode

public Node getParentNode()

Description copied from interface: Node

Obtains the Node containing this Node.

Specified by:

getParentNode in interface Node

Returns:

Node containing this Node.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

isInitialised

public boolean isInitialised()

Description copied from interface: Node

Indicates if the Node has been initialised. Node instances should only be initialised once. Initialising the Node twice is an issue.

Specified by:

isInitialised in interface Node

Returns:

true if initialised.

initialise

public void initialise(String sectionSourceClassName,
 SectionSource sectionSource,
 String sectionLocation)

Description copied from interface: SectionNode

Initialises this SectionNode.

Specified by:

initialise in interface SectionNode

Parameters:

sectionSourceClassName - SectionSource class name.

sectionSource - Optional instantiated SectionSource. May be null.

sectionLocation - Location of the OfficeSection.

addManagedFunctionNode

public ManagedFunctionNode addManagedFunctionNode(String functionName,
 String functionTypeName,
 FunctionNamespaceNode namespaceNode)

Description copied from interface: ManagedFunctionRegistry

Adds an initialised ManagedFunctionNode to the registry.

Should an ManagedFunctionNode already be added by the name, then an issue is reported to the CompilerIssue.

Specified by:

addManagedFunctionNode in interface ManagedFunctionRegistry

Parameters:

functionName - Name of the ManagedFunctionNode.

functionTypeName - Type name of the ManagedFunction within the ManagedFunctionSource.

namespaceNode - Parent FunctionNamespaceNode.

Returns:

Initialised ManagedFunctionNode by the name.

getManagedObjectNode

public ManagedObjectNode getManagedObjectNode(String managedObjectName)

Description copied from interface: ManagedObjectRegistry

Obtains the ManagedObjectNode from the registry.

The returned ManagedObjectNode may or may not be initialised.

Specified by:

getManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

Returns:

ManagedObjectNode from the registry.

addManagedObjectNode

public ManagedObjectNode addManagedObjectNode(String managedObjectName,
 ManagedObjectScope managedObjectScope,
 ManagedObjectSourceNode managedObjectSourceNode)

Description copied from interface: ManagedObjectRegistry

Adds an initialised ManagedObjectNode to the registry.

Should an ManagedObjectNode already be added by the name, then an issue is reported to the CompilerIssue.

Specified by:

addManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

managedObjectScope - ManagedObjectScope.

managedObjectSourceNode - ManagedObjectSourceNode for the ManagedObjectNode.

Returns:

Initialised ManagedObjectNode by the name.

sourceSection

public boolean sourceSection(ManagedFunctionVisitor managedFunctionVisitor,
 ManagedObjectSourceVisitor managedObjectSourceVisitor,
 CompileContext compileContext,
 boolean isLoadingType)

Description copied from interface: SectionNode

Sources the section into this SectionNode.

This will only source the top level OfficeSection.

Specified by:

sourceSection in interface SectionNode

Parameters:

managedFunctionVisitor - ManagedFunctionVisitor.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

isLoadingType - Indicates if used for loading type.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

sourceSectionTree

public boolean sourceSectionTree(ManagedFunctionVisitor managedFunctionVisitor,
 ManagedObjectSourceVisitor managedObjectSourceVisitor,
 CompileContext compileContext,
 boolean isLoadingType)

Description copied from interface: SectionNode

Sources this SectionNode and all its descendant Node instances recursively.

Specified by:

sourceSectionTree in interface SectionNode

Parameters:

managedFunctionVisitor - ManagedFunctionVisitor.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

isLoadingType - Indicates if used for loading type.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

sourceInheritance

public boolean sourceInheritance(CompileContext compileContext)

Description copied from interface: SectionNode

Sources the inheritance of the SectionNode.

Specified by:

sourceInheritance in interface SectionNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

getSuperSection

public SectionNode getSuperSection()

Description copied from interface: SectionNode

Obtains the parent SectionNode to this SectionNode.

Specified by:

getSuperSection in interface SectionNode

Returns:

Parent SectionNode to this SectionNode.

getSectionOutputNode

public SectionOutputNode getSectionOutputNode(String outputName)

Description copied from interface: SectionNode

Obtains the possible SectionOutputNode.

Specified by:

getSectionOutputNode in interface SectionNode

Parameters:

outputName - Name of the SectionOutputNode.

Returns:

SectionOutputNode or null if no SectionOutputNode by name on the SectionNode.

removeSectionObjectIfUnused

public boolean removeSectionObjectIfUnused(SectionObjectNode sectionObject)

Description copied from interface: SectionNode

Removes the SectionObjectNode if unused.

Specified by:

removeSectionObjectIfUnused in interface SectionNode

Parameters:

sectionObject - SectionObjectNode to remove if unused.

Returns:

true if removed.

loadSectionType

public SectionType loadSectionType(CompileContext compileContext)

Description copied from interface: SectionNode

Loads the SectionType.

Specified by:

loadSectionType in interface SectionNode

Parameters:

compileContext - CompileContext.

Returns:

SectionType or null if issue loading with issue reported to the CompilerIssues.

loadOfficeSectionType

public OfficeSectionType loadOfficeSectionType(CompileContext compileContext)

Description copied from interface: SectionNode

Loads the OfficeSectionType.

Specified by:

loadOfficeSectionType in interface SectionNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeSectionType or null if issue loading with issue reported to the CompilerIssues.

loadOfficeSubSectionType

public OfficeSectionType loadOfficeSubSectionType(OfficeSubSectionType parentSectionType,
 CompileContext compileContext)

Description copied from interface: SectionNode

Loads the OfficeSubSectionType.

Specified by:

loadOfficeSubSectionType in interface SectionNode

Parameters:

parentSectionType - Parent OfficeSubSectionType.

compileContext - CompileContext.

Returns:

OfficeSubSectionType or null if issue loading with issue reported to the CompilerIssues.

loadOfficeAvailableSectionInputTypes

public OfficeAvailableSectionInputType[] loadOfficeAvailableSectionInputTypes(CompileContext compileContext)

Description copied from interface: SectionNode

Loads the OfficeAvailableSectionInputType instances.

Specified by:

loadOfficeAvailableSectionInputTypes in interface SectionNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeAvailableSectionInputType instances or null with issues reported to the CompilerIssues.

getGoverningGovernances

public GovernanceNode[] getGoverningGovernances()

Description copied from interface: SectionNode

Obtains the GovernanceNode instances providing Governance over this SectionNode.

This is list comprised of the:

1. GovernanceNode assigned to this particular SectionNode
2. GovernanceNode assigned to any parent SectionNode

Specified by:

getGoverningGovernances in interface SectionNode

Returns:

GovernanceNode instances providing Governance over this SectionNode.

getSectionQualifiedName

public String getSectionQualifiedName(String simpleName)

Description copied from interface: SectionNode

Obtains the SectionNode qualified name within the OfficeNode.

Specified by:

getSectionQualifiedName in interface SectionNode

Parameters:

simpleName - Simple name to qualify with the SectionNode name space.

Returns:

SectionNode qualified name.

loadAutoWireExtensionTargets

public void loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: SectionNode

Loads the AutoWire extension targets for the OfficeSectionManagedObject extension targets..

Specified by:

loadAutoWireExtensionTargets in interface SectionNode

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeSectionManagedObject extension targets.

compileContext - CompileContext.

autoWireObjects

public void autoWireObjects(AutoWirer<LinkObjectNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: SectionNode

Auto-wires the SectionObjectNode instances that are unlinked.

Specified by:

autoWireObjects in interface SectionNode

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

autoWireTeams

public void autoWireTeams(AutoWirer<LinkTeamNode> autoWirer,
 CompileContext compileContext)

Description copied from interface: SectionNode

Auto-wires the SectionFunction instances to a possible responsible Team.

Specified by:

autoWireTeams in interface SectionNode

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

loadManagedFunctionNodes

public void loadManagedFunctionNodes(Map<String,ManagedFunctionNode> managedFunctionNodes)

Description copied from interface: SectionNode

Loads the ManagedFunctionNode instances.

Specified by:

loadManagedFunctionNodes in interface SectionNode

Parameters:

managedFunctionNodes - Map to be loaded with the ManagedFunctionNode instances by their qualified name.

runExecutionExplorers

public boolean runExecutionExplorers(Map<String,ManagedFunctionNode> managedFunctions,
 CompileContext compileContext)

Description copied from interface: SectionNode

Runs the ExecutionExplorer instances.

Specified by:

runExecutionExplorers in interface SectionNode

Parameters:

managedFunctions - ManagedFunctionNode instances by their qualified name.

compileContext - CompileContext.

Returns:

true if successfully explored execution.

buildSection

public void buildSection(OfficeBuilder officeBuilder,
 OfficeBindings officeBindings,
 CompileContext compileContext)

Description copied from interface: SectionNode

Builds this OfficeSection for this SectionNode.

Specified by:

buildSection in interface SectionNode

Parameters:

officeBuilder - OfficeBuilder of the Office containing this SectionNode.

officeBindings - OfficeBindings of the Office containing this SectionNode.

compileContext - CompileContext.

loadExternalServicing

public void loadExternalServicing(Office office)
                           throws UnknownFunctionException

Description copied from interface: SectionNode

Loads the FunctionManager instances to externally trigger this SectionNode.

Specified by:

loadExternalServicing in interface SectionNode

Parameters:

office - Office containing this SectionNode.

Throws:

UnknownFunctionException - UnknownFunctionException.

getParentSectionNode

public SectionNode getParentSectionNode()

Description copied from interface: SectionNode

Obtains the parent SectionNode containing this SectionNode.

Specified by:

getParentSectionNode in interface SectionNode

Returns:

Parent SectionNode or null if this SectionNode is the top level SectionNode (in other words a OfficeSection).

getOfficeNode

public OfficeNode getOfficeNode()

Description copied from interface: SectionNode

Obtains the OfficeNode containing this SectionNode.

Specified by:

getOfficeNode in interface SectionNode

Returns:

OfficeNode containing this SectionNode.

getDeployedOfficeInput

public DeployedOfficeInput getDeployedOfficeInput(String inputName)

Description copied from interface: SectionNode

Obtains the DeployedOfficeInput.

Specified by:

getDeployedOfficeInput in interface SectionNode

Parameters:

inputName - Input name as per the OfficeAvailableSectionInputType.

Returns:

DeployedOfficeInput.

getSubSectionName

public String getSubSectionName()

Description copied from interface: SubSection

Obtains the name of this SubSection.

Specified by:

getSubSectionName in interface SubSection

Returns:

Name of this SubSection.

addProperty

public void addProperty(String name,
 String value)

Description copied from interface: PropertyConfigurable

Adds a Property to configure the item.

Specified by:

addProperty in interface PropertyConfigurable

Parameters:

name - Name of Property.

value - Value of Property.

getSubSectionInput

public SubSectionInput getSubSectionInput(String inputName)

Description copied from interface: SubSection

Obtains the SubSectionInput.

Specified by:

getSubSectionInput in interface SubSection

Parameters:

inputName - Name of the SubSectionInput to obtain.

Returns:

SubSectionInput.

getSubSectionOutput

public SubSectionOutput getSubSectionOutput(String outputName)

Description copied from interface: SubSection

Obtains the SubSectionOutput.

Specified by:

getSubSectionOutput in interface SubSection

Parameters:

outputName - Name of the SubSectionOutput to obtain.

Returns:

SubSectionOutput.

getSubSectionObject

public SubSectionObject getSubSectionObject(String objectName)

Description copied from interface: SubSection

Obtains the SubSectionObject.

Specified by:

getSubSectionObject in interface SubSection

Parameters:

objectName - Name of the SubSectionObject to obtain.

Returns:

SubSectionObject.

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.

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.

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.

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 dependencyRequireNode,
 SectionDependencyObjectNode dependencyObjectNode)

Description copied from interface: SectionDesigner

Links the SectionDependencyRequireNode to be fulfilled by the SectionDependencyObjectNode.

Specified by:

link in interface SectionDesigner

Parameters:

dependencyRequireNode - SectionDependencyRequireNode.

dependencyObjectNode - 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.

getOfficeSectionName

public String getOfficeSectionName()

Description copied from interface: OfficeSectionTransformerContext

Obtains the name of the OfficeSection.

Specified by:

getOfficeSectionName in interface OfficeSectionTransformerContext

Specified by:

getOfficeSectionName in interface OfficeSubSection

Returns:

Name of the OfficeSection.

getOfficeSectionInput

public OfficeSectionInput getOfficeSectionInput(String inputName)

Description copied from interface: OfficeSection

Obtains the OfficeSectionInput.

Specified by:

getOfficeSectionInput in interface OfficeSection

Parameters:

inputName - Name of the OfficeSectionInput to obtain.

Returns:

OfficeSectionInput.

getOfficeSectionOutput

public OfficeSectionOutput getOfficeSectionOutput(String outputName)

Description copied from interface: OfficeSection

Obtains the OfficeSectionOutput.

Specified by:

getOfficeSectionOutput in interface OfficeSection

Parameters:

outputName - Name of the OfficeSectionOutput to obtain.

Returns:

OfficeSectionOutput.

getOfficeSectionObject

public OfficeSectionObject getOfficeSectionObject(String objectName)

Description copied from interface: OfficeSection

Obtains the OfficeSectionObject.

Specified by:

getOfficeSectionObject in interface OfficeSection

Parameters:

objectName - Name of the OfficeSectionObject to obtain.

Returns:

OfficeSectionObject.

setSuperOfficeSection

public void setSuperOfficeSection(OfficeSection superSection)

Description copied from interface: OfficeSection

Specifies an OfficeSection that this OfficeSection will inherit its links from.

Typical example use would be creating an OfficeSection to render a web page. For headers and footers, the various links do not want to have to be configured for each OfficeSection page. This would clutter the graphical configuration. Hence the main page can configure these header and footer links, with all other pages inheriting the links from the main page.

Specified by:

setSuperOfficeSection in interface OfficeSection

Parameters:

superSection - Super OfficeSection.

getOfficeSubSection

public OfficeSubSection getOfficeSubSection(String sectionName)

Description copied from interface: OfficeSubSection

Obtains the OfficeSubSection.

Specified by:

getOfficeSubSection in interface OfficeSubSection

Parameters:

sectionName - Name of the OfficeSubSection to obtain.

Returns:

OfficeSubSection.

getOfficeSectionFunction

public OfficeSectionFunction getOfficeSectionFunction(String functionName)

Description copied from interface: OfficeSubSection

Obtains the OfficeSectionFunction instance particular to this OfficeSubSection.

Specified by:

getOfficeSectionFunction in interface OfficeSubSection

Parameters:

functionName - Name of the OfficeSectionFunction to obtain.

Returns:

OfficeSectionFunction.

getOfficeSectionManagedObject

public OfficeSectionManagedObject getOfficeSectionManagedObject(String managedObjectName)

Description copied from interface: OfficeSubSection

Obtains the OfficeSectionManagedObject particular to this OfficeSubSection.

Specified by:

getOfficeSectionManagedObject in interface OfficeSubSection

Parameters:

managedObjectName - Name of the OfficeSectionManagedObject to obtain.

Returns:

OfficeSectionManagedObject.

getOfficeSectionManagedObjectSource

public OfficeSectionManagedObjectSource getOfficeSectionManagedObjectSource(String managedObjectSourceName)

Description copied from interface: OfficeSubSection

Obtains the OfficeSectionManagedObjectSource particular to this OfficeSubSection.

Specified by:

getOfficeSectionManagedObjectSource in interface OfficeSubSection

Parameters:

managedObjectSourceName - Name of the OfficeSectionManagedObjectSource to obtain.

Returns:

OfficeSectionManagedObjectSource.

addGovernance

public void addGovernance(OfficeGovernance governance)

Description copied from interface: OfficeSubSection

Adds Governance for this OfficeSubSection.

This enables providing Governance over all OfficeSectionFunction instances within the OfficeSubSection and all its subsequent OfficeSubSection instances.

Specified by:

addGovernance in interface OfficeSubSection

Parameters:

governance - OfficeGovernance.

getSectionSourceClassName

public String getSectionSourceClassName()

Description copied from interface: OfficeSectionTransformerContext

Obtains the SectionSource Class name of the OfficeSection being transformed.

Specified by:

getSectionSourceClassName in interface OfficeSectionTransformerContext

Returns:

SectionSource Class name of the OfficeSection being transformed.

getSectionLocation

public String getSectionLocation()

Description copied from interface: OfficeSectionTransformerContext

Obtains the location of the OfficeSection being transformed.

Specified by:

getSectionLocation in interface OfficeSectionTransformerContext

Returns:

Location of the OfficeSection being transformed.

getSectionProperties

public PropertyList getSectionProperties()

Description copied from interface: OfficeSectionTransformerContext

Obtains the PropertyList of the OfficeSection being transformed.

Specified by:

getSectionProperties in interface OfficeSectionTransformerContext

Returns:

PropertyList of the OfficeSection being transformed.

createPropertyList

public PropertyList createPropertyList()

Description copied from interface: OfficeSectionTransformerContext

Creates a new PropertyList.

Specified by:

createPropertyList in interface OfficeSectionTransformerContext

Returns:

New PropertyList.

setTransformedOfficeSection

public void setTransformedOfficeSection(String sectionSourceClassName,
 String sectionLocation,
 PropertyList sectionProperties)

Description copied from interface: OfficeSectionTransformerContext

Specifies the transformed OfficeSection.

Specified by:

setTransformedOfficeSection in interface OfficeSectionTransformerContext

Parameters:

sectionSourceClassName - SectionSource Class name.

sectionLocation - SectionSource location.

sectionProperties - OfficeSection PropertyList.

setTransformedOfficeSection

public void setTransformedOfficeSection(SectionSource sectionSource,
 String sectionLocation,
 PropertyList sectionProperties)

Description copied from interface: OfficeSectionTransformerContext

Specifies the transformed OfficeSection.

Specified by:

setTransformedOfficeSection in interface OfficeSectionTransformerContext

Parameters:

sectionSource - SectionSource.

sectionLocation - SectionSource location.

sectionProperties - OfficeSection PropertyList.