Package net.officefloor.compile.internal.structure

Interface SectionNode

All Superinterfaces:

ManagedFunctionRegistry, ManagedObjectRegistry, Node, OfficeSection, OfficeSectionTransformerContext, OfficeSubSection, PropertyConfigurable, SectionDesigner, SourceIssues, SubSection

All Known Implementing Classes:

SectionNodeImpl

public interface SectionNode
extends Node, ManagedObjectRegistry, ManagedFunctionRegistry, OfficeSectionTransformerContext, SectionDesigner, SubSection, OfficeSection

Node within the hierarchy of OfficeSection instances.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	Node type.

Method Summary

Modifier and Type	Method	Description
void	autoWireObjects(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext)	Auto-wires the SectionObjectNode instances that are unlinked.
void	autoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto-wires the SectionFunction instances to a possible responsible Team.
void	buildSection(OfficeBuilder officeBuilder, OfficeBindings officeBindings, CompileContext compileContext)	Builds this OfficeSection for this SectionNode.
DeployedOfficeInput	getDeployedOfficeInput(String inputName)	Obtains the DeployedOfficeInput.
GovernanceNode[]	getGoverningGovernances()	Obtains the GovernanceNode instances providing Governance over this SectionNode.
OfficeNode	getOfficeNode()	Obtains the OfficeNode containing this SectionNode.
SectionNode	getParentSectionNode()	Obtains the parent SectionNode containing this SectionNode.
SectionOutputNode	getSectionOutputNode(String outputName)	Obtains the possible SectionOutputNode.
String	getSectionQualifiedName(String simpleName)	Obtains the SectionNode qualified name within the OfficeNode.
SectionNode	getSuperSection()	Obtains the parent SectionNode to this SectionNode.
void	initialise(String sectionSourceClassName, SectionSource sectionSource, String sectionLocation)	Initialises this SectionNode.
void	loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer, CompileContext compileContext)	Loads the AutoWire extension targets for the OfficeSectionManagedObject extension targets..
void	loadExternalServicing(Office office)	Loads the FunctionManager instances to externally trigger this SectionNode.
void	loadManagedFunctionNodes(Map<String,ManagedFunctionNode> managedFunctionNodes)	Loads the ManagedFunctionNode instances.
OfficeAvailableSectionInputType[]	loadOfficeAvailableSectionInputTypes(CompileContext compileContext)	Loads the OfficeAvailableSectionInputType instances.
OfficeSectionType	loadOfficeSectionType(CompileContext compileContext)	Loads the OfficeSectionType.
OfficeSubSectionType	loadOfficeSubSectionType(OfficeSubSectionType parentSectionType, CompileContext compileContext)	Loads the OfficeSubSectionType.
SectionType	loadSectionType(CompileContext compileContext)	Loads the SectionType.
boolean	removeSectionObjectIfUnused(SectionObjectNode sectionObject)	Removes the SectionObjectNode if unused.
boolean	runExecutionExplorers(Map<String,ManagedFunctionNode> managedFunctions, CompileContext compileContext)	Runs the ExecutionExplorer instances.
boolean	sourceInheritance(CompileContext compileContext)	Sources the inheritance of the SectionNode.
boolean	sourceSection(ManagedFunctionVisitor managedFunctionVisitor, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext, boolean isLoadingType)	Sources the section into this SectionNode.
boolean	sourceSectionTree(ManagedFunctionVisitor managedFunctionVisitor, ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext, boolean isLoadingType)	Sources this SectionNode and all its descendant Node instances recursively.

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

addManagedFunctionNode

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.OfficeSection

getOfficeSectionInput, getOfficeSectionObject, getOfficeSectionOutput, setSuperOfficeSection

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

createPropertyList, getOfficeSectionName, getSectionLocation, getSectionProperties, getSectionSourceClassName, setTransformedOfficeSection, setTransformedOfficeSection

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

addGovernance, getOfficeSectionFunction, getOfficeSectionManagedObject, getOfficeSectionManagedObjectSource, getOfficeSectionName, getOfficeSubSection

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

addProperty

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

addManagedObjectPool, addManagedObjectPool, addSectionFunctionNamespace, addSectionFunctionNamespace, addSectionInput, addSectionManagedObjectSource, addSectionManagedObjectSource, addSectionObject, addSectionOutput, addSubSection, addSubSection, link, link, link, link

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

addIssue, addIssue

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

getSubSectionInput, getSubSectionName, getSubSectionObject, getSubSectionOutput

Field Details

TYPE

static final String TYPE

Node type.

See Also:

• Constant Field Values

Method Details

initialise

void initialise(String sectionSourceClassName,
 SectionSource sectionSource,
 String sectionLocation)

Initialises this SectionNode.

Parameters:

sectionSourceClassName - SectionSource class name.

sectionSource - Optional instantiated SectionSource. May be null.

sectionLocation - Location of the OfficeSection.

sourceSection

boolean sourceSection(ManagedFunctionVisitor managedFunctionVisitor,
 ManagedObjectSourceVisitor managedObjectSourceVisitor,
 CompileContext compileContext,
 boolean isLoadingType)

Sources the section into this SectionNode.

This will only source the top level OfficeSection.

Parameters:

managedFunctionVisitor - ManagedFunctionVisitor.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

isLoadingType - Indicates if used for loading type.

Returns:

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

sourceSectionTree

