Package net.officefloor.compile.internal.structure

Interface ManagedObjectSourceNode

All Superinterfaces:

LinkPoolNode, LinkStartAfterNode, LinkStartBeforeNode, Node, OfficeFloorManagedObjectSource, OfficeManagedObjectSource, OfficeSectionManagedObjectSource, PropertyConfigurable, SectionManagedObjectSource

All Known Implementing Classes:

ManagedObjectSourceNodeImpl

public interface ManagedObjectSourceNode
extends LinkPoolNode, LinkStartBeforeNode, LinkStartAfterNode, SectionManagedObjectSource, OfficeManagedObjectSource, OfficeSectionManagedObjectSource, OfficeFloorManagedObjectSource

Node representing a ManagedObjectSource.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE	Node type.

Method Summary

Modifier and Type	Method	Description
void	autoWireFunctionDependencies(AutoWirer<LinkObjectNode> autoWirer, OfficeNode office, CompileContext compileContext)	Auto-wires the function dependencies for this ManagedObjectSource.
void	autoWireInputDependencies(AutoWirer<LinkObjectNode> autoWirer, OfficeNode office, CompileContext compileContext)	Auto-wires the input dependencies for this ManagedObjectSource.
void	autoWireStartupOrdering(AutoWirer<ManagedObjectSourceNode> autoWirer, OfficeNode office, CompileContext compileContext)	Auto-wires the start up ordering for this ManagedObjectSource.
void	autoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto-wires the Team instances for this ManagedObjectSource.
void	autoWireToOffice(OfficeNode officeNode, CompilerIssues issues)	Auto-wires this ManagedObjectSourceNode to the OfficeNode.
void	buildManagedObject(OfficeFloorBuilder builder, OfficeNode managingOffice, OfficeBuilder managingOfficeBuilder, OfficeBindings officeBindings, CompileContext compileContext)	Builds ManagedObjectSource for this ManagedObjectNode.
void	buildSupplierThreadLocal(OptionalThreadLocalReceiver optionalThreadLocalReceiver)	Builds the SupplierThreadLocal for the InputManagedObjectNode from this ManagedObjectSourceNode.
ExecutionManagedFunction	createExecutionManagedFunction(ManagedObjectFlowType<?> flowType, CompileContext compileContext)	Creates the ExecutionManagedFunction.
AugmentedManagedObjectExecutionStrategy	getAugmentedManagedObjectExecutionStrategy(java.lang.String executionStrategyName)	Obtains the AugmentedManagedObjectExecutionStrategy.
AugmentedManagedObjectFlow	getAugmentedManagedObjectFlow(java.lang.String flowName)	Obtains the AugmentedManagedObjectFlow.
AugmentedManagedObjectTeam	getAugmentedManagedObjectTeam(java.lang.String teamName)	Obtains the AugmentedManagedObjectTeam.
InputManagedObjectNode	getInputManagedObjectNode()	Obtains the InputManagedObjectNode for this ManagedObjectSource.
java.lang.String	getManagedObjectSourceName()	Obtains the name to build the ManagedObjectSource.
OfficeNode	getManagingOfficeNode()	Obtains the OfficeNode of the ManagingOffice for this ManagedObjectSource.
OfficeFloorNode	getOfficeFloorNode()	Obtains the OfficeFloorNode containing this ManagedObjectSourceNode.
OfficeNode	getOfficeNode()	Obtains the OfficeNode containing this ManagedObjectSourceNode.
SectionNode	getSectionNode()	Obtains the SectionNode containing this ManagedObjectSourceNode.
void	initialise(java.lang.String managedObjectSourceClassName, ManagedObjectSource<?,?> managedObjectSource)	Initialises the ManagedObjectSourceNode.
boolean	isAutoWireStartupOrdering()	Indicates if there is auto-wired start up ordering.
boolean	isSupplied()	Indicates if the ManagedObjectSource is from SupplierSource.
boolean	linkAutoWireStartAfter(java.lang.String managedObjectType)	Links an auto-wire start after ManagedObject object type.
boolean	linkAutoWireStartBefore(java.lang.String managedObjectType)	Links an auto-wire start before ManagedObject object type.
boolean	linkInputManagedObjectNode(InputManagedObjectNode inputManagedObject)	Links the InputManagedObjectNode for this ManagedObjectSource.
ManagedObjectType<?>	loadManagedObjectType(CompileContext compileContext)	Loads the ManagedObjectType.
OfficeFloorManagedObjectSourceType	loadOfficeFloorManagedObjectSourceType(CompileContext compileContext)	Loads the OfficeFloorManagedObjectSourceType.
OfficeSectionManagedObjectSourceType	loadOfficeSectionManagedObjectSourceType(CompileContext compileContext)	Loads the OfficeSectionManagedObjectSourceType.
boolean	sourceManagedObjectSource(ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext)	Sources the ManagedObjectSource.

