net.officefloor.compile.impl.structure

Class WorkNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.WorkNodeImpl

All Implemented Interfaces:

Node, WorkNode, PropertyConfigurable, SectionWork

public class WorkNodeImpl
extends Object
implements WorkNode

WorkNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor and Description
WorkNodeImpl(String workName, SectionNode section, NodeContext context) Instantiate.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value) Adds a Property to configure the item.
SectionTask	addSectionTask(String taskName, String taskTypeName) Adds a SectionTask.
WorkBuilder<?>	buildWork(OfficeBuilder builder, TypeContext typeContext) Builds the Work for this SectionWork.
String	getLocation() Obtains the location of the Node.
String	getNodeName() Obtains the name of the Node.
String	getNodeType() Obtains the Node type.
Node	getParentNode() Obtains the Node containing this Node.
String	getQualifiedWorkName() Obtains the name of this Work qualified with the OfficeSection hierarchy containing this Work.
SectionNode	getSectionNode() Obtains the SectionNode containing this WorkNode.
String	getSectionWorkName() Obtains the name of this SectionWork.
void	initialise(String workSourceClassName, WorkSource<?> workSource) Initialises the WorkNode.
boolean	isInitialised() Indicates if the Node has been initialised.
WorkType<?>	loadWorkType() Obtains the WorkType for this WorkNode.
void	setInitialTask(SectionTask task) Specifies the initial SectionTask for this SectionWork.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkNodeImpl

public WorkNodeImpl(String workName,
                    SectionNode section,
                    NodeContext context)

Instantiate.

Parameters:

workName - Name of this SectionWork.

section - OfficeSection containing this WorkNode.

context - NodeContext.

Method Detail

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.

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 workSourceClassName,
                       WorkSource<?> workSource)

Description copied from interface: WorkNode

Initialises the WorkNode.

Specified by:

initialise in interface WorkNode

Parameters:

workSourceClassName - Class name of the WorkSource.

workSource - Optional instantiated WorkSource. May be null.

getSectionWorkName

public String getSectionWorkName()

Description copied from interface: SectionWork

Obtains the name of this SectionWork.

Specified by:

getSectionWorkName in interface SectionWork

Returns:

Name of this SectionWork.

addProperty

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

addSectionTask

public SectionTask addSectionTask(String taskName,
                                  String taskTypeName)

Description copied from interface: SectionWork

Adds a SectionTask.

Specified by:

addSectionTask in interface SectionWork

Parameters:

taskName - Name of the SectionTask.

taskTypeName - Name of the TaskType on the WorkType.

Returns:

SectionTask.

setInitialTask

public void setInitialTask(SectionTask task)

Description copied from interface: SectionWork

Specifies the initial SectionTask for this SectionWork.

Specified by:

setInitialTask in interface SectionWork

Parameters:

task - Initial SectionTask.

getSectionNode

public SectionNode getSectionNode()

Description copied from interface: WorkNode

Obtains the SectionNode containing this WorkNode.

Specified by:

getSectionNode in interface WorkNode

Returns:

SectionNode containing this WorkNode.

getQualifiedWorkName

public String getQualifiedWorkName()

Description copied from interface: WorkNode

Obtains the name of this Work qualified with the OfficeSection hierarchy containing this Work.

Specified by:

getQualifiedWorkName in interface WorkNode

Returns:

Qualified name of this Work.

loadWorkType

public WorkType<?> loadWorkType()

Description copied from interface: WorkNode

Obtains the WorkType for this WorkNode.

Specified by:

loadWorkType in interface WorkNode

Returns:

WorkType for this WorkNode. May be null if can not load the WorkType.

buildWork

public WorkBuilder<?> buildWork(OfficeBuilder builder,
                                TypeContext typeContext)

Description copied from interface: WorkNode

Builds the Work for this SectionWork.

Specified by:

buildWork in interface WorkNode

Parameters:

builder - OfficeBuilder.

typeContext - TypeContext.

Returns:

WorkBuilder to enable building the TaskNode instances.