boolean sourceSectionTree(ManagedFunctionVisitor managedFunctionVisitor,
 ManagedObjectSourceVisitor managedObjectSourceVisitor,
 CompileContext compileContext,
 boolean isLoadingType)

Sources this SectionNode and all its descendant Node instances recursively.

Parameters:

managedFunctionVisitor - ManagedFunctionVisitor.

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

isLoadingType - Indicates if used for loading type.

Returns:

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

sourceInheritance

boolean sourceInheritance(CompileContext compileContext)

Sources the inheritance of the SectionNode.

Parameters:

compileContext - CompileContext.

Returns:

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

getSuperSection

SectionNode getSuperSection()

Obtains the parent SectionNode to this SectionNode.

Returns:

Parent SectionNode to this SectionNode.

getSectionOutputNode

SectionOutputNode getSectionOutputNode(String outputName)

Obtains the possible SectionOutputNode.

Parameters:

outputName - Name of the SectionOutputNode.

Returns:

SectionOutputNode or null if no SectionOutputNode by name on the SectionNode.

removeSectionObjectIfUnused

boolean removeSectionObjectIfUnused(SectionObjectNode sectionObject)

Removes the SectionObjectNode if unused.

Parameters:

sectionObject - SectionObjectNode to remove if unused.

Returns:

true if removed.

loadSectionType

SectionType loadSectionType(CompileContext compileContext)

Loads the SectionType.

Parameters:

compileContext - CompileContext.

Returns:

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

loadOfficeSectionType

OfficeSectionType loadOfficeSectionType(CompileContext compileContext)

Loads the OfficeSectionType.

Parameters:

compileContext - CompileContext.

Returns:

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

loadOfficeSubSectionType

OfficeSubSectionType loadOfficeSubSectionType(OfficeSubSectionType parentSectionType,
 CompileContext compileContext)

Loads the OfficeSubSectionType.

Parameters:

parentSectionType - Parent OfficeSubSectionType.

compileContext - CompileContext.

Returns:

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

loadOfficeAvailableSectionInputTypes

OfficeAvailableSectionInputType[] loadOfficeAvailableSectionInputTypes(CompileContext compileContext)

Loads the OfficeAvailableSectionInputType instances.

Parameters:

compileContext - CompileContext.

Returns:

OfficeAvailableSectionInputType instances or null with issues reported to the CompilerIssues.

getDeployedOfficeInput

DeployedOfficeInput getDeployedOfficeInput(String inputName)

Obtains the DeployedOfficeInput.

Parameters:

inputName - Input name as per the OfficeAvailableSectionInputType.

Returns:

DeployedOfficeInput.

getGoverningGovernances

GovernanceNode[] getGoverningGovernances()

Obtains the GovernanceNode instances providing Governance over this SectionNode.

This is list comprised of the:

1. GovernanceNode assigned to this particular SectionNode
2. GovernanceNode assigned to any parent SectionNode

Returns:

GovernanceNode instances providing Governance over this SectionNode.

getParentSectionNode

SectionNode getParentSectionNode()

Obtains the parent SectionNode containing this SectionNode.

Returns:

Parent SectionNode or null if this SectionNode is the top level SectionNode (in other words a OfficeSection).

getOfficeNode

OfficeNode getOfficeNode()

Obtains the OfficeNode containing this SectionNode.

Returns:

OfficeNode containing this SectionNode.

getSectionQualifiedName

String getSectionQualifiedName(String simpleName)

Obtains the SectionNode qualified name within the OfficeNode.

Parameters:

simpleName - Simple name to qualify with the SectionNode name space.

Returns:

SectionNode qualified name.

loadAutoWireExtensionTargets

void loadAutoWireExtensionTargets(AutoWirer<ManagedObjectExtensionNode> autoWirer,
 CompileContext compileContext)

Loads the AutoWire extension targets for the OfficeSectionManagedObject extension targets..

Parameters:

autoWirer - AutoWirer to be loaded with the OfficeSectionManagedObject extension targets.

compileContext - CompileContext.

autoWireObjects

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

Auto-wires the SectionObjectNode instances that are unlinked.

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

autoWireTeams

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

Auto-wires the SectionFunction instances to a possible responsible Team.

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

loadManagedFunctionNodes

void loadManagedFunctionNodes(Map<String,ManagedFunctionNode> managedFunctionNodes)

Loads the ManagedFunctionNode instances.

Parameters:

managedFunctionNodes - Map to be loaded with the ManagedFunctionNode instances by their qualified name.

runExecutionExplorers

boolean runExecutionExplorers(Map<String,ManagedFunctionNode> managedFunctions,
 CompileContext compileContext)

Runs the ExecutionExplorer instances.

Parameters:

managedFunctions - ManagedFunctionNode instances by their qualified name.

compileContext - CompileContext.

Returns:

true if successfully explored execution.

buildSection

void buildSection(OfficeBuilder officeBuilder,
 OfficeBindings officeBindings,
 CompileContext compileContext)

Builds this OfficeSection for this SectionNode.

Parameters:

officeBuilder - OfficeBuilder of the Office containing this SectionNode.

officeBindings - OfficeBindings of the Office containing this SectionNode.

compileContext - CompileContext.

loadExternalServicing

void loadExternalServicing(Office office)
                    throws UnknownFunctionException

Loads the FunctionManager instances to externally trigger this SectionNode.

Parameters:

office - Office containing this SectionNode.

Throws:

UnknownFunctionException - UnknownFunctionException.