Package net.officefloor.activity.compose.build

Class ComposeEmployer.ComposeArchitectImpl

java.lang.Object

net.officefloor.activity.compose.build.ComposeEmployer.ComposeArchitectImpl

All Implemented Interfaces:

ComposeArchitect

Enclosing class:

ComposeEmployer

protected static class ComposeEmployer.ComposeArchitectImpl
extends Object
implements ComposeArchitect

Implementation of ComposeArchitect.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComposeArchitectImpl(OfficeArchitect architect, OfficeSourceContext sourceContext)	Instantiate.

Method Summary

Modifier and Type	Method	Description
protected <C extends ComposeConfiguration, T> T	addComposition(String namespace, String itemName, ComposeSource<T,C> source, String resourceName, PropertyList properties, Class<C> configurationClass)	Adds a composition.
<C extends ComposeConfiguration, T> T	addComposition(String sectionName, ComposeSource<T,C> source, String resourceName, PropertyList properties, Class<C> configurationClass)	Builds the item requiring composition.
<T> void	addCompositions(String namespace, DirectoryItemComposer<T> composer, String resourceDirectory, PropertyList properties, ComposeListener<T> listener)	Builds a directory of items requiring composition.
void	addGovernance(String governanceName, OfficeGovernance goverance)	Adds OfficeGovernance for the composition.
void	addInput(String inputName, OfficeSectionInput input)	Adds OfficeSectionInput that will be available to link in composition via #inputName.
boolean	isCompositionsAvailable(String resourceDirectory, Predicate<String> itemNameFilter)	Determines if compositions are available in the resource directory.

Methods inherited from class java.lang.Object

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

Constructor Details

ComposeArchitectImpl

protected ComposeArchitectImpl(OfficeArchitect architect,
 OfficeSourceContext sourceContext)

Instantiate.

Parameters:

architect - OfficeArchitect.

sourceContext - OfficeSourceContext.

Method Details

addInput

public void addInput(String inputName,
 OfficeSectionInput input)

Description copied from interface: ComposeArchitect

Adds OfficeSectionInput that will be available to link in composition via #inputName.

Specified by:

addInput in interface ComposeArchitect

Parameters:

inputName - Name for input in composition.

input - OfficeSectionInput.

addGovernance

public void addGovernance(String governanceName,
 OfficeGovernance goverance)

Description copied from interface: ComposeArchitect

Adds OfficeGovernance for the composition.

Specified by:

addGovernance in interface ComposeArchitect

Parameters:

governanceName - Name used in composition for the OfficeGovernance.

goverance - OfficeGovernance.

addComposition

public <C extends ComposeConfiguration,
T> T addComposition(String sectionName,
 ComposeSource<T,C> source,
 String resourceName,
 PropertyList properties,
 Class<C> configurationClass)
                                                    throws Exception

Description copied from interface: ComposeArchitect

Builds the item requiring composition.

Specified by:

addComposition in interface ComposeArchitect

Type Parameters:

C - Configuration type.

T - Built item type.

Parameters:

sectionName - Name of the OfficeSection to contain the composition.

source - ComposeSource to source the item requiring composition.

resourceName - Name of resource defining the composition.

properties - PropertyList to configure the composition.

configurationClass - Class extending ComposeConfiguration to provide additional configuration for the item being built.

Returns:

Built item.

Throws:

Exception - If fails to build item.

isCompositionsAvailable

public boolean isCompositionsAvailable(String resourceDirectory,
 Predicate<String> itemNameFilter)
                                throws Exception

Description copied from interface: ComposeArchitect

Determines if compositions are available in the resource directory.

Specified by:

isCompositionsAvailable in interface ComposeArchitect

Parameters:

resourceDirectory - Name of directory containing the compositions.

itemNameFilter - Predicate to filter item names (file name minus extension). Only items whose name passes the filter are considered.

Returns:

true if at least one matching composition is available.

Throws:

Exception - If fails to check for compositions.

addCompositions

public <T> void addCompositions(String namespace,
 DirectoryItemComposer<T> composer,
 String resourceDirectory,
 PropertyList properties,
 ComposeListener<T> listener)
                         throws Exception

Description copied from interface: ComposeArchitect

Builds a directory of items requiring composition.

Specified by:

addCompositions in interface ComposeArchitect

Type Parameters:

T - Build item type.

Parameters:

namespace - Namespace to isolate the compositions (SectionSource) instances from other compositions.

composer - DirectoryItemComposer to source the items requiring composition.

resourceDirectory - Name of directory containing the compositions.

properties - PropertyList to configure the compositions.

listener - ComposeListener to receive the built items.

Throws:

Exception - If fails to build the items.

addComposition

protected <C extends ComposeConfiguration,
T> T addComposition(String namespace,
 String itemName,
 ComposeSource<T,C> source,
 String resourceName,
 PropertyList properties,
 Class<C> configurationClass)
                                                       throws Exception

Adds a composition.

Type Parameters:

C - Configuration type.

T - Composition result type.

Parameters:

namespace - Namespace for the composition.

itemName - Name of the item.

source - ComposeSource.

resourceName - Name of the resource.

properties - PropertyList.

configurationClass - Class of the configuration.

Returns:

Composition result.

Throws:

Exception - If fails to add composition.