Package net.officefloor.compile.impl.structure

Class SectionObjectNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.SectionObjectNodeImpl

All Implemented Interfaces:

DependentObjectNode, LinkObjectNode, Node, SectionObjectNode, OfficeDependencyRequireNode, OfficeSectionObject, SectionDependencyObjectNode, SectionDependencyRequireNode, SectionObject, SubSectionObject

public class SectionObjectNodeImpl
extends Object
implements SectionObjectNode

SectionObjectNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
SectionObjectNodeImpl(String objectName, SectionNode section, NodeContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Object annotation)	Adds an annotation.
Node[]	getChildNodes()	Obtains the child Node instances.
LinkObjectNode	getLinkedObjectNode()	Obtains the LinkObjectNode linked to this LinkObjectNode.
String	getLocation()	Obtains the location of the Node.
String	getNodeName()	Obtains the name of the Node.
String	getNodeType()	Obtains the Node type.
OfficeSection	getOfficeSection()	Obtains the OfficeSection containing this OfficeSectionOutput.
String	getOfficeSectionObjectName()	Obtains the name of this OfficeSectionObject.
Node	getParentNode()	Obtains the Node containing this Node.
SectionNode	getSectionNode()	Obtains SectionNode containing this SectionObjectNode.
String	getSectionObjectName()	Obtains the name of this SectionObject.
String	getSubSectionObjectName()	Obtains the name of this SubSectionObject.
void	initialise(String objectType)	Initialises this SectionObjectType.
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.
OfficeSectionObjectType	loadOfficeSectionObjectType(CompileContext compileContext)	Loads the OfficeSectionObjectType.
SectionObjectType	loadSectionObjectType(CompileContext compileContext)	Loads the SectionObjectType.
boolean	pruneIfUnused()	Removes SectionObject and further outer links, should the SectionObject not be used.
void	setTypeQualifier(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 Details

SectionObjectNodeImpl

public SectionObjectNodeImpl(String objectName,
 SectionNode section,
 NodeContext context)

Instantiate.

Parameters:

objectName - Name of the SectionObject.

section - SectionNode containing this SectionObjectNode.

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

Description copied from interface: SectionObjectNode

Initialises this SectionObjectType.

Specified by:

initialise in interface SectionObjectNode

Parameters:

objectType - Object type.

setTypeQualifier

public void setTypeQualifier(String qualifier)

Description copied from interface: SectionObject

Specifies the type qualifier.

Specified by:

setTypeQualifier in interface SectionObject

Parameters:

qualifier - Type qualifier.

getSectionNode

public SectionNode getSectionNode()

Description copied from interface: SectionObjectNode

Obtains SectionNode containing this SectionObjectNode.

Specified by:

getSectionNode in interface SectionObjectNode

Returns:

SectionNode containing this SectionObjectNode.

pruneIfUnused

public boolean pruneIfUnused()

Description copied from interface: SectionObjectNode

Removes SectionObject and further outer links, should the SectionObject not be used.

Specified by:

pruneIfUnused in interface SectionObjectNode

Returns:

true if removed.

loadSectionObjectType

public SectionObjectType loadSectionObjectType(CompileContext compileContext)

Description copied from interface: SectionObjectNode

Loads the SectionObjectType.

Specified by:

loadSectionObjectType in interface SectionObjectNode

Parameters:

compileContext - CompileContext.

Returns:

SectionObjectType or null with issue reported to the CompilerIssues.

loadOfficeSectionObjectType

public OfficeSectionObjectType loadOfficeSectionObjectType(CompileContext compileContext)

Description copied from interface: SectionObjectNode

Loads the OfficeSectionObjectType.

Specified by:

loadOfficeSectionObjectType in interface SectionObjectNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeSectionObjectType or null with issue reported to the CompilerIssues.

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.

getSectionObjectName

public String getSectionObjectName()

Description copied from interface: SectionObject

Obtains the name of this SectionObject.

Specified by:

getSectionObjectName in interface SectionObject

Returns:

Name of this SectionObject.

addAnnotation

public void addAnnotation(Object annotation)

Description copied from interface: SectionObject

Adds an annotation.

Specified by:

addAnnotation in interface SectionObject

Parameters:

annotation - Annotation.

getSubSectionObjectName

public String getSubSectionObjectName()

Description copied from interface: SubSectionObject

Obtains the name of this SubSectionObject.

Specified by:

getSubSectionObjectName in interface SubSectionObject

Returns:

Name of this SubSectionObject.

getOfficeSection

public OfficeSection getOfficeSection()

Description copied from interface: OfficeSectionObject

Obtains the OfficeSection containing this OfficeSectionOutput.

Specified by:

getOfficeSection in interface OfficeSectionObject

Returns:

OfficeSection containing this OfficeSectionOutput.

getOfficeSectionObjectName

public String getOfficeSectionObjectName()

Description copied from interface: OfficeSectionObject

Obtains the name of this OfficeSectionObject.

Specified by:

getOfficeSectionObjectName in interface OfficeSectionObject

Returns:

Name of this OfficeSectionObject.

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.