Package net.officefloor.compile.impl.structure

Class SectionInputNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.SectionInputNodeImpl

All Implemented Interfaces:

LinkFlowNode, Node, SectionInputNode, OfficeFlowSinkNode, OfficeSectionInput, DeployedOfficeInput, OfficeFloorFlowSinkNode, SectionFlowSinkNode, SectionFlowSourceNode, SectionInput, SubSectionInput

public class SectionInputNodeImpl
extends java.lang.Object
implements SectionInputNode

SectionInputNode node.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
SectionInputNodeImpl(java.lang.String inputName, SectionNode section, NodeContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(java.lang.Object annotation)	Adds the annotation for this SectionInput.
void	addExecutionExplorer(ExecutionExplorer executionExplorer)	Adds an ExecutionExplorer for the execution tree from this OfficeSectionInput.
<O,M extends ManagedObject> ExternalServiceInput<O,M>	addExternalServiceInput(java.lang.Class<O> objectType, java.lang.Class<? extends M> managedObjectType, ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)	Adds an ExternalServiceInput to externally trigger this DeployedOfficeInput.
Node[]	getChildNodes()	Obtains the child Node instances.
DeployedOffice	getDeployedOffice()	Obtains the DeployedOffice containing this DeployedOfficeInput.
java.lang.String	getDeployedOfficeInputName()	Obtains the name of the DeployedOfficeInput.
FunctionManager	getFunctionManager()	Obtains the FunctionManager to externally trigger this DeployedOfficeInput.
LinkFlowNode	getLinkedFlowNode()	Obtains the LinkFlowNode linked to this LinkFlowNode.
java.lang.String	getLocation()	Obtains the location of the Node.
java.lang.String	getNodeName()	Obtains the name of the Node.
java.lang.String	getNodeType()	Obtains the Node type.
OfficeSection	getOfficeSection()	Obtains the OfficeSection containing this OfficeSectionInput.
java.lang.String	getOfficeSectionInputName()	Obtains the name of this OfficeSectionInput.
Node	getParentNode()	Obtains the Node containing this Node.
java.lang.String	getSectionInputName()	Obtains the name of this SectionInput.
java.lang.String	getSubSectionInputName()	Obtains the name of this SubSectionInput.
void	initialise(java.lang.String parameterType)	Initialises this SectionInputType.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	linkFlowNode(LinkFlowNode node)	Links the input LinkFlowNode to this LinkFlowNode.
void	loadExternalServicing(Office office)	Loads the FunctionManager instances to externally trigger this SectionInputNode.
OfficeSectionInputType	loadOfficeSectionInputType(CompileContext compileContext)	Loads the OfficeSectionInputType.
SectionInputType	loadSectionInputType(CompileContext compileContext)	Loads the SectionInputType.
boolean	runExecutionExplorers(java.util.Map<java.lang.String,ManagedFunctionNode> managedFunctions, CompileContext compileContext)	Runs the ExecutionExplorer instances.

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, getQualifiedName

Constructor Detail

SectionInputNodeImpl

public SectionInputNodeImpl(java.lang.String inputName,
                            SectionNode section,
                            NodeContext context)

Instantiate.

Parameters:

inputName - Name of the SubSectionInput (which is the name of the SectionInputType).

section - SectionNode containing this SectionInputNode.

context - NodeContext.

Method Detail

getNodeName

public java.lang.String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getNodeType

public java.lang.String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public java.lang.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(java.lang.String parameterType)

Description copied from interface: SectionInputNode

Initialises this SectionInputType.

Specified by:

initialise in interface SectionInputNode

Parameters:

parameterType - Parameter type.

loadExternalServicing

public void loadExternalServicing(Office office)
                           throws UnknownFunctionException

Description copied from interface: SectionInputNode

Loads the FunctionManager instances to externally trigger this SectionInputNode.

Specified by:

loadExternalServicing in interface SectionInputNode

Parameters:

office - Office containing this SectionInputNode.

Throws:

UnknownFunctionException - UnknownFunctionException.

loadSectionInputType

public SectionInputType loadSectionInputType(CompileContext compileContext)

Description copied from interface: SectionInputNode

Loads the SectionInputType.

Specified by:

loadSectionInputType in interface SectionInputNode

Parameters:

compileContext - CompileContext.

Returns:

SectionInputType or null with issues reported to the CompilerIssues.

loadOfficeSectionInputType

public OfficeSectionInputType loadOfficeSectionInputType(CompileContext compileContext)

Description copied from interface: SectionInputNode

Loads the OfficeSectionInputType.

Specified by:

loadOfficeSectionInputType in interface SectionInputNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeSectionInputType or null with issues reported to the CompilerIssues.

runExecutionExplorers

public boolean runExecutionExplorers(java.util.Map<java.lang.String,ManagedFunctionNode> managedFunctions,
                                     CompileContext compileContext)

Description copied from interface: SectionInputNode

Runs the ExecutionExplorer instances.

Specified by:

runExecutionExplorers in interface SectionInputNode

Parameters:

managedFunctions - ManagedFunctionNode instances by their qualified name.

compileContext - CompileContext.

Returns:

true if successfully explored execution.

getSectionInputName

public java.lang.String getSectionInputName()

Description copied from interface: SectionInput

Obtains the name of this SectionInput.

Specified by:

getSectionInputName in interface SectionInput

Returns:

Name of this SectionInput.

addAnnotation

public void addAnnotation(java.lang.Object annotation)

Description copied from interface: SectionInput

Adds the annotation for this SectionInput.

This is exposed as is on the SectionInputType interface for this SectionInput.

Specified by:

addAnnotation in interface SectionInput

Parameters:

annotation - Annotation.

getSubSectionInputName

public java.lang.String getSubSectionInputName()

Description copied from interface: SubSectionInput

Obtains the name of this SubSectionInput.

Specified by:

getSubSectionInputName in interface SubSectionInput

Returns:

Name of this SubSectionInput.

getOfficeSection

public OfficeSection getOfficeSection()

Description copied from interface: OfficeSectionInput

Obtains the OfficeSection containing this OfficeSectionInput.

Specified by:

getOfficeSection in interface OfficeSectionInput

Returns:

OfficeSection containing this OfficeSectionInput.

getOfficeSectionInputName

public java.lang.String getOfficeSectionInputName()

Description copied from interface: OfficeSectionInput

Obtains the name of this OfficeSectionInput.

Specified by:

getOfficeSectionInputName in interface OfficeSectionInput

Returns:

Name of this OfficeSectionInput.

addExecutionExplorer

public void addExecutionExplorer(ExecutionExplorer executionExplorer)

Description copied from interface: OfficeSectionInput

Adds an ExecutionExplorer for the execution tree from this OfficeSectionInput.

Specified by:

addExecutionExplorer in interface OfficeSectionInput

Parameters:

executionExplorer - ExecutionExplorer.

getDeployedOfficeInputName

public java.lang.String getDeployedOfficeInputName()

Description copied from interface: DeployedOfficeInput

Obtains the name of the DeployedOfficeInput.

Specified by:

getDeployedOfficeInputName in interface DeployedOfficeInput

Returns:

Name of the DeployedOfficeInput.

getDeployedOffice

public DeployedOffice getDeployedOffice()

Description copied from interface: DeployedOfficeInput

Obtains the DeployedOffice containing this DeployedOfficeInput.

Specified by:

getDeployedOffice in interface DeployedOfficeInput

Returns:

DeployedOffice containing this DeployedOfficeInput.

getFunctionManager

public FunctionManager getFunctionManager()

Description copied from interface: DeployedOfficeInput

Obtains the FunctionManager to externally trigger this DeployedOfficeInput.

This allows OfficeFloorExtensionService instances to obtain the FunctionManager for external triggering of service handling.

Specified by:

getFunctionManager in interface DeployedOfficeInput

Returns:

FunctionManager to externally trigger this DeployedOfficeInput.

addExternalServiceInput

public <O,M extends ManagedObject> ExternalServiceInput<O,M> addExternalServiceInput(java.lang.Class<O> objectType,
                                                                                                 java.lang.Class<? extends M> managedObjectType,
                                                                                                 ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)

Description copied from interface: DeployedOfficeInput

Adds an ExternalServiceInput to externally trigger this DeployedOfficeInput.

This allows OfficeFloorExtensionService instances to run external services (running within their own Thread) to use OfficeFloor to service.

Should the external service require running within the OfficeFloor open/close life-cycle, add an OfficeFloorListener to the OfficeFloorDeployer.

An example use case is running OfficeFloor within a JEE server and having OfficeFloor service the Servlet requests.

Note should more complex interaction be required with OfficeFloor, consider creating a ManagedObjectSource and invoking services through the ManagedObjectExecuteContext.

Specified by:

addExternalServiceInput in interface DeployedOfficeInput

Type Parameters:

O - Object type.

M - ManagedObject type.

Parameters:

objectType - Type of object provided to the ExternalServiceInput.

managedObjectType - Type of the ManagedObject to the ExternalServiceInput.

cleanupEscalationHandler - ExternalServiceCleanupEscalationHandler.

Returns:

ExternalServiceInput.

linkFlowNode

public boolean linkFlowNode(LinkFlowNode node)

Description copied from interface: LinkFlowNode

Links the input LinkFlowNode to this LinkFlowNode.

Specified by:

linkFlowNode in interface LinkFlowNode

Parameters:

node - LinkFlowNode to link to this LinkFlowNode.

Returns:

true if linked.

getLinkedFlowNode

public LinkFlowNode getLinkedFlowNode()

Description copied from interface: LinkFlowNode

Obtains the LinkFlowNode linked to this LinkFlowNode.

Specified by:

getLinkedFlowNode in interface LinkFlowNode

Returns:

LinkFlowNode linked to this LinkFlowNode.