Package net.officefloor.compile.spi.section.source

Interface SectionSourceContext

All Superinterfaces:

ConfigurationContext, SourceContext, SourceProperties

All Known Implementing Classes:

SectionSourceContextImpl

public interface SectionSourceContext
extends SourceContext, ConfigurationContext

Context for loading a SectionType.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.configuration.ConfigurationContext

DEFAULT_TAG_PREFIX, DEFAULT_TAG_SUFFIX, PROPERTY_CONFIGURATION_INPUT_CHARSET, PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX, PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX, PROPERTY_CONFIGURATION_OUTPUT_CHARSET

Method Summary

Modifier and Type	Method	Description
PropertyList	createPropertyList()	Creates a PropertyList for loading types.
java.lang.String	getSectionLocation()	Obtains the location of the OfficeSection.
FunctionNamespaceType	loadManagedFunctionType(java.lang.String functionNamespace, java.lang.String managedFunctionSourceClassName, PropertyList properties)	Loads the FunctionNamespaceType.
FunctionNamespaceType	loadManagedFunctionType(java.lang.String functionNamespace, ManagedFunctionSource managedFunctionSource, PropertyList properties)	Loads the FunctionNamespaceType.
ManagedObjectType<?>	loadManagedObjectType(java.lang.String managedObjectSourceName, java.lang.String managedObjectSourceClassName, PropertyList properties)	Loads the ManagedObjectType.
ManagedObjectType<?>	loadManagedObjectType(java.lang.String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource, PropertyList properties)	Loads the ManagedObjectType.
SectionType	loadSectionType(java.lang.String sectionName, java.lang.String sectionSourceClassName, java.lang.String location, PropertyList properties)	Loads the SectionType.
SectionType	loadSectionType(java.lang.String sectionName, SectionSource sectionSource, java.lang.String location, PropertyList properties)	Loads the SectionType.

Methods inherited from interface net.officefloor.configuration.ConfigurationContext

getConfigurationItem, getOptionalConfigurationItem

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

getSectionLocation

java.lang.String getSectionLocation()

Obtains the location of the OfficeSection.

How "location" is interpreted is for the SectionSource.

Returns:

Location of the OfficeSection.

createPropertyList

PropertyList createPropertyList()

Creates a PropertyList for loading types.

Returns:

New PropertyList to aid in loading types.

loadManagedFunctionType

FunctionNamespaceType loadManagedFunctionType(java.lang.String functionNamespace,
                                              ManagedFunctionSource managedFunctionSource,
                                              PropertyList properties)

Loads the FunctionNamespaceType.

This is to enable obtaining the type information for the ManagedFunctionSource to allow reflective configuration by the SectionSource.

Parameters:

functionNamespace - Name space of the ManagedFunctionSource.

managedFunctionSource - ManagedFunctionSource.

properties - PropertyList to configure the implementing ManagedFunctionSource.

Returns:

FunctionNamespaceType or null if fails to load the FunctionNamespaceType.

loadManagedFunctionType

FunctionNamespaceType loadManagedFunctionType(java.lang.String functionNamespace,
                                              java.lang.String managedFunctionSourceClassName,
                                              PropertyList properties)

Loads the FunctionNamespaceType.

This is to enable obtaining the type information for the ManagedFunctionSource to allow reflective configuration by the SectionSource.

Parameters:

functionNamespace - Name space of the ManagedFunctionSource.

managedFunctionSourceClassName - Name of the implementing ManagedFunctionSource class. May also be an alias.

properties - PropertyList to configure the implementing ManagedFunctionSource.

Returns:

FunctionNamespaceType or null if fails to load the FunctionNamespaceType.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(java.lang.String managedObjectSourceName,
                                           ManagedObjectSource<?,?> managedObjectSource,
                                           PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the SectionSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(java.lang.String managedObjectSourceName,
                                           java.lang.String managedObjectSourceClassName,
                                           PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the SectionSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClassName - Name of the implementing ManagedObjectSource class. May also be an alias.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadSectionType

SectionType loadSectionType(java.lang.String sectionName,
                            SectionSource sectionSource,
                            java.lang.String location,
                            PropertyList properties)

Loads the SectionType.

This is to enable obtaining the type information for the SubSection to allow reflective configuration by the SectionSource.

Parameters:

sectionName - Name of the SubSection.

sectionSource - SectionSource.

location - Location of the SubSection.

properties - PropertyList to configure the SectionSource.

Returns:

SectionType or null if fails to load the SectionType.

loadSectionType

SectionType loadSectionType(java.lang.String sectionName,
                            java.lang.String sectionSourceClassName,
                            java.lang.String location,
                            PropertyList properties)

Loads the SectionType.

This is to enable obtaining the type information for the SubSection to allow reflective configuration by the SectionSource.

Parameters:

sectionName - Name of the SubSection.

sectionSourceClassName - Name of the implementing SectionSource class. May also be an alias.

location - Location of the SubSection.

properties - PropertyList to configure the SectionSource.

Returns:

SectionType or null if fails to load the SectionType.