org.fujion.ancillary

Class ComponentFactory

java.lang.Object

org.fujion.ancillary.ComponentFactory

public class ComponentFactory
extends Object

Factory used during component deserialization. Factory parameters may be modified during deserialization to provide control over component creation.

Constructor Summary

Constructors

Constructor and Description
ComponentFactory(ComponentDefinition def)

Method Summary

Modifier and Type	Method and Description
List<BaseComponent>	create(Map<String,String> attributes, ELContext elContext) Creates one or more component instances from the component definition using a factory context.
protected void	setCase(Object caseVal) Specifies the value for matching a switch statement.
protected void	setForEach(Object forEach) Sets an iterable which will be used to produce one component for each value returned by the iterable.
protected void	setForVar(String forVar) Sets the attribute name to use in foreach iteration.
protected void	setIf(boolean condition) Conditionally prevents the factory from creating a component.
protected void	setImplementationClass(Class<? extends BaseComponent> clazz) A special processor may modify the component's implementation class, as long as the substituted class is a subclass of the original.
protected void	setSwitch(Object switchVal) Specifies the value for a switch statement.
protected void	setUnless(boolean condition) Conditionally prevents the factory from creating a component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentFactory

public ComponentFactory(ComponentDefinition def)

Method Detail

setImplementationClass

@Component.FactoryParameter(value="impl",
                            description="Component implementation class to substitute.")
protected void setImplementationClass(Class<? extends BaseComponent> clazz)

A special processor may modify the component's implementation class, as long as the substituted class is a subclass of the original.

Parameters:

clazz - Component implementation class to substitute.

setIf

@Component.FactoryParameter(value="if",
                            description="If false, prevent component creation.")
protected void setIf(boolean condition)

Conditionally prevents the factory from creating a component.

Parameters:

condition - If false, prevent factory from creating a component.

setUnless

@Component.FactoryParameter(value="unless",
                            description="If true, prevent component creation.")
protected void setUnless(boolean condition)

Conditionally prevents the factory from creating a component.

Parameters:

condition - If true, prevent factory from creating a component.

setForEach

@Component.FactoryParameter(value="foreach",
                            description="Specifies a collection for iterative component creation.")
protected void setForEach(Object forEach)

Sets an iterable which will be used to produce one component for each value returned by the iterable. Components produced by an iterable will contain an attribute named "each" (unless overridden by forvar) that may be referenced to retrieve the value of the associated iterable element.

Parameters:

forEach - An object that will be converted to an iterable. See convertToITerable for supported types.

setForVar

@Component.FactoryParameter(value="forvar",
                            defaultValue="each",
                            description="Specifies the attribute name used in foreach.")
protected void setForVar(String forVar)

Sets the attribute name to use in foreach iteration.

Parameters:

forVar - Name of attribute to use in foreach iteration.

setSwitch

@Component.FactoryParameter(value="switch",
                            description="Specifies the value for a switch statement.")
protected void setSwitch(Object switchVal)

Specifies the value for a switch statement.

Parameters:

switchVal - Value for a switch statement.

setCase

@Component.FactoryParameter(value="case",
                            description="Specifies the value for matching a switch statement.")
protected void setCase(Object caseVal)

Specifies the value for matching a switch statement.

Parameters:

caseVal - Value for matching a switch statement.

create

public List<BaseComponent> create(Map<String,String> attributes,
                                  ELContext elContext)

Creates one or more component instances from the component definition using a factory context.

Parameters:

attributes - Attribute map for initializing.

elContext - Evaluation context for EL expressions.

Returns:

A list of newly created components (never null).