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
FieldsModifier and TypeFieldDescriptionstatic final StringName of thePropertyfor the location of theSectionSourceto transform.static final Stringstatic final Stringstatic final StringName of theSubSectionbeing transformed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidconfigureProperties(OfficeSectionTransformerContext context, PropertyList properties) Enables overriding to configure additionalPropertyinstances.protected final SectionSourceContextObtains theSectionSourceContext.protected final TransformSectionDesignerObtains theTransformSectionDesignerto configure the transformedSectionSource.protected voidLoads further enhancements.protected voidloadSectionInput(SectionInputType inputType) Loads theSectionInput.protected voidloadSectionObject(SectionObjectType objectType) Loads theSectionObject.protected voidloadSectionOutput(SectionOutputType outputType) Loads theSectionOutput.protected voidLoads theSectionSourceSpecification.protected voidloadSubSection(String sectionSourceClassName, String sectionLocation, PropertyList properties) Loads theSectionSource.voidsourceSection(SectionDesigner designer, SectionSourceContext context) Sources theOfficeSectionby constructing it via the inputSectionDesigner.voidTransforms theOfficeSection.Methods inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource
getSpecification
-
Field Details
-
PROPERTY_SECTION_SOURCE_CLASS_NAME
- See Also:
-
PROPERTY_SECTION_LOCATION
Name of thePropertyfor the location of theSectionSourceto transform.- See Also:
-
PROPERTY_SECTION_PROPERTY_PREFIX
- See Also:
-
SUB_SECTION_NAME
Name of theSubSectionbeing transformed.- See Also:
-
-
Constructor Details
-
TransformSectionSource
public TransformSectionSource()
-
-
Method Details
-
getDesginer
Obtains theTransformSectionDesignerto configure the transformedSectionSource.- Returns:
TransformSectionDesigner.
-
getContext
Obtains theSectionSourceContext.- Returns:
SectionSourceContext.
-
loadSubSection
protected void loadSubSection(String sectionSourceClassName, String sectionLocation, PropertyList properties) throws Exception Loads the
SectionSource.Override to alter the
SectionSource.- Parameters:
sectionSourceClassName-SectionSourceclass name.sectionLocation-SectionSourcelocation.properties-PropertyListfor theSectionSource.- Throws:
Exception- If fails to load the wrappedSubSection.
-
loadSectionInput
Loads the
SectionInput.Override to alter
SectionInputinstances.- Parameters:
inputType-SectionInputType.- Throws:
Exception- If fails to load theSectionInput.
-
loadSectionOutput
Loads the
SectionOutput.Override to alter
SectionOutputinstances.- Parameters:
outputType-SectionOutputType.- Throws:
Exception- If fails to load theSectionOutput.
-
loadSectionObject
Loads the
SectionObject.Override to alter
SectionObjectinstances.- Parameters:
objectType-SectionObjectType.- Throws:
Exception- If fails to laod theSectionObject.
-
loadEnhancements
Loads further enhancements.
Override to load further enhancements.
- Throws:
Exception- If fails to load enhancements.
-
transformOfficeSection
Description copied from interface:OfficeSectionTransformerTransforms theOfficeSection.- Specified by:
transformOfficeSectionin interfaceOfficeSectionTransformer- Parameters:
context-OfficeSectionTransformerContext.
-
configureProperties
protected void configureProperties(OfficeSectionTransformerContext context, PropertyList properties) Enables overriding to configure additionalPropertyinstances.- Parameters:
context-OfficeSectionTransformerContext.properties-PropertyListto load additionalPropertyinstances.
-
loadSpecification
Description copied from class:AbstractSectionSourceLoads theSectionSourceSpecification.- Specified by:
loadSpecificationin classAbstractSectionSource- Parameters:
context-AbstractSectionSource.SpecificationContext.
-
sourceSection
Description copied from interface:SectionSourceSources theOfficeSectionby constructing it via the inputSectionDesigner.- Specified by:
sourceSectionin interfaceSectionSource- Parameters:
designer-SectionDesignerto construct the structure of theOfficeSection.context-SectionSourceContextto source details to construct theOfficeSection.- Throws:
Exception- If fails to construct theOfficeSection.
-