Package net.officefloor.compile.impl.structure

Class ManagedObjectNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.ManagedObjectNodeImpl

All Implemented Interfaces:

BoundManagedObjectNode, DependentObjectNode, LinkObjectNode, ManagedObjectExtensionNode, ManagedObjectNode, Node, AdministerableManagedObject, DependentManagedObject, GovernerableManagedObject, OfficeDependencyObjectNode, OfficeManagedObject, OfficeSectionManagedObject, OfficeFloorDependencyObjectNode, OfficeFloorManagedObject, SectionDependencyObjectNode, SectionManagedObject

public class ManagedObjectNodeImpl
extends Object
implements ManagedObjectNode

ManagedObjectNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
ManagedObjectNodeImpl(String managedObjectName, SectionNode containingSectionNode, OfficeNode containingOfficeNode, OfficeFloorNode containingOfficeFloorNode, NodeContext context)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addExecutionExplorer(ExecutionObjectExplorer executionObjectExplorer)	Adds an ExecutionObjectExplorer for the execution tree from this OfficeManagedObject.
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	addPreLoadAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done before attempting load this ManagedObject.
void	addTypeQualification(String qualifier, String type)	Adds an TypeQualification for this SectionManagedObject.
void	autoWireDependencies(AutoWirer<LinkObjectNode> autoWirer, OfficeNode office, CompileContext compileContext)	Auto-wires the dependencies for the ManagedObject.
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.
ExecutionManagedObject	createExecutionManagedObject(CompileContext compileContext)	Creates the ExecutionManagedObject for this ManagedObjectNode.
String	getAdministerableManagedObjectName()	Obtains the name of this AdministerableManagedObject.
String	getBoundManagedObjectName()	Obtains the name under which this ManagedObject is made available to the Office.
Node[]	getChildNodes()	Obtains the child Node instances.
String	getDependentManagedObjectName()	Obtains the name of this DependentManagedObject.
String	getGovernerableManagedObjectName()	Obtains the name of this GovernerableManagedObject.
LinkObjectNode	getLinkedObjectNode()	Obtains the LinkObjectNode linked to this LinkObjectNode.
String	getLocation()	Obtains the location of the Node.
ManagedObjectDependencyNode[]	getManagedObjectDepdendencies()	Obtains the ManagedObjectDependencyNode instances.
ManagedObjectSourceNode	getManagedObjectSourceNode()	Obtains the ManagedObjectSourceNode for this ManagedObjectNode.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
OfficeFloorManagedObjectDependency	getOfficeFloorManagedObjectDependency(String managedObjectDependencyName)	Obtains the OfficeFloorManagedObjectDependency for the ManagedObjectDependencyType.
String	getOfficeFloorManagedObjectName()	Obtains the name of this OfficeFloorManagedObject.
OfficeManagedObjectDependency	getOfficeManagedObjectDependency(String managedObjectDependencyName)	Obtains the OfficeManagedObjectDependency for the ManagedObjectDependencyType.
String	getOfficeManagedObjectName()	Obtains the name of the ManagedObject.
String	getOfficeSectionManagedObjectName()	Obtains the name of this OfficeSectionManagedObject.
Node	getParentNode()	Obtains the Node containing this Node.
String	getQualifiedName()	Obtains the qualified name of the Node.
SectionManagedObjectDependency	getSectionManagedObjectDependency(String managedObjectDependencyName)	Obtains the SectionManagedObjectDependency for the ManagedObjectDependencyType.
String	getSectionManagedObjectName()	Obtains the name of this SectionManagedObject.
TypeQualification[]	getTypeQualifications(CompileContext compileContext)	Obtains the TypeQualification instances for the ManagedObject.
void	initialise(ManagedObjectScope managedObjectScope, ManagedObjectSourceNode managedObjectSourceNode)	Initialises the ManagedObjectNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	linkObjectNode(LinkObjectNode node)	Links the input LinkObjectNode to this LinkObjectNode.
DependentObjectType	loadDependentObjectType(CompileContext compileContext)	Loads the DependentObjectType.
OfficeSectionManagedObjectType	loadOfficeSectionManagedObjectType(CompileContext compileContext)	Loads the OfficeSectionManagedObjectType.
boolean	runExecutionExplorers(CompileContext compileContext)	Runs the ExecutionObjectExplorer instances for the ManagedObject.
boolean	sourceManagedObject(CompileContext compileContext)	Sources the ManagedObject.

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

