Package net.officefloor.plugin.section.clazz

Class AbstractFunctionSectionSource

java.lang.Object

net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

net.officefloor.plugin.section.clazz.AbstractFunctionSectionSource

All Implemented Interfaces:

SectionSource

Direct Known Subclasses:

ClassSectionSource

public abstract class AbstractFunctionSectionSource
extends AbstractSectionSource

Abstract function SectionSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractFunctionSectionSource.ObjectForMethod	Object for Method.

Nested classes/interfaces inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

AbstractSectionSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CLASS_OBJECT_NAME	Name of the SectionManagedObject for the section class.

Constructor Summary

Constructors

Constructor	Description
AbstractFunctionSectionSource()

Method Summary

Modifier and Type	Method	Description
protected SectionFunctionNamespace	adddSectionFunctionNamespace(java.lang.String namespace, java.lang.Class<?> sectionClass)	Adds the SectionFunctionNamespace.
protected SectionManagedObject	createClassManagedObject(java.lang.String objectName, java.lang.Class<?> sectionClass)	Creates the SectionManagedObject for providing the section object.
protected void	enrichFunction(SectionFunction function, ManagedFunctionType<?,?> functionType, java.lang.Class<?> parameterType)	Enriches the ManagedFunction.
protected DependencyMetaData[]	extractClassManagedObjectDependencies(java.lang.String objectName, java.lang.Class<?> sectionClass)	Extracts the DependencyMetaData instances for the section object.
protected SectionSourceContext	getContext()	Obtains the SectionSourceContext.
protected SectionDesigner	getDesigner()	Obtains the SectionDesigner.
SectionFunction	getFunctionByName(java.lang.String functionName)	Obtains the SectionFunction by its name.
SectionFunction	getFunctionByTypeName(java.lang.String functionTypeName)	Obtains the SectionFunction by its ManagedFunctionType name.
protected java.lang.String	getFunctionName(ManagedFunctionType<?,?> functionType)	Obtains the ManagedFunction name from the ManagedFunctionType.
ManagedFunctionType<?,?>	getFunctionTypeByName(java.lang.String functionName)	Obtains the ManagedFunctionType for the SectionFunction by its name.
SectionManagedObject	getManagedObject(java.lang.String typeName)	Obtains the SectionManagedObject for the type.
SectionInput	getOrCreateInput(java.lang.String name, java.lang.String argumentType)	Obtains the SectionInput.
SectionObject	getOrCreateObject(java.lang.String qualifier, java.lang.String typeName)	Obtains the SectionObject.
SectionOutput	getOrCreateOutput(java.lang.String name, java.lang.String argumentType, boolean isEscalationOnly)	Obtains the SectionOutput.
SubSection	getOrCreateSubSection(SectionInterfaceAnnotation sectionInterfaceAnnotation)	Obtains the SubSection.
protected java.lang.Class<?>	getSectionClass(java.lang.String sectionClassName)	Obtains the section class.
protected java.lang.String	getSectionClassName()	Obtains the name of the class for the section.
protected boolean	isIncludeManagedFunctionType(ManagedFunctionType<?,?> functionType)	Indicates if include ManagedFunctionType.
protected void	linkFunctionEscalation(SectionFunction function, ManagedFunctionType<?,?> functionType, ManagedFunctionEscalationType escalationType, SectionFunction escalationHandler)	Links the ManagedFunction escalation.
protected void	linkFunctionFlow(FunctionFlow functionFlow, ManagedFunctionType<?,?> functionType, FlowAnnotation flowAnnotation)	Links the FunctionFlow.
protected void	linkFunctionFlow(FunctionFlow functionFlow, ManagedFunctionType<?,?> functionType, SectionInterfaceAnnotation sectionInterfaceAnnotation)	Links the FunctionFlow.
protected void	linkFunctionObject(SectionFunction function, ManagedFunctionType<?,?> functionType, ManagedFunctionObjectType<?> objectType)	Links the FunctionObject.
protected void	linkNextFunction(SectionFunction function, ManagedFunctionType<?,?> functionType, NextAnnotation nextFunctionAnnotation)	Links the next ManagedFunction.
protected FunctionNamespaceType	loadFunctionNamespaceType(java.lang.String namespace, java.lang.Class<?> sectionClass)	Loads the FunctionNamespaceType.
protected AbstractFunctionSectionSource.ObjectForMethod	loadObjectForMethod(java.lang.Class<?> sectionClass)	Loads the SectionManagedObject for the Object for the Method.
protected void	loadSpecification(AbstractSectionSource.SpecificationContext context)	Loads the SectionSourceSpecification.
void	registerFunctionByTypeName(java.lang.String functionTypeName, SectionFunction function)	Allows being made aware of further SectionFunction instances within the section to be considered for linking flows.
void	sourceSection(SectionDesigner designer, SectionSourceContext context)	Sources the OfficeSection by constructing it via the input SectionDesigner.

