Package net.officefloor.polyglot.script

Class AbstractScriptFunctionSectionSource

java.lang.Object

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

net.officefloor.plugin.section.clazz.AbstractFunctionSectionSource

net.officefloor.polyglot.script.AbstractScriptFunctionSectionSource

All Implemented Interfaces:

SectionSource

Direct Known Subclasses:

JavaScriptFunctionSectionSource

public abstract class AbstractScriptFunctionSectionSource
extends AbstractFunctionSectionSource

Abstract script function SectionSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractScriptFunctionSectionSource.ScriptSection	Script section Class.

Nested classes/interfaces inherited from class net.officefloor.plugin.section.clazz.AbstractFunctionSectionSource

AbstractFunctionSectionSource.ObjectForMethod

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	PROPERTY_ENGINE_NAME	Property name for the ScriptEngine name.
static java.lang.String	PROPERTY_FUNCTION_NAME	Property name for the Script function name.

Fields inherited from class net.officefloor.plugin.section.clazz.AbstractFunctionSectionSource

CLASS_OBJECT_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractScriptFunctionSectionSource()

Method Summary

Modifier and Type	Method	Description
protected SectionFunctionNamespace	adddSectionFunctionNamespace(java.lang.String namespace, java.lang.Class<?> sectionClass)	Adds the SectionFunctionNamespace.
protected abstract java.lang.String	getMetaDataScriptPath(SourceContext context)	Obtains the path to the script that extracts the function meta-data.
protected abstract java.lang.String	getScriptEngineName(SourceContext context)	Obtains the name of the ScriptEngine.
protected ScriptExceptionTranslator	getScriptExceptionTranslator()	Obtains the ScriptExceptionTranslator.
protected java.lang.Class<?>	getSectionClass(java.lang.String sectionClassName)	Obtains the section class.
protected java.lang.String	getSetupScriptPath(SourceContext context)	Obtains the path to the setup script.
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.

Methods inherited from class net.officefloor.plugin.section.clazz.AbstractFunctionSectionSource

createClassManagedObject, enrichFunction, extractClassManagedObjectDependencies, getContext, getDesigner, getFunctionByName, getFunctionByTypeName, getFunctionName, getFunctionTypeByName, getManagedObject, getOrCreateInput, getOrCreateObject, getOrCreateOutput, getOrCreateSubSection, getSectionClassName, isIncludeManagedFunctionType, linkFunctionEscalation, linkFunctionFlow, linkFunctionFlow, linkFunctionObject, linkNextFunction, loadSpecification, registerFunctionByTypeName, sourceSection

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

PROPERTY_ENGINE_NAME

public static final java.lang.String PROPERTY_ENGINE_NAME

Property name for the ScriptEngine name.

See Also:

Constant Field Values

PROPERTY_FUNCTION_NAME

public static final java.lang.String PROPERTY_FUNCTION_NAME

Property name for the Script function name.

See Also:

Constant Field Values

Constructor Detail

AbstractScriptFunctionSectionSource

public AbstractScriptFunctionSectionSource()

Method Detail

getScriptEngineName

protected abstract java.lang.String getScriptEngineName(SourceContext context)
                                                 throws java.lang.Exception

Obtains the name of the ScriptEngine.

Parameters:

context - SourceContext.

Returns:

Name of the ScriptEngine.

Throws:

java.lang.Exception - If fails to obtain the name of the ScriptEngine.

getSetupScriptPath

protected java.lang.String getSetupScriptPath(SourceContext context)
                                       throws java.lang.Exception

Obtains the path to the setup script.

Parameters:

context - SourceContext.

Returns:

Path to the setup script or null if no setup.

Throws:

java.lang.Exception - If fails to obtain the setup script path.

getMetaDataScriptPath

protected abstract java.lang.String getMetaDataScriptPath(SourceContext context)
                                                   throws java.lang.Exception

Obtains the path to the script that extracts the function meta-data.

Parameters:

context - SourceContext.

Returns:

Path to the script that extracts the function meta-data.

Throws:

java.lang.Exception - If fails to obtain the path to the function meta-data script.

getScriptExceptionTranslator

protected ScriptExceptionTranslator getScriptExceptionTranslator()

Obtains the ScriptExceptionTranslator.

Returns:

ScriptExceptionTranslator.

getSectionClass

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

Description copied from class: AbstractFunctionSectionSource

Obtains the section class.

Overrides:

getSectionClass in class AbstractFunctionSectionSource

Parameters:

sectionClassName - Name of the section class.

Returns:

Section class.

Throws:

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

loadObjectForMethod

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

Description copied from class: AbstractFunctionSectionSource

Loads the SectionManagedObject for the Object for the Method.

Overrides:

loadObjectForMethod in class AbstractFunctionSectionSource

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)

Description copied from class: AbstractFunctionSectionSource

Loads the FunctionNamespaceType.

Overrides:

loadFunctionNamespaceType in class AbstractFunctionSectionSource

Parameters:

namespace - Namespace.

sectionClass - Section Class.

Returns:

FunctionNamespaceType.

adddSectionFunctionNamespace

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

Description copied from class: AbstractFunctionSectionSource

Adds the SectionFunctionNamespace.

Overrides:

adddSectionFunctionNamespace in class AbstractFunctionSectionSource

Parameters:

namespace - Namespace.

sectionClass - Section Class.

Returns:

SectionFunctionNamespace.