Package net.officefloor.compile.impl.structure

Class ManagedFunctionNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.ManagedFunctionNodeImpl

All Implemented Interfaces:

LinkFlowNode, ManagedFunctionNode, Node, OfficeSectionFunction, SectionFlowSinkNode, SectionFlowSourceNode, SectionFunction

public class ManagedFunctionNodeImpl
extends java.lang.Object
implements ManagedFunctionNode

ManagedFunctionNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
ManagedFunctionNodeImpl(java.lang.String functionName, SectionNode sectionNode, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addGovernance(OfficeGovernance governance)	Adds Governance for this OfficeSectionFunction.
void	addPostAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done after completing this OfficeSectionFunction.
void	addPreAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done before attempting this OfficeSectionFunction.
void	autoWireManagedFunctionResponsibility(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto wires the ResponsibleTeam for this ManagedFunction.
void	buildManagedFunction(OfficeBuilder officeBuilder, CompileContext compileContext)	Builds the ManagedFunction for this ManagedFunctionNode.
ExecutionManagedFunction	createExecutionManagedFunction(CompileContext compileContext)	Creates an ExecutionManagedFunction for this ManagedFunctionNode.
AugmentedFunctionObject	getAugmentedFunctionObject(java.lang.String objectName)	Obtains the AugmentedFunctionObject.
Node[]	getChildNodes()	Obtains the child Node instances.
FunctionFlow	getFunctionEscalation(java.lang.String functionEscalationName)	Obtains the FunctionFlow for the ManagedFunctionEscalationType.
FunctionFlow	getFunctionFlow(java.lang.String functionFlowName)	Obtains the FunctionFlow for the ManagedFunctionFlowType.
FunctionNamespaceNode	getFunctionNamespaceNode()	Obtains the FunctionNamespaceNode containing this ManagedFunctionNode.
FunctionObject	getFunctionObject(java.lang.String functionObjectName)	Obtains the FunctionObject for the ManagedFunctionObjectType.
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.
java.lang.String	getOfficeFunctionName()	Obtains the name of the OfficeSectionFunction.
Node	getParentNode()	Obtains the Node containing this Node.
java.lang.String	getQualifiedFunctionName()	Obtains the fully qualified name of this ManagedFunction.
ResponsibleTeam	getResponsibleTeam()	Obtains the ResponsibleTeam responsible for this OfficeSectionFunction.
java.lang.String	getSectionFunctionName()	Obtains the name of this SectionFunction.
void	initialise(java.lang.String managedFunctionTypeName, FunctionNamespaceNode namespaceNode)	Initialises this ManagedFunctionNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	linkFlowNode(LinkFlowNode node)	Links the input LinkFlowNode to this LinkFlowNode.
ManagedFunctionType<?,?>	loadManagedFunctionType(CompileContext compileContext)	Loads the ManagedFunctionType for this ManagedFunctionNode.
OfficeFunctionType	loadOfficeFunctionType(OfficeSubSectionType parentSubSectionType, CompileContext compileContext)	Loads the OfficeFunctionType.
boolean	souceManagedFunction(ManagedFunctionVisitor visitor, CompileContext compileContext)	Sources the ManagedFunction.

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

ManagedFunctionNodeImpl

public ManagedFunctionNodeImpl(java.lang.String functionName,
                               SectionNode sectionNode,
                               NodeContext context)

Initiate.

Parameters:

functionName - Name of this SectionFunction.

sectionNode - SectionNode containing this ManagedFunctionNode.

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 managedFunctionTypeName,
                       FunctionNamespaceNode namespaceNode)

Description copied from interface: ManagedFunctionNode

Initialises this ManagedFunctionNode.

Specified by:

initialise in interface ManagedFunctionNode

Parameters:

managedFunctionTypeName - ManagedFunctionType name.

namespaceNode - FunctionNamespaceNode for the ManagedFunctionNode.

getQualifiedFunctionName

public java.lang.String getQualifiedFunctionName()

Description copied from interface: ManagedFunctionNode

Obtains the fully qualified name of this ManagedFunction.

Specified by:

getQualifiedFunctionName in interface ManagedFunctionNode

Returns:

Fully qualified name of this ManagedFunction.

getFunctionNamespaceNode

public FunctionNamespaceNode getFunctionNamespaceNode()

Description copied from interface: ManagedFunctionNode

Obtains the FunctionNamespaceNode containing this ManagedFunctionNode.

Specified by:

getFunctionNamespaceNode in interface ManagedFunctionNode

Returns:

FunctionNamespaceNode containing this ManagedFunctionNode.

getAugmentedFunctionObject

public AugmentedFunctionObject getAugmentedFunctionObject(java.lang.String objectName)

Description copied from interface: ManagedFunctionNode

Obtains the AugmentedFunctionObject.

Specified by:

getAugmentedFunctionObject in interface ManagedFunctionNode

Parameters:

objectName - Name of the AugmentedFunctionObject.

Returns:

AugmentedFunctionObject.

loadManagedFunctionType

public ManagedFunctionType<?,?> loadManagedFunctionType(CompileContext compileContext)

Description copied from interface: ManagedFunctionNode

Loads the ManagedFunctionType for this ManagedFunctionNode.

Specified by:

loadManagedFunctionType in interface ManagedFunctionNode

Parameters:

compileContext - CompileContext.

Returns:

ManagedFunctionType for this ManagedFunctionNode. May be null if can not determine ManagedFunctionType.

loadOfficeFunctionType

public OfficeFunctionType loadOfficeFunctionType(OfficeSubSectionType parentSubSectionType,
                                                 CompileContext compileContext)

Description copied from interface: ManagedFunctionNode

Loads the OfficeFunctionType.

Specified by:

loadOfficeFunctionType in interface ManagedFunctionNode

Parameters:

parentSubSectionType - Containing OfficeSubSectionType to this OfficeSectionFunction.

compileContext - CompileContext.

Returns:

OfficeFunctionType or null with issues reported to the CompilerIssues.

souceManagedFunction

public boolean souceManagedFunction(ManagedFunctionVisitor visitor,
                                    CompileContext compileContext)

Description copied from interface: ManagedFunctionNode

Sources the ManagedFunction.

Specified by:

souceManagedFunction in interface ManagedFunctionNode

Parameters:

visitor - ManagedFunctionVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced the ManagedFunction. false if failed to source with issues reported to the CompilerIssues.

autoWireManagedFunctionResponsibility

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

Description copied from interface: ManagedFunctionNode

Auto wires the ResponsibleTeam for this ManagedFunction.

Specified by:

autoWireManagedFunctionResponsibility in interface ManagedFunctionNode

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

createExecutionManagedFunction

public ExecutionManagedFunction createExecutionManagedFunction(CompileContext compileContext)

Description copied from interface: ManagedFunctionNode

Creates an ExecutionManagedFunction for this ManagedFunctionNode.

Specified by:

createExecutionManagedFunction in interface ManagedFunctionNode

Parameters:

compileContext - CompileContext.

Returns:

ExecutionManagedFunction for this ManagedFunctionNode.

buildManagedFunction

public void buildManagedFunction(OfficeBuilder officeBuilder,
                                 CompileContext compileContext)

Description copied from interface: ManagedFunctionNode

Builds the ManagedFunction for this ManagedFunctionNode.

Specified by:

buildManagedFunction in interface ManagedFunctionNode

Parameters:

officeBuilder - OfficeBuilder.

compileContext - CompileContext.

getSectionFunctionName

public java.lang.String getSectionFunctionName()

Description copied from interface: SectionFunction

Obtains the name of this SectionFunction.

Specified by:

getSectionFunctionName in interface SectionFunction

Returns:

Name of this SectionFunction.

getFunctionFlow

public FunctionFlow getFunctionFlow(java.lang.String functionFlowName)

Description copied from interface: SectionFunction

Obtains the FunctionFlow for the ManagedFunctionFlowType.

Specified by:

getFunctionFlow in interface SectionFunction

Parameters:

functionFlowName - Name of the ManagedFunctionFlowType.

Returns:

FunctionFlow.

getFunctionObject

public FunctionObject getFunctionObject(java.lang.String functionObjectName)

Description copied from interface: SectionFunction

Obtains the FunctionObject for the ManagedFunctionObjectType.

Specified by:

getFunctionObject in interface SectionFunction

Parameters:

functionObjectName - Name of the ManagedFunctionObjectType.

Returns:

FunctionObject.

getFunctionEscalation

public FunctionFlow getFunctionEscalation(java.lang.String functionEscalationName)

Description copied from interface: SectionFunction

Obtains the FunctionFlow for the ManagedFunctionEscalationType.

Specified by:

getFunctionEscalation in interface SectionFunction

Parameters:

functionEscalationName - Fully qualified class name of the Throwable identifying the ManagedFunctionEscalationType. The Escalation type is used rather than the name as handling is done by the Escalation type.

Returns:

FunctionFlow for the ManagedFunctionEscalationType.

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.

getOfficeFunctionName

public java.lang.String getOfficeFunctionName()

Description copied from interface: OfficeSectionFunction

Obtains the name of the OfficeSectionFunction.

Specified by:

getOfficeFunctionName in interface OfficeSectionFunction

Returns:

Name of the OfficeSectionFunction.

getResponsibleTeam

public ResponsibleTeam getResponsibleTeam()

Description copied from interface: OfficeSectionFunction

Obtains the ResponsibleTeam responsible for this OfficeSectionFunction.

Specified by:

getResponsibleTeam in interface OfficeSectionFunction

Returns:

ResponsibleTeam responsible for this OfficeSectionFunction.

addPreAdministration

public void addPreAdministration(OfficeAdministration administration)

Description copied from interface: OfficeSectionFunction

Adds an OfficeAdministration to be done before attempting this OfficeSectionFunction.

The order that the OfficeAdministration instances are added is the order they will be done before this OfficeSectionFunction.

Specified by:

addPreAdministration in interface OfficeSectionFunction

Parameters:

administration - OfficeAdministration to be done before attempting this OfficeSectionFunction.

addPostAdministration

public void addPostAdministration(OfficeAdministration administration)

Description copied from interface: OfficeSectionFunction

Adds an OfficeAdministration to be done after completing this OfficeSectionFunction.

The order that the OfficeAdministration instances are added is the order they will be done after this OfficeSectionFunction is complete.

Specified by:

addPostAdministration in interface OfficeSectionFunction

Parameters:

administration - OfficeAdministration to be done after completing this OfficeSectionFunction.

addGovernance

public void addGovernance(OfficeGovernance governance)

Description copied from interface: OfficeSectionFunction

Adds Governance for this OfficeSectionFunction.

This enables specifying specifically which OfficeSectionFunction instances require Governance.

Specified by:

addGovernance in interface OfficeSectionFunction

Parameters:

governance - OfficeGovernance.