Methods inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_OBJECT_NAME

public static final java.lang.String CLASS_OBJECT_NAME

Name of the SectionManagedObject for the section class.

See Also:

Constant Field Values

Constructor Detail

AbstractFunctionSectionSource

public AbstractFunctionSectionSource()

Method Detail

getDesigner

protected SectionDesigner getDesigner()

Obtains the SectionDesigner.

Returns:

SectionDesigner;

getContext

protected SectionSourceContext getContext()

Obtains the SectionSourceContext.

Returns:

SectionSourceContext.

getFunctionByName

public SectionFunction getFunctionByName(java.lang.String functionName)

Obtains the SectionFunction by its name.

Parameters:

functionName - Name of the SectionFunction.

Returns:

SectionFunction or null if no SectionFunction by the name.

getFunctionTypeByName

public ManagedFunctionType<?,?> getFunctionTypeByName(java.lang.String functionName)

Obtains the ManagedFunctionType for the SectionFunction by its name.

Parameters:

functionName - Name of the SectionFunction.

Returns:

ManagedFunctionType or null if no SectionFunction by the name.

getFunctionByTypeName

public SectionFunction getFunctionByTypeName(java.lang.String functionTypeName)

Obtains the SectionFunction by its ManagedFunctionType name.

Parameters:

functionTypeName - ManagedFunctionType name.

Returns:

SectionFunction or null if no SectionFunction by the ManagedFunctionType name.

registerFunctionByTypeName

public void registerFunctionByTypeName(java.lang.String functionTypeName,
                                       SectionFunction function)

Allows being made aware of further SectionFunction instances within the section to be considered for linking flows.

This allows ClassSectionSource to be used in conjunction with other functionality - such as template rendering for dynamic HTTP web pages.

Parameters:

functionTypeName - Name to register the SectionFunction.

function - SectionFunction.

getOrCreateObject

public SectionObject getOrCreateObject(java.lang.String qualifier,
                                       java.lang.String typeName)

Obtains the SectionObject.

Should the SectionObject not yet be added, it is added.

Parameters:

qualifier - Qualifier for the SectionObject. If not Qualifier should be the same as the type name.

typeName - Fully qualified type name of the SectionObject.

Returns:

SectionObject.

getManagedObject

public SectionManagedObject getManagedObject(java.lang.String typeName)

Obtains the SectionManagedObject for the type.

Parameters:

typeName - Fully qualified type name of the object for the SectionManagedObject.

Returns:

SectionManagedObject or null if no SectionManagedObject for the type.

getOrCreateInput

public SectionInput getOrCreateInput(java.lang.String name,
                                     java.lang.String argumentType)

Obtains the SectionInput.

Should the SectionInput not yet be added, it is added.

Parameters:

name - Name of the SectionInput.

argumentType - Type of the argument. May be null if no argument.

Returns:

SectionInput.

getOrCreateOutput

public SectionOutput getOrCreateOutput(java.lang.String name,
                                       java.lang.String argumentType,
                                       boolean isEscalationOnly)

Obtains the SectionOutput.

Should the SectionOutput not yet be added, it is added.

Parameters:

name - Name of the SectionOutput.

argumentType - Type of the argument. May be null if no argument.

isEscalationOnly - true if escalation only.

Returns:

SectionObject.

getOrCreateSubSection

public SubSection getOrCreateSubSection(SectionInterfaceAnnotation sectionInterfaceAnnotation)

Obtains the SubSection.

Should the SubSection not already be created, it is created.

Parameters:

sectionInterfaceAnnotation - SectionInterfaceAnnotation.

Returns:

SubSection.

getSectionClassName

protected java.lang.String getSectionClassName()

Obtains the name of the class for the section.

Returns:

Class name for the backing class of the section.

getSectionClass

protected java.lang.Class<?> getSectionClass(java.lang.String sectionClassName)
                                      throws java.lang.Exception

Obtains the section class.

Parameters:

sectionClassName - Name of the section class.

Returns:

Section class.

Throws:

java.lang.Exception - If fails to obtain the section class.

createClassManagedObject

protected SectionManagedObject createClassManagedObject(java.lang.String objectName,
                                                        java.lang.Class<?> sectionClass)

Creates the SectionManagedObject for providing the section object.

Parameters:

objectName - Name of the object within the section.

sectionClass - Section object class.

Returns:

SectionManagedObject.

extractClassManagedObjectDependencies

protected DependencyMetaData[] extractClassManagedObjectDependencies(java.lang.String objectName,
                                                                     java.lang.Class<?> sectionClass)
                                                              throws java.lang.Exception

Extracts the DependencyMetaData instances for the section object.

Parameters:

objectName - Name of the object within the section.

sectionClass - Section object class.

Returns:

Extracted DependencyMetaData instances for the section object.

Throws:

