Package net.officefloor.compile.impl.structure

Class ExecutiveNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.ExecutiveNodeImpl

All Implemented Interfaces:

ExecutiveNode, Node, PropertyConfigurable, OfficeFloorExecutive

public class ExecutiveNodeImpl
extends java.lang.Object
implements ExecutiveNode

ExecutiveNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
ExecutiveNodeImpl(OfficeFloorNode officeFloor, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addProperty(java.lang.String name, java.lang.String value)	Adds a Property to configure the item.
void	buildExecutive(OfficeFloorBuilder builder, CompileContext compileContext)	Builds the Executive for this ExecutiveNode.
Node[]	getChildNodes()	Obtains the child Node instances.
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.
OfficeFloorExecutionStrategy	getOfficeFloorExecutionStrategy(java.lang.String executionStrategyName)	Obtains the OfficeFloorExecutionStrategy for ExecutionStrategyType.
java.lang.String	getOfficeFloorExecutiveName()	Obtains the name of this OfficeFloorExecutive.
Node	getParentNode()	Obtains the Node containing this Node.
void	initialise(java.lang.String executiveSourceClassName, ExecutiveSource executiveSource)	Initialises the ExecutiveNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
ExecutiveType	loadExecutiveType()	Loads the ExecutiveType for the ExecutiveSource.
boolean	sourceExecutive(CompileContext compileContext)	Sources the Executive.

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

ExecutiveNodeImpl

public ExecutiveNodeImpl(OfficeFloorNode officeFloor,
                         NodeContext context)

Initiate.

Parameters:

officeFloor - OfficeFloorNode containing this ExecutiveNode.

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.

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.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

initialise

public void initialise(java.lang.String executiveSourceClassName,
                       ExecutiveSource executiveSource)

Description copied from interface: ExecutiveNode

Initialises the ExecutiveNode.

Specified by:

initialise in interface ExecutiveNode

Parameters:

executiveSourceClassName - Class name of the ExecutiveSource.

executiveSource - Optional instantiated ExecutiveSource. May be null.

loadExecutiveType

public ExecutiveType loadExecutiveType()

Description copied from interface: ExecutiveNode

Loads the ExecutiveType for the ExecutiveSource.

Specified by:

loadExecutiveType in interface ExecutiveNode

Returns:

ExecutiveType or null with issues reported to the CompilerIssues.

sourceExecutive

public boolean sourceExecutive(CompileContext compileContext)

Description copied from interface: ExecutiveNode

Sources the Executive.

Specified by:

sourceExecutive in interface ExecutiveNode

Parameters:

compileContext - CompileContext.

Returns:

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

buildExecutive

public void buildExecutive(OfficeFloorBuilder builder,
                           CompileContext compileContext)

Description copied from interface: ExecutiveNode

Builds the Executive for this ExecutiveNode.

Specified by:

buildExecutive in interface ExecutiveNode

Parameters:

builder - OfficeFloorBuilder.

compileContext - CompileContext.

getOfficeFloorExecutiveName

public java.lang.String getOfficeFloorExecutiveName()

Description copied from interface: OfficeFloorExecutive

Obtains the name of this OfficeFloorExecutive.

Specified by:

getOfficeFloorExecutiveName in interface OfficeFloorExecutive

Returns:

Name of this OfficeFloorExecutive.

addProperty

public void addProperty(java.lang.String name,
                        java.lang.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.

getOfficeFloorExecutionStrategy

public OfficeFloorExecutionStrategy getOfficeFloorExecutionStrategy(java.lang.String executionStrategyName)

Description copied from interface: OfficeFloorExecutive

Obtains the OfficeFloorExecutionStrategy for ExecutionStrategyType.

Specified by:

getOfficeFloorExecutionStrategy in interface OfficeFloorExecutive

Parameters:

executionStrategyName - Name of ExecutionStrategyType.

Returns:

OfficeFloorExecutionStrategy.