Package net.officefloor.compile.impl.structure

Class InputManagedObjectNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.InputManagedObjectNodeImpl

All Implemented Interfaces:

BoundManagedObjectNode, InputManagedObjectNode, LinkObjectNode, ManagedObjectExtensionNode, Node, AdministerableManagedObject, GovernerableManagedObject, OfficeFloorDependencyObjectNode, OfficeFloorInputManagedObject

public class InputManagedObjectNodeImpl
extends Object
implements InputManagedObjectNode

InputManagedObjectNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
InputManagedObjectNodeImpl(String inputManagedObjectName, String inputObjectType, OfficeFloorNode officeFloor, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addGovernance(GovernanceNode governance, OfficeNode office)	Adds the GovernanceNode to provide Governance over this ManagedObjectNode when used within the Office of the OfficeNode.
void	addPreLoadAdministration(AdministrationNode preLoadAdministration, OfficeNode office)	Adds the AdministrationNode to provide pre-load Administration for this ManagedObjectNode when used within the Office of the OfficeNode.
void	addTypeQualification(String qualifier, String type)	Adds an TypeQualification for this OfficeFloorInputManagedObject.
boolean	buildFunctionManagedObject(String functionObjectName, ManagedFunctionBuilder<?,?> functionBuilder, OfficeNode office, OfficeBindings officeBindings, CompileContext compileContext)	Builds the ManagedObject onto the ManagedFunctionNode.
void	buildOfficeManagedObject(OfficeNode office, OfficeBuilder officeBuilder, OfficeBindings officeBindings, CompileContext compileContext)	Builds the ManagedObject into the Office.
void	buildSupplierThreadLocal(OptionalThreadLocalReceiver optionalThreadLocalReceiver)	Builds the SupplierThreadLocal from the bound ManagedObject.
String	getAdministerableManagedObjectName()	Obtains the name of this AdministerableManagedObject.
String	getBoundManagedObjectName()	Obtains the name under which this ManagedObject is made available to the Office.
ManagedObjectSourceNode	getBoundManagedObjectSourceNode()	Obtains the bound ManagedObjectSourceNode for this InputManagedObjectNode.
Node[]	getChildNodes()	Obtains the child Node instances.
GovernanceNode[]	getGovernances(OfficeNode managingOffice)	Obtains the GovernanceNode instances providing Governance over this InputManagedObjectNode.
String	getGovernerableManagedObjectName()	Obtains the name of this GovernerableManagedObject.
String	getInputObjectType()	Obtains the input object type.
LinkObjectNode	getLinkedObjectNode()	Obtains the LinkObjectNode linked to this LinkObjectNode.
String	getLocation()	Obtains the location of the Node.
ManagedObjectSourceNode	getManagedObjectSourceNode()	Obtains the ManagedObjectSourceNode for this BoundManagedObjectNode.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
String	getOfficeFloorInputManagedObjectName()	Obtains the name of this OfficeFloorInputManagedObject.
Node	getParentNode()	Obtains the Node containing this Node.
AdministrationNode[]	getPreLoadAdministrations(OfficeNode managingOffice)	Obtains the pre-load AdministrationNode instances providing Administration over this InputManagedObjectNode.
TypeQualification[]	getTypeQualifications(CompileContext compileContext)	Obtains the TypeQualification instances for the InputManagedObjectNode.
void	initialise()	Initialises the InputManagedObjectNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	linkObjectNode(LinkObjectNode node)	Links the input LinkObjectNode to this LinkObjectNode.
void	setBoundOfficeFloorManagedObjectSource(OfficeFloorManagedObjectSource managedObjectSource)	Specifies the bound OfficeFloorManagedObjectSource for this OfficeFloorInputManagedObject.

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 Details

InputManagedObjectNodeImpl

public InputManagedObjectNodeImpl(String inputManagedObjectName,
 String inputObjectType,
 OfficeFloorNode officeFloor,
 NodeContext context)

Initiate.

Parameters:

inputManagedObjectName - Name of this InputManagedObjectNode.

inputObjectType - Input object type.

officeFloor - OfficeFloorNode.

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.

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()

Description copied from interface: InputManagedObjectNode

Initialises the InputManagedObjectNode.

Specified by:

initialise in interface InputManagedObjectNode

getInputObjectType

public String getInputObjectType()

Description copied from interface: InputManagedObjectNode

Obtains the input object type.

Specified by:

getInputObjectType in interface InputManagedObjectNode

Returns:

Input object type.

getBoundManagedObjectSourceNode

public ManagedObjectSourceNode getBoundManagedObjectSourceNode()

Description copied from interface: InputManagedObjectNode

Obtains the bound ManagedObjectSourceNode for this InputManagedObjectNode.

Specified by:

getBoundManagedObjectSourceNode in interface InputManagedObjectNode

Returns:

Bound ManagedObjectSourceNode for this InputManagedObjectNode.

getBoundManagedObjectName

public String getBoundManagedObjectName()

Description copied from interface: BoundManagedObjectNode

Obtains the name under which this ManagedObject is made available to the Office.

Specified by:

getBoundManagedObjectName in interface BoundManagedObjectNode

Returns:

Name under which this ManagedObject is made available to the Office.

addGovernance

public void addGovernance(GovernanceNode governance,
 OfficeNode office)

Description copied from interface: BoundManagedObjectNode

Adds the GovernanceNode to provide Governance over this ManagedObjectNode when used within the Office of the OfficeNode.

Specified by:

addGovernance in interface BoundManagedObjectNode

Parameters:

governance - GovernanceNode.

office - OfficeNode for which the Governance is applicable.

addPreLoadAdministration

public void addPreLoadAdministration(AdministrationNode preLoadAdministration,
 OfficeNode office)

Description copied from interface: BoundManagedObjectNode

Adds the AdministrationNode to provide pre-load Administration for this ManagedObjectNode when used within the Office of the OfficeNode.

Specified by:

addPreLoadAdministration in interface BoundManagedObjectNode

Parameters:

preLoadAdministration - Pre-load AdministrationNode.

office - OfficeNode for which the pre-load Administration is applicable.

getManagedObjectSourceNode

public ManagedObjectSourceNode getManagedObjectSourceNode()

Description copied from interface: BoundManagedObjectNode

Obtains the ManagedObjectSourceNode for this BoundManagedObjectNode.

Specified by:

getManagedObjectSourceNode in interface BoundManagedObjectNode

Returns:

ManagedObjectSourceNode for this BoundManagedObjectNode.

buildOfficeManagedObject

public void buildOfficeManagedObject(OfficeNode office,
 OfficeBuilder officeBuilder,
 OfficeBindings officeBindings,
 CompileContext compileContext)

Description copied from interface: BoundManagedObjectNode

Builds the ManagedObject into the Office.

Specified by:

buildOfficeManagedObject in interface BoundManagedObjectNode

Parameters:

office - OfficeNode of the Office that this ManagedObject is to build itself into.

officeBuilder - OfficeBuilder for the Office.

officeBindings - OfficeBindings.

compileContext - CompileContext.

buildFunctionManagedObject

public boolean buildFunctionManagedObject(String functionObjectName,
 ManagedFunctionBuilder<?,?> functionBuilder,
 OfficeNode office,
 OfficeBindings officeBindings,
 CompileContext compileContext)

Description copied from interface: BoundManagedObjectNode

Builds the ManagedObject onto the ManagedFunctionNode.

Specified by:

buildFunctionManagedObject in interface BoundManagedObjectNode

Parameters:

functionObjectName - Name of the object on the ManagedFunctionNode.

functionBuilder - ManagedFunctionBuilder.

office - OfficeNode of the Office that this ManagedObject is to build itself into.

officeBindings - OfficeBindings.

compileContext - CompileContext.

Returns:

true if bound to ManagedFunctionNode.

buildSupplierThreadLocal

public void buildSupplierThreadLocal(OptionalThreadLocalReceiver optionalThreadLocalReceiver)

Description copied from interface: BoundManagedObjectNode

Builds the SupplierThreadLocal from the bound ManagedObject.

Specified by:

buildSupplierThreadLocal in interface BoundManagedObjectNode

Parameters:

optionalThreadLocalReceiver - OptionalThreadLocalReceiver to receive the OptionalThreadLocal.

getGovernances

public GovernanceNode[] getGovernances(OfficeNode managingOffice)

Description copied from interface: InputManagedObjectNode

Obtains the GovernanceNode instances providing Governance over this InputManagedObjectNode.

Specified by:

getGovernances in interface InputManagedObjectNode

Parameters:

managingOffice - OfficeNode managing the InputManagedObjectNode , which ensures that Governance does not extend beyond the particular OfficeNode.

Returns:

GovernanceNode instances providing Governance over this InputManagedObjectNode.

getPreLoadAdministrations

public AdministrationNode[] getPreLoadAdministrations(OfficeNode managingOffice)

Description copied from interface: InputManagedObjectNode

Obtains the pre-load AdministrationNode instances providing Administration over this InputManagedObjectNode.

Specified by:

getPreLoadAdministrations in interface InputManagedObjectNode

Parameters:

managingOffice - OfficeNode managing the InputManagedObjectNode, which ensures that Administration does not extend beyond the particular OfficeNode.

Returns:

AdministrationNode instances providing pre-load Administration over this InputManagedObjectNode.

getTypeQualifications

public TypeQualification[] getTypeQualifications(CompileContext compileContext)

Description copied from interface: InputManagedObjectNode

Obtains the TypeQualification instances for the InputManagedObjectNode.

Specified by:

getTypeQualifications in interface InputManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

TypeQualification instances for the InputManagedObjectNode.

getAdministerableManagedObjectName

public String getAdministerableManagedObjectName()

Description copied from interface: AdministerableManagedObject

Obtains the name of this AdministerableManagedObject.

Specified by:

getAdministerableManagedObjectName in interface AdministerableManagedObject

Returns:

Name of this AdministerableManagedObject.

getGovernerableManagedObjectName

public String getGovernerableManagedObjectName()

Description copied from interface: GovernerableManagedObject

Obtains the name of this GovernerableManagedObject.

Specified by:

getGovernerableManagedObjectName in interface GovernerableManagedObject

Returns:

Name of this GovernerableManagedObject.

getOfficeFloorInputManagedObjectName

public String getOfficeFloorInputManagedObjectName()

Description copied from interface: OfficeFloorInputManagedObject

Obtains the name of this OfficeFloorInputManagedObject.

Specified by:

getOfficeFloorInputManagedObjectName in interface OfficeFloorInputManagedObject

Returns:

Name of this OfficeFloorInputManagedObject.

addTypeQualification

public void addTypeQualification(String qualifier,
 String type)

Description copied from interface: OfficeFloorInputManagedObject

Adds an TypeQualification for this OfficeFloorInputManagedObject.

This enables distinguishing OfficeFloorInputManagedObject instances to enable, for example, dynamic Team assignment.

Specified by:

addTypeQualification in interface OfficeFloorInputManagedObject

Parameters:

qualifier - Qualifier. May be null if no qualification.

type - Type (typically the fully qualified type).

setBoundOfficeFloorManagedObjectSource

public void setBoundOfficeFloorManagedObjectSource(OfficeFloorManagedObjectSource managedObjectSource)

Description copied from interface: OfficeFloorInputManagedObject

Specifies the bound OfficeFloorManagedObjectSource for this OfficeFloorInputManagedObject.

Specified by:

setBoundOfficeFloorManagedObjectSource in interface OfficeFloorInputManagedObject

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource to be bound should this not be input but required.

linkObjectNode

public boolean linkObjectNode(LinkObjectNode node)

Description copied from interface: LinkObjectNode

Links the input LinkObjectNode to this LinkObjectNode.

Specified by:

linkObjectNode in interface LinkObjectNode

Parameters:

node - LinkObjectNode to link to this LinkObjectNode.

Returns:

true if linked.

getLinkedObjectNode

public LinkObjectNode getLinkedObjectNode()

Description copied from interface: LinkObjectNode

Obtains the LinkObjectNode linked to this LinkObjectNode.

Specified by:

getLinkedObjectNode in interface LinkObjectNode

Returns:

LinkObjectNode linked to this LinkObjectNode.