java.lang.Exception - If fails to extract the DependencyMetaData instances.

getFunctionName

protected java.lang.String getFunctionName(ManagedFunctionType<?,?> functionType)

Obtains the ManagedFunction name from the ManagedFunctionType.

Parameters:

functionType - ManagedFunctionType.

Returns:

ManagedFunction name.

enrichFunction

protected void enrichFunction(SectionFunction function,
                              ManagedFunctionType<?,?> functionType,
                              java.lang.Class<?> parameterType)

Enriches the ManagedFunction.

Parameters:

function - SectionFunction.

functionType - ManagedFunctionType for the SectionFunction.

parameterType - Parameter type for the SectionFunction. May be null if no parameter.

linkNextFunction

protected void linkNextFunction(SectionFunction function,
                                ManagedFunctionType<?,?> functionType,
                                NextAnnotation nextFunctionAnnotation)

Links the next ManagedFunction.

Parameters:

function - SectionFunction.

functionType - ManagedFunctionType.

nextFunctionAnnotation - NextAnnotation.

linkFunctionFlow

protected void linkFunctionFlow(FunctionFlow functionFlow,
                                ManagedFunctionType<?,?> functionType,
                                FlowAnnotation flowAnnotation)

Links the FunctionFlow.

Parameters:

functionFlow - FunctionFlow.

functionType - ManagedFunctionType.

flowAnnotation - FlowAnnotation.

linkFunctionFlow

protected void linkFunctionFlow(FunctionFlow functionFlow,
                                ManagedFunctionType<?,?> functionType,
                                SectionInterfaceAnnotation sectionInterfaceAnnotation)

Links the FunctionFlow.

Parameters:

functionFlow - FunctionFlow.

functionType - ManagedFunctionType.

sectionInterfaceAnnotation - SectionInterfaceAnnotation.

linkFunctionEscalation

protected void linkFunctionEscalation(SectionFunction function,
                                      ManagedFunctionType<?,?> functionType,
                                      ManagedFunctionEscalationType escalationType,
                                      SectionFunction escalationHandler)

Links the ManagedFunction escalation.

Parameters:

function - SectionFunction.

functionType - ManagedFunctionType.

escalationType - ManagedFunctionEscalationType.

escalationHandler - Potential SectionFunction that can handle escalation based on its parameter. May be null if no SectionFunction can handle the escalation.

linkFunctionObject

protected void linkFunctionObject(SectionFunction function,
                                  ManagedFunctionType<?,?> functionType,
                                  ManagedFunctionObjectType<?> objectType)

Links the FunctionObject.

Parameters:

function - SectionFunction.

functionType - ManagedFunctionType.

objectType - ManagedFunctionObjectType.

loadObjectForMethod

protected AbstractFunctionSectionSource.ObjectForMethod loadObjectForMethod(java.lang.Class<?> sectionClass)
                                                                     throws java.lang.Exception

Loads the SectionManagedObject for the Object for the Method.

Parameters:

sectionClass - Class of the Object.

Returns:

AbstractFunctionSectionSource.ObjectForMethod. May be null for no Object for Method.

Throws:

java.lang.Exception - If fails to load Object for the Method.

loadFunctionNamespaceType

protected FunctionNamespaceType loadFunctionNamespaceType(java.lang.String namespace,
                                                          java.lang.Class<?> sectionClass)

Loads the FunctionNamespaceType.

Parameters:

namespace - Namespace.

sectionClass - Section Class.

Returns:

FunctionNamespaceType.

adddSectionFunctionNamespace

protected SectionFunctionNamespace adddSectionFunctionNamespace(java.lang.String namespace,
                                                                java.lang.Class<?> sectionClass)

Adds the SectionFunctionNamespace.

Parameters:

namespace - Namespace.

sectionClass - Section Class.

Returns:

SectionFunctionNamespace.

isIncludeManagedFunctionType

protected boolean isIncludeManagedFunctionType(ManagedFunctionType<?,?> functionType)

Indicates if include ManagedFunctionType.

Parameters:

functionType - ManagedFunctionType.

Returns:

true include the ManagedFunctionType.

loadSpecification

protected void loadSpecification(AbstractSectionSource.SpecificationContext context)

Description copied from class: AbstractSectionSource

Loads the SectionSourceSpecification.

Specified by:

loadSpecification in class AbstractSectionSource

Parameters:

context - AbstractSectionSource.SpecificationContext.

sourceSection

public void sourceSection(SectionDesigner designer,
                          SectionSourceContext context)
                   throws java.lang.Exception

Description copied from interface: SectionSource

Sources the OfficeSection by constructing it via the input SectionDesigner.

Parameters:

designer - SectionDesigner to construct the structure of the OfficeSection.

context - SectionSourceContext to source details to construct the OfficeSection.

Throws:

java.lang.Exception - If fails to construct the OfficeSection.