Methods inherited from interface net.officefloor.compile.internal.structure.LinkPoolNode

getLinkedPoolNode, linkPoolNode

Methods inherited from interface net.officefloor.compile.internal.structure.LinkStartAfterNode

getLinkedStartAfterNodes, linkStartAfterNode

Methods inherited from interface net.officefloor.compile.internal.structure.LinkStartBeforeNode

getLinkedStartBeforeNodes, linkStartBeforeNode

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialised

Methods inherited from interface net.officefloor.compile.spi.officefloor.OfficeFloorManagedObjectSource

addOfficeFloorManagedObject, getInputOfficeFloorManagedObjectDependency, getManagingOffice, getOfficeFloorManagedObjectExecutionStrategy, getOfficeFloorManagedObjectFlow, getOfficeFloorManagedObjectFunctionDependency, getOfficeFloorManagedObjectSourceName, getOfficeFloorManagedObjectTeam, setTimeout

Methods inherited from interface net.officefloor.compile.spi.office.OfficeManagedObjectSource

addOfficeManagedObject, getInputOfficeManagedObjectDependency, getOfficeManagedObjectFlow, getOfficeManagedObjectFunctionDependency, getOfficeManagedObjectSourceName, getOfficeManagedObjectTeam, setTimeout

Methods inherited from interface net.officefloor.compile.spi.office.OfficeSectionManagedObjectSource

getOfficeSectionManagedObject, getOfficeSectionManagedObjectSourceName, getOfficeSectionManagedObjectTeam

Methods inherited from interface net.officefloor.compile.properties.PropertyConfigurable

addProperty

Methods inherited from interface net.officefloor.compile.spi.section.SectionManagedObjectSource

addSectionManagedObject, getInputSectionManagedObjectDependency, getSectionManagedObjectFlow, getSectionManagedObjectSourceName, setTimeout

Field Detail

TYPE

static final java.lang.String TYPE

Node type.

See Also:

Constant Field Values

Method Detail

initialise

void initialise(java.lang.String managedObjectSourceClassName,
                ManagedObjectSource<?,?> managedObjectSource)

Initialises the ManagedObjectSourceNode.

Parameters:

managedObjectSourceClassName - Class name of the ManagedObjectSource.

managedObjectSource - Optional instantiated ManagedObjectSource. May be null.

isSupplied

boolean isSupplied()

Indicates if the ManagedObjectSource is from SupplierSource.

Returns:

true if from SupplierSource.

sourceManagedObjectSource

boolean sourceManagedObjectSource(ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                  CompileContext compileContext)

Sources the ManagedObjectSource.

Parameters:

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

Returns:

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

getAugmentedManagedObjectFlow

AugmentedManagedObjectFlow getAugmentedManagedObjectFlow(java.lang.String flowName)

Obtains the AugmentedManagedObjectFlow.

Parameters:

flowName - Name of the AugmentedManagedObjectFlow.

Returns:

AugmentedManagedObjectFlow.

getAugmentedManagedObjectTeam

AugmentedManagedObjectTeam getAugmentedManagedObjectTeam(java.lang.String teamName)

Obtains the AugmentedManagedObjectTeam.

Parameters:

teamName - Name of the AugmentedManagedObjectTeam.

Returns:

AugmentedManagedObjectTeam.

getAugmentedManagedObjectExecutionStrategy

AugmentedManagedObjectExecutionStrategy getAugmentedManagedObjectExecutionStrategy(java.lang.String executionStrategyName)

Obtains the AugmentedManagedObjectExecutionStrategy.

Parameters:

executionStrategyName - Name of the AugmentedManagedObjectExecutionStrategy.

Returns:

AugmentedManagedObjectExecutionStrategy.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(CompileContext compileContext)

Loads the ManagedObjectType.

Parameters:

compileContext - CompileContext.

Returns:

ManagedObjectType or null if issue loading with issue reported to the CompilerIssues.

loadOfficeSectionManagedObjectSourceType

OfficeSectionManagedObjectSourceType loadOfficeSectionManagedObjectSourceType(CompileContext compileContext)

Loads the OfficeSectionManagedObjectSourceType.

Parameters:

compileContext - CompileContext.

Returns:

OfficeSectionManagedObjectSourceType or null if issue loading with issue reported to the CompilerIssues.

loadOfficeFloorManagedObjectSourceType

OfficeFloorManagedObjectSourceType loadOfficeFloorManagedObjectSourceType(CompileContext compileContext)

Loads the OfficeFloorManagedObjectSourceType.

Parameters:

compileContext - CompileContext.

Returns:

OfficeFloorManagedObjectSourceType or null if issue loading with issue reported to the CompilerIssues.

