Package net.officefloor.compile.impl.structure

Class OfficeObjectNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.OfficeObjectNodeImpl

All Implemented Interfaces:

LinkObjectNode, Node, OfficeObjectNode, AdministerableManagedObject, DependentManagedObject, GovernerableManagedObject, OfficeDependencyObjectNode, OfficeObject, OfficeFloorDependencyRequireNode

public class OfficeObjectNodeImpl
extends java.lang.Object
implements OfficeObjectNode

OfficeObjectNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
OfficeObjectNodeImpl(java.lang.String objectName, OfficeNode office, NodeContext context)	Allow adding a OfficeObject via the OfficeArchitect.

Method Summary

Modifier and Type	Method	Description
void	addAdministrator(AdministrationNode administrator)	Adds an AdministrationNode for this OfficeManagedObjectType.
void	addGovernance(GovernanceNode governance)	Adds a GovernanceNode providing Governance for this OfficeObject.
void	addPreLoadAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done before attempting load this ManagedObject.
java.lang.String	getAdministerableManagedObjectName()	Obtains the name of this AdministerableManagedObject.
Node[]	getChildNodes()	Obtains the child Node instances.
java.lang.String	getDependentManagedObjectName()	Obtains the name of this DependentManagedObject.
GovernanceNode[]	getGovernances()	Obtains the GovernanceNode instances to provide Governance over BoundManagedObjectNode linked to this OfficeObjectNode.
java.lang.String	getGovernerableManagedObjectName()	Obtains the name of this GovernerableManagedObject.
LinkObjectNode	getLinkedObjectNode()	Obtains the LinkObjectNode linked to this LinkObjectNode.
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	getOfficeObjectName()	Obtains the name that the OfficeSource refers to this Object.
java.lang.String	getOfficeObjectType()	Obtains the type of the OfficeObject.
Node	getParentNode()	Obtains the Node containing this Node.
AdministrationNode[]	getPreLoadAdministrations()	Obtains the AdministrationNode instances to provide pre-load Administration over BoundManagedObjectNode linked to this OfficeObjectNode.
java.lang.String	getTypeQualifier()	Obtains the type qualifier for the OfficeObject.
void	initialise(java.lang.String objectType)	Initialises this OfficeManagedObjectType.
boolean	isInitialised()	Indicates if the Node has been initialised.
boolean	linkObjectNode(LinkObjectNode node)	Links the input LinkObjectNode to this LinkObjectNode.
OfficeManagedObjectType	loadOfficeManagedObjectType(CompileContext compileContext)	Loads the OfficeManagedObjectType for this OfficeObjectNode.
void	setTypeQualifier(java.lang.String qualifier)	Specifies the type qualifier.

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

OfficeObjectNodeImpl

public OfficeObjectNodeImpl(java.lang.String objectName,
                            OfficeNode office,
                            NodeContext context)

Allow adding a OfficeObject via the OfficeArchitect.

Parameters:

objectName - Name of the OfficeObject.

office - Parent OfficeNode.

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

Description copied from interface: OfficeObjectNode

Initialises this OfficeManagedObjectType.

Specified by:

initialise in interface OfficeObjectNode

Parameters:

objectType - Object type.

addAdministrator

public void addAdministrator(AdministrationNode administrator)

Description copied from interface: OfficeObjectNode

Adds an AdministrationNode for this OfficeManagedObjectType.

This allows the OfficeManagedObjectType to report the extension types required to be supported by the OfficeFloorManagedObject for the OfficeObject.

Specified by:

addAdministrator in interface OfficeObjectNode

Parameters:

administrator - AdministrationNode.

addGovernance

public void addGovernance(GovernanceNode governance)

Description copied from interface: OfficeObjectNode

Adds a GovernanceNode providing Governance for this OfficeObject.

This also allows the OfficeManagedObjectType to report the extension interfaces required to be supported by the OfficeFloorManagedObject for the OfficeObject.

Specified by:

addGovernance in interface OfficeObjectNode

Parameters:

governance - GovernanceNode.

getGovernances

public GovernanceNode[] getGovernances()

Description copied from interface: OfficeObjectNode

Obtains the GovernanceNode instances to provide Governance over BoundManagedObjectNode linked to this OfficeObjectNode.

Specified by:

getGovernances in interface OfficeObjectNode

Returns:

GovernanceNode instances.

getPreLoadAdministrations

public AdministrationNode[] getPreLoadAdministrations()

Description copied from interface: OfficeObjectNode

Obtains the AdministrationNode instances to provide pre-load Administration over BoundManagedObjectNode linked to this OfficeObjectNode.

Specified by:

getPreLoadAdministrations in interface OfficeObjectNode

Returns:

AdministrationNode instances.

getTypeQualifier

public java.lang.String getTypeQualifier()

Description copied from interface: OfficeObjectNode

Obtains the type qualifier for the OfficeObject.

Specified by:

getTypeQualifier in interface OfficeObjectNode

Returns:

Type qualifier for the OfficeObject.

getOfficeObjectType

public java.lang.String getOfficeObjectType()

Description copied from interface: OfficeObjectNode

Obtains the type of the OfficeObject.

Specified by:

getOfficeObjectType in interface OfficeObjectNode

Returns:

Type of the OfficeObject.

loadOfficeManagedObjectType

public OfficeManagedObjectType loadOfficeManagedObjectType(CompileContext compileContext)

Description copied from interface: OfficeObjectNode

Loads the OfficeManagedObjectType for this OfficeObjectNode.

Specified by:

loadOfficeManagedObjectType in interface OfficeObjectNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeManagedObjectType or null with issues reported to the CompilerIssues.

getOfficeObjectName

public java.lang.String getOfficeObjectName()

Description copied from interface: OfficeObject

Obtains the name that the OfficeSource refers to this Object.

Specified by:

getOfficeObjectName in interface OfficeObject

Returns:

Name that the OfficeSource refers to this Object.

setTypeQualifier

public void setTypeQualifier(java.lang.String qualifier)

Description copied from interface: OfficeObject

Specifies the type qualifier.

Specified by:

setTypeQualifier in interface OfficeObject

Parameters:

qualifier - Type qualifier.

addPreLoadAdministration

public void addPreLoadAdministration(OfficeAdministration administration)

Description copied from interface: OfficeObject

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 OfficeObject

Parameters:

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

getDependentManagedObjectName

public java.lang.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 java.lang.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 java.lang.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.