Package net.officefloor.compile.internal.structure

Interface OfficeNode

All Superinterfaces:

DeployedOffice, LinkOfficeNode, ManagedObjectRegistry, Node, OfficeArchitect, OfficeTeamRegistry, OverrideProperties, PropertyConfigurable, SourceIssues

All Known Implementing Classes:

OfficeNodeImpl

public interface OfficeNode
extends LinkOfficeNode, ManagedObjectRegistry, OfficeTeamRegistry, OverrideProperties, OfficeArchitect, DeployedOffice

Office node.

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
OfficeManagedObjectSource	addManagedObjectSource(java.lang.String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject)	Adds a OfficeManagedObjectSource supplied from an OfficeSupplier.
void	autoWireObjects(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext)	Auto-wires the OfficeObjectNode instances that are unlinked.
void	autoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto-wires the OfficeTeamNode instances that are unlinked.
OfficeBindings	buildOffice(OfficeFloorBuilder builder, CompileContext compileContext, Profiler profiler)	Builds the Office for this OfficeNode.
java.lang.String[]	getAdditionalProfiles()	Obtains the additional profiles.
AvailableType[]	getAvailableTypes(CompileContext compileContext)	Obtains the AvailableType instances.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances for the Office.
OfficeFloorNode	getOfficeFloorNode()	Obtains the OfficeFloorNode containing this OfficeNode.
void	initialise(java.lang.String officeSourceClassName, OfficeSource officeSource, java.lang.String officeLocation)	Initialises the OfficeNode.
void	loadExternalServicing(Office office)	Loads the FunctionManager instances to externally trigger this OfficeNode.
OfficeType	loadOfficeType(CompileContext compileContext)	Loads the OfficeType.
boolean	runExecutionExplorers(CompileContext compileContext)	Runs the ExecutionExplorer instances.
boolean	sourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor, AutoWirerVisitor autoWirerVisitor, CompileContext compileContext)	Sources this Office and all descendant Node instances.
boolean	sourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext)	Sources this Office along with its top level OfficeSection instances into this OfficeNode.

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

addAdditionalProfile, addOverrideProperty, getDeployedOfficeInput, getDeployedOfficeName, getDeployedOfficeObject, getDeployedOfficeTeam

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

getLinkedOfficeNode, linkOfficeNode

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

addManagedObjectNode, getManagedObjectNode

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.office.OfficeArchitect

addManagedFunctionAugmentor, addManagedObjectPool, addManagedObjectPool, addOfficeAdministration, addOfficeAdministration, addOfficeCompletionExplorer, addOfficeEscalation, addOfficeEscalationExplorer, addOfficeGovernance, addOfficeGovernance, addOfficeInput, addOfficeManagedObjectSource, addOfficeManagedObjectSource, addOfficeObject, addOfficeOutput, addOfficeSection, addOfficeSection, addOfficeSectionTransformer, addOfficeStart, addOfficeTeam, addSupplier, addSupplier, enableAutoWireObjects, enableAutoWireTeams, getOfficeSection, link, link, link, link, startAfter, startAfter, startBefore, startBefore

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

createOfficeTeam, getOfficeTeams

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

getOverridePropertyList

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

addProperty

Methods inherited from interface net.officefloor.compile.issues.SourceIssues

addIssue, addIssue

Field Detail

TYPE

static final java.lang.String TYPE

Node type.

See Also:

Constant Field Values

Method Detail

initialise

void initialise(java.lang.String officeSourceClassName,
                OfficeSource officeSource,
                java.lang.String officeLocation)

Initialises the OfficeNode.

Parameters:

officeSourceClassName - OfficeSource class name.

officeSource - Optional instantiated OfficeSource. May be null.

officeLocation - Location of the Office.

getAdditionalProfiles

java.lang.String[] getAdditionalProfiles()

Obtains the additional profiles.

Returns:

Additional profiles.

addManagedObjectSource

OfficeManagedObjectSource addManagedObjectSource(java.lang.String managedObjectSourceName,
                                                 SuppliedManagedObjectSourceNode suppliedManagedObject)

Adds a OfficeManagedObjectSource supplied from an OfficeSupplier.

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

suppliedManagedObject - SuppliedManagedObjectSourceNode to supply the OfficeManagedObjectSource.

Returns:

OfficeManagedObjectSource.

sourceOfficeWithTopLevelSections

boolean sourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                         CompileContext compileContext)

Sources this Office along with its top level OfficeSection instances into this OfficeNode.

Parameters:

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

sourceOfficeTree

boolean sourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor,
                         AutoWirerVisitor autoWirerVisitor,
                         CompileContext compileContext)

Sources this Office and all descendant Node instances.

Parameters:

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

getOfficeFloorNode

OfficeFloorNode getOfficeFloorNode()

Obtains the OfficeFloorNode containing this OfficeNode.

Returns:

OfficeFloorNode containing this OfficeNode.

loadOfficeType

OfficeType loadOfficeType(CompileContext compileContext)

Loads the OfficeType.

Parameters:

compileContext - CompileContext.

Returns:

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

getAvailableTypes

AvailableType[] getAvailableTypes(CompileContext compileContext)

Obtains the AvailableType instances.

Parameters:

compileContext - CompileContext.

Returns:

AvailableType instances.

autoWireObjects

void autoWireObjects(AutoWirer<LinkObjectNode> autoWirer,
                     CompileContext compileContext)

Auto-wires the OfficeObjectNode instances that are unlinked.

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

autoWireTeams

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

Auto-wires the OfficeTeamNode instances that are unlinked.

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

runExecutionExplorers

boolean runExecutionExplorers(CompileContext compileContext)

Runs the ExecutionExplorer instances.

Parameters:

compileContext - CompileContext.

Returns:

true if successfully explored execution.

buildOffice

OfficeBindings buildOffice(OfficeFloorBuilder builder,
                           CompileContext compileContext,
                           Profiler profiler)

Builds the Office for this OfficeNode.

Parameters:

builder - OfficeFloorBuilder.

compileContext - CompileContext.

profiler - Optional Profiler. May be null.

Returns:

OfficeBuilder for the built Office.

loadExternalServicing

void loadExternalServicing(Office office)
                    throws UnknownFunctionException

Loads the FunctionManager instances to externally trigger this OfficeNode.

Parameters:

office - Office for this OfficeNode.

Throws:

UnknownFunctionException - UnknownFunctionException.

getInternalSuppliers

InternalSupplier[] getInternalSuppliers()

Obtains the InternalSupplier instances for the Office.

Returns:

InternalSupplier instances for the Office.