ManagedObjectNodeImpl

public ManagedObjectNodeImpl(String managedObjectName,
 SectionNode containingSectionNode,
 OfficeNode containingOfficeNode,
 OfficeFloorNode containingOfficeFloorNode,
 NodeContext context)

Initiate.

Parameters:

managedObjectName - Name of this ManagedObject.

containingSectionNode - SectionNode containing this ManagedObjectNode. null if contained in the Office or OfficeFloor.

containingOfficeNode - OfficeNode containing this ManagedObjectNode. null if contained in the OfficeFloor.

containingOfficeFloorNode - OfficeFloorNode containing this ManagedObjectNode.

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.

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.

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(ManagedObjectScope managedObjectScope,
 ManagedObjectSourceNode managedObjectSourceNode)

Description copied from interface: ManagedObjectNode

Initialises the ManagedObjectNode.

Specified by:

initialise in interface ManagedObjectNode

Parameters:

managedObjectScope - ManagedObjectScope for the ManagedObject.

managedObjectSourceNode - ManagedObjectSourceNode for the ManagedObjectNode.

getManagedObjectSourceNode

public ManagedObjectSourceNode getManagedObjectSourceNode()

Description copied from interface: ManagedObjectNode

Obtains the ManagedObjectSourceNode for this ManagedObjectNode.

Specified by:

getManagedObjectSourceNode in interface BoundManagedObjectNode

Specified by:

getManagedObjectSourceNode in interface ManagedObjectNode

Returns:

ManagedObjectSourceNode for this ManagedObjectNode.

getTypeQualifications