getSectionNode

SectionNode getSectionNode()

Obtains the SectionNode containing this ManagedObjectSourceNode.

Returns:

SectionNode containing this ManagedObjectSourceNode. May be null if not contained within an OfficeSection (in other words included above the SectionNode instances).

getOfficeNode

OfficeNode getOfficeNode()

Obtains the OfficeNode containing this ManagedObjectSourceNode.

Returns:

OfficeNode containing this ManagedObjectSourceNode. May be null if not contained within an Office (in other words included above the OfficeNode instances).

getOfficeFloorNode

OfficeFloorNode getOfficeFloorNode()

Obtains the OfficeFloorNode containing this ManagedObjectSourceNode.

Returns:

OfficeFloorNode containing this ManagedObjectSourceNode.

getManagingOfficeNode

OfficeNode getManagingOfficeNode()

Obtains the OfficeNode of the ManagingOffice for this ManagedObjectSource.

Returns:

OfficeNode of the ManagingOffice for this ManagedObjectSource or null if can not obtain it.

linkInputManagedObjectNode

boolean linkInputManagedObjectNode(InputManagedObjectNode inputManagedObject)

Links the InputManagedObjectNode for this ManagedObjectSource.

Parameters:

inputManagedObject - InputManagedObjectNode.

Returns:

true if linked.

getInputManagedObjectNode

InputManagedObjectNode getInputManagedObjectNode()

Obtains the InputManagedObjectNode for this ManagedObjectSource.

Returns:

InputManagedObjectNode for this ManagedObjectSource or null if can not obtain it.

autoWireInputDependencies

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

Auto-wires the input dependencies for this ManagedObjectSource.

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

autoWireFunctionDependencies

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

Auto-wires the function dependencies for this ManagedObjectSource.

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

linkAutoWireStartBefore

boolean linkAutoWireStartBefore(java.lang.String managedObjectType)

Links an auto-wire start before ManagedObject object type.

Parameters:

managedObjectType - ManagedObject object type.

Returns:

true if linked.

linkAutoWireStartAfter

boolean linkAutoWireStartAfter(java.lang.String managedObjectType)

Links an auto-wire start after ManagedObject object type.

Parameters:

managedObjectType - ManagedObject object type.

Returns:

true if linked.

isAutoWireStartupOrdering

boolean isAutoWireStartupOrdering()

Indicates if there is auto-wired start up ordering.

Returns:

true if there is auto-wired start up ordering.

autoWireStartupOrdering

void autoWireStartupOrdering(AutoWirer<ManagedObjectSourceNode> autoWirer,
                             OfficeNode office,
                             CompileContext compileContext)

Auto-wires the start up ordering for this ManagedObjectSource.

Parameters:

autoWirer - AutoWirer.

office - OfficeNode requiring the auto-wiring.

compileContext - CompileContext.

autoWireTeams

void autoWireTeams(AutoWirer<LinkTeamNode> autoWirer,
                   CompileContext compileContext)

Auto-wires the Team instances for this ManagedObjectSource.

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

autoWireToOffice

void autoWireToOffice(OfficeNode officeNode,
                      CompilerIssues issues)

Auto-wires this ManagedObjectSourceNode to the OfficeNode.

Parameters:

officeNode - OfficeNode.

issues - CompilerIssues.

createExecutionManagedFunction

ExecutionManagedFunction createExecutionManagedFunction(ManagedObjectFlowType<?> flowType,
                                                        CompileContext compileContext)

Creates the ExecutionManagedFunction.

Parameters:

flowType - ManagedObjectFlowType.

compileContext - CompileContext.

Returns:

ExecutionManagedFunction.

buildManagedObject

void buildManagedObject(OfficeFloorBuilder builder,
                        OfficeNode managingOffice,
                        OfficeBuilder managingOfficeBuilder,
                        OfficeBindings officeBindings,
                        CompileContext compileContext)

Builds ManagedObjectSource for this ManagedObjectNode.

Parameters:

builder - OfficeFloorBuilder.

managingOffice - OfficeNode of the ManagingOffice for this ManagedObjectSource.

managingOfficeBuilder - OfficeBuilder for the ManagingOffice.

officeBindings - OfficeBindings.

compileContext - CompileContext.

getManagedObjectSourceName

java.lang.String getManagedObjectSourceName()

Obtains the name to build the ManagedObjectSource.

Returns:

Name to build the ManagedObjectSource.

buildSupplierThreadLocal

void buildSupplierThreadLocal(OptionalThreadLocalReceiver optionalThreadLocalReceiver)

Builds the SupplierThreadLocal for the InputManagedObjectNode from this ManagedObjectSourceNode.

Parameters:

optionalThreadLocalReceiver - OptionalThreadLocalReceiver.