Package net.officefloor.plugin.section.transform

Class TransformSectionSource

java.lang.Object

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

net.officefloor.plugin.section.transform.TransformSectionSource

All Implemented Interfaces:

OfficeSectionTransformer, SectionSource

@PrivateSource
public class TransformSectionSource
extends AbstractSectionSource
implements OfficeSectionTransformer

Enables transforming a SectionSource.

Author:

Daniel Sagenschneider

Nested Class Summary

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_SECTION_LOCATION	Name of the Property for the location of the SectionSource to transform.
static java.lang.String	PROPERTY_SECTION_PROPERTY_PREFIX	Prefix on the Property name for the Property instances of the SectionSource to transform.
static java.lang.String	PROPERTY_SECTION_SOURCE_CLASS_NAME	Name of the Property for the Class name of the SectionSource to transform.
static java.lang.String	SUB_SECTION_NAME	Name of the SubSection being transformed.

Constructor Summary

Constructors

Constructor	Description
TransformSectionSource()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties(OfficeSectionTransformerContext context, PropertyList properties)	Enables overriding to configure additional Property instances.
protected SectionSourceContext	getContext()	Obtains the SectionSourceContext.
protected TransformSectionDesigner	getDesginer()	Obtains the TransformSectionDesigner to configure the transformed SectionSource.
protected void	loadEnhancements()	Loads further enhancements.
protected void	loadSectionInput(SectionInputType inputType)	Loads the SectionInput.
protected void	loadSectionObject(SectionObjectType objectType)	Loads the SectionObject.
protected void	loadSectionOutput(SectionOutputType outputType)	Loads the SectionOutput.
protected void	loadSpecification(AbstractSectionSource.SpecificationContext context)	Loads the SectionSourceSpecification.
protected void	loadSubSection(java.lang.String sectionSourceClassName, java.lang.String sectionLocation, PropertyList properties)	Loads the SectionSource.
void	sourceSection(SectionDesigner designer, SectionSourceContext context)	Sources the OfficeSection by constructing it via the input SectionDesigner.
void	transformOfficeSection(OfficeSectionTransformerContext context)	Transforms the OfficeSection.

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_SECTION_SOURCE_CLASS_NAME

public static final java.lang.String PROPERTY_SECTION_SOURCE_CLASS_NAME

Name of the Property for the Class name of the SectionSource to transform.

See Also:

Constant Field Values

PROPERTY_SECTION_LOCATION

public static final java.lang.String PROPERTY_SECTION_LOCATION

Name of the Property for the location of the SectionSource to transform.

See Also:

Constant Field Values

PROPERTY_SECTION_PROPERTY_PREFIX

public static final java.lang.String PROPERTY_SECTION_PROPERTY_PREFIX

Prefix on the Property name for the Property instances of the SectionSource to transform.

See Also:

Constant Field Values

SUB_SECTION_NAME

public static final java.lang.String SUB_SECTION_NAME

Name of the SubSection being transformed.

See Also:

Constant Field Values

Constructor Detail

TransformSectionSource

public TransformSectionSource()

Method Detail

getDesginer

protected final TransformSectionDesigner getDesginer()

Obtains the TransformSectionDesigner to configure the transformed SectionSource.

Returns:

TransformSectionDesigner.

getContext

protected final SectionSourceContext getContext()

Obtains the SectionSourceContext.

Returns:

SectionSourceContext.

loadSubSection

protected void loadSubSection(java.lang.String sectionSourceClassName,
                              java.lang.String sectionLocation,
                              PropertyList properties)
                       throws java.lang.Exception

Loads the SectionSource.

Override to alter the SectionSource.

Parameters:

sectionSourceClassName - SectionSource class name.

sectionLocation - SectionSource location.

properties - PropertyList for the SectionSource.

Throws:

java.lang.Exception - If fails to load the wrapped SubSection.

loadSectionInput

protected void loadSectionInput(SectionInputType inputType)
                         throws java.lang.Exception

Loads the SectionInput.

Override to alter SectionInput instances.

Parameters:

inputType - SectionInputType.

Throws:

java.lang.Exception - If fails to load the SectionInput.

loadSectionOutput

protected void loadSectionOutput(SectionOutputType outputType)
                          throws java.lang.Exception

Loads the SectionOutput.

Override to alter SectionOutput instances.

Parameters:

outputType - SectionOutputType.

Throws:

java.lang.Exception - If fails to load the SectionOutput.

loadSectionObject

protected void loadSectionObject(SectionObjectType objectType)
                          throws java.lang.Exception

Loads the SectionObject.

Override to alter SectionObject instances.

Parameters:

objectType - SectionObjectType.

Throws:

java.lang.Exception - If fails to laod the SectionObject.

loadEnhancements

protected void loadEnhancements()
                         throws java.lang.Exception

Loads further enhancements.

Override to load further enhancements.

Throws:

java.lang.Exception - If fails to load enhancements.

transformOfficeSection

public void transformOfficeSection(OfficeSectionTransformerContext context)

Description copied from interface: OfficeSectionTransformer

Transforms the OfficeSection.

Specified by:

transformOfficeSection in interface OfficeSectionTransformer

Parameters:

context - OfficeSectionTransformerContext.

configureProperties

protected void configureProperties(OfficeSectionTransformerContext context,
                                   PropertyList properties)

Enables overriding to configure additional Property instances.

Parameters:

context - OfficeSectionTransformerContext.

properties - PropertyList to load additional Property instances.

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.

Specified by:

sourceSection in interface SectionSource

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.