public TypeQualification[] getTypeQualifications(CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Obtains the TypeQualification instances for the ManagedObject.

Specified by:

getTypeQualifications in interface ManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

TypeQualification instances for the ManagedObject.

getManagedObjectDepdendencies

public ManagedObjectDependencyNode[] getManagedObjectDepdendencies()

Description copied from interface: ManagedObjectNode

Obtains the ManagedObjectDependencyNode instances.

Specified by:

getManagedObjectDepdendencies in interface ManagedObjectNode

Returns:

ManagedObjectDependencyNode instances.

sourceManagedObject

public boolean sourceManagedObject(CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Sources the ManagedObject.

Specified by:

sourceManagedObject in interface ManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

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

autoWireDependencies

public void autoWireDependencies(AutoWirer<LinkObjectNode> autoWirer,
 OfficeNode office,
 CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Auto-wires the dependencies for the ManagedObject.

Specified by:

autoWireDependencies in interface ManagedObjectNode

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

createExecutionManagedObject

public ExecutionManagedObject createExecutionManagedObject(CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Creates the ExecutionManagedObject for this ManagedObjectNode.

Specified by:

createExecutionManagedObject in interface ManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

ExecutionManagedObject for this ManagedObjectNode.

loadOfficeSectionManagedObjectType

public OfficeSectionManagedObjectType loadOfficeSectionManagedObjectType(CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Loads the OfficeSectionManagedObjectType.

Specified by:

loadOfficeSectionManagedObjectType in interface ManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeSectionManagedObjectType or null with issues reported to the CompilerIssues.

runExecutionExplorers

public boolean runExecutionExplorers(CompileContext compileContext)

Description copied from interface: ManagedObjectNode

Runs the ExecutionObjectExplorer instances for the ManagedObject.

Specified by:

runExecutionExplorers in interface ManagedObjectNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully explored execution.

loadDependentObjectType

public DependentObjectType loadDependentObjectType(CompileContext compileContext)

Description copied from interface: DependentObjectNode

Loads the DependentObjectType.

Specified by:

loadDependentObjectType in interface DependentObjectNode

Parameters:

compileContext - CompileContext.

Returns:

DependentObjectType or null with issue reported to the CompilerIssues.

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.

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.

addTypeQualification

public void addTypeQualification(String qualifier,
 String type)

Description copied from interface: SectionManagedObject

Adds an TypeQualification for this SectionManagedObject.

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

Specified by:

addTypeQualification in interface OfficeFloorManagedObject

Specified by:

addTypeQualification in interface OfficeManagedObject

Specified by:

addTypeQualification in interface SectionManagedObject

Parameters:

qualifier - Qualifier. May be null if no qualification.

type - Type (typically the fully qualified type).

addPreLoadAdministration

public void addPreLoadAdministration(OfficeAdministration administration)

Description copied from interface: OfficeSectionManagedObject

Adds an OfficeAdministration to be done before attempting load this ManagedObject.

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

Specified by:

addPreLoadAdministration in interface OfficeManagedObject

Specified by:

addPreLoadAdministration in interface OfficeSectionManagedObject

Parameters:

administration - OfficeAdministration to be done before attempting load this ManagedObject.

getSectionManagedObjectName

public String getSectionManagedObjectName()

Description copied from interface: SectionManagedObject

Obtains the name of this SectionManagedObject.

Specified by:

getSectionManagedObjectName in interface SectionManagedObject

Returns:

Name of this SectionManagedObject.

getSectionManagedObjectDependency

public SectionManagedObjectDependency getSectionManagedObjectDependency(String managedObjectDependencyName)

Description copied from interface: SectionManagedObject

Obtains the SectionManagedObjectDependency for the ManagedObjectDependencyType.

Specified by:

getSectionManagedObjectDependency in interface SectionManagedObject

Parameters:

managedObjectDependencyName - Name of the ManagedObjectDependencyType.

Returns:

SectionManagedObjectDependency.

getOfficeSectionManagedObjectName

public String getOfficeSectionManagedObjectName()

Description copied from interface: OfficeSectionManagedObject

Obtains the name of this OfficeSectionManagedObject.

Specified by:

getOfficeSectionManagedObjectName in interface OfficeSectionManagedObject

Returns:

Name of this OfficeSectionManagedObject.

getOfficeManagedObjectName

public String getOfficeManagedObjectName()

Description copied from interface: OfficeManagedObject

Obtains the name of the ManagedObject.

Specified by:

getOfficeManagedObjectName in interface OfficeManagedObject

Returns:

Name of the ManagedObject.

getOfficeManagedObjectDependency

public OfficeManagedObjectDependency getOfficeManagedObjectDependency(String managedObjectDependencyName)

Description copied from interface: OfficeManagedObject

Obtains the OfficeManagedObjectDependency for the ManagedObjectDependencyType.

Specified by:

getOfficeManagedObjectDependency in interface OfficeManagedObject

Parameters:

managedObjectDependencyName - Name of the ManagedObjectDependencyType.

Returns:

OfficeManagedObjectDependency.

addExecutionExplorer

public void addExecutionExplorer(ExecutionObjectExplorer executionObjectExplorer)

Description copied from interface: OfficeManagedObject

Adds an ExecutionObjectExplorer for the execution tree from this OfficeManagedObject.

Specified by:

addExecutionExplorer in interface OfficeManagedObject

Parameters:

executionObjectExplorer - ExecutionObjectExplorer.

getOfficeFloorManagedObjectName

public String getOfficeFloorManagedObjectName()

Description copied from interface: OfficeFloorManagedObject

Obtains the name of this OfficeFloorManagedObject.

Specified by:

getOfficeFloorManagedObjectName in interface OfficeFloorManagedObject

Returns:

Name of this OfficeFloorManagedObject.

getOfficeFloorManagedObjectDependency

public OfficeFloorManagedObjectDependency getOfficeFloorManagedObjectDependency(String managedObjectDependencyName)

Description copied from interface: OfficeFloorManagedObject

Obtains the OfficeFloorManagedObjectDependency for the ManagedObjectDependencyType.

Specified by:

getOfficeFloorManagedObjectDependency in interface OfficeFloorManagedObject

Parameters:

managedObjectDependencyName - Name of the ManagedObjectDependencyType.

Returns:

OfficeFloorManagedObjectDependency.

getDependentManagedObjectName

public String getDependentManagedObjectName()

Description copied from interface: DependentManagedObject

Obtains the name of this DependentManagedObject.

Specified by:

getDependentManagedObjectName in interface DependentManagedObject

Returns:

Name of this DependentManagedObject.

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.

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.