org.apache.tiles.factory
Class TilesContainerFactory

Package class diagram package TilesContainerFactory
java.lang.Object
  extended by org.apache.tiles.factory.TilesContainerFactory
Direct Known Subclasses:
KeyedDefinitionsFactoryTilesContainerFactory

public class TilesContainerFactory
extends java.lang.Object

Factory provided for convenience. This factory creates a default implementation of the container, initializes, and puts it into service.

Since:
2.0

Field Summary
static java.lang.String CONTAINER_FACTORY_INIT_PARAM
           
static java.lang.String CONTAINER_FACTORY_MUTABLE_INIT_PARAM
           
static java.lang.String CONTEXT_FACTORY_INIT_PARAM
           
protected  java.util.Map<java.lang.String,java.lang.String> defaultConfiguration
           
static java.lang.String DEFINITIONS_FACTORY_INIT_PARAM
           
static java.lang.String PREPARER_FACTORY_INIT_PARAM
           
 
Constructor Summary
TilesContainerFactory()
           
 
Method Summary
 org.apache.tiles.TilesContainer createContainer(java.lang.Object context)
           
protected static java.lang.Object createFactory(java.util.Map<java.lang.String,java.lang.String> configuration, java.lang.String initParameterName)
           
 org.apache.tiles.mgmt.MutableTilesContainer createMutableTilesContainer(java.lang.Object context)
           
 org.apache.tiles.TilesContainer createTilesContainer(java.lang.Object context)
           
static TilesContainerFactory getFactory(java.lang.Object context)
          Retrieve a factory instance as configured through the specified context.
static TilesContainerFactory getFactory(java.lang.Object context, java.util.Map<java.lang.String,java.lang.String> defaults)
          Retrieve a factory instance as configured through the specified context.
protected static java.lang.String getInitParameter(java.lang.Object context, java.lang.String parameterName)
           
protected static java.util.Map<java.lang.String,java.lang.String> getInitParameterMap(java.lang.Object context)
           
protected  void initializeContainer(java.lang.Object context, BasicTilesContainer container)
           
protected static java.lang.String resolveFactoryName(java.util.Map<java.lang.String,java.lang.String> configuration, java.lang.String parameterName)
           
 void setDefaultConfiguration(java.util.Map<java.lang.String,java.lang.String> defaultConfiguration)
           
 void setDefaultValue(java.lang.String key, java.lang.String value)
           
protected  void storeContainerDependencies(java.lang.Object context, java.util.Map<java.lang.String,java.lang.String> initParameters, java.util.Map<java.lang.String,java.lang.String> configuration, BasicTilesContainer container)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTAINER_FACTORY_INIT_PARAM

public static final java.lang.String CONTAINER_FACTORY_INIT_PARAM
See Also:
Constant Field Values

CONTAINER_FACTORY_MUTABLE_INIT_PARAM

public static final java.lang.String CONTAINER_FACTORY_MUTABLE_INIT_PARAM
See Also:
Constant Field Values

CONTEXT_FACTORY_INIT_PARAM

public static final java.lang.String CONTEXT_FACTORY_INIT_PARAM
See Also:
Constant Field Values

DEFINITIONS_FACTORY_INIT_PARAM

public static final java.lang.String DEFINITIONS_FACTORY_INIT_PARAM
See Also:
Constant Field Values

PREPARER_FACTORY_INIT_PARAM

public static final java.lang.String PREPARER_FACTORY_INIT_PARAM
See Also:
Constant Field Values

defaultConfiguration

protected java.util.Map<java.lang.String,java.lang.String> defaultConfiguration
Constructor Detail

TilesContainerFactory

public TilesContainerFactory()
Method Detail

getFactory

public static TilesContainerFactory getFactory(java.lang.Object context)
                                        throws org.apache.tiles.TilesException
Retrieve a factory instance as configured through the specified context.

The context will be queried and if a init parameter named 'org.apache.tiles.CONTAINER_FACTORY' is discovered this class will be instantiated and returned. Otherwise, the factory will attempt to utilize one of it's internal factories.

Parameters:
context - the executing applications context. Typically a ServletContext or PortletContext
Returns:
a tiles container
Throws:
org.apache.tiles.TilesException - if an error occurs creating the factory.

getFactory

public static TilesContainerFactory getFactory(java.lang.Object context,
                                               java.util.Map<java.lang.String,java.lang.String> defaults)
                                        throws org.apache.tiles.TilesException
Retrieve a factory instance as configured through the specified context.

The context will be queried and if a init parameter named 'org.apache.tiles.CONTAINER_FACTORY' is discovered this class will be instantiated and returned. Otherwise, the factory will attempt to utilize one of it's internal factories.

Parameters:
context - the executing applications context. Typically a ServletContext or PortletContext
Returns:
a tiles container
Throws:
org.apache.tiles.TilesException - if an error occurs creating the factory.

createContainer

public org.apache.tiles.TilesContainer createContainer(java.lang.Object context)
                                                throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

setDefaultConfiguration

public void setDefaultConfiguration(java.util.Map<java.lang.String,java.lang.String> defaultConfiguration)

setDefaultValue

public void setDefaultValue(java.lang.String key,
                            java.lang.String value)

createTilesContainer

public org.apache.tiles.TilesContainer createTilesContainer(java.lang.Object context)
                                                     throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

createMutableTilesContainer

public org.apache.tiles.mgmt.MutableTilesContainer createMutableTilesContainer(java.lang.Object context)
                                                                        throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

initializeContainer

protected void initializeContainer(java.lang.Object context,
                                   BasicTilesContainer container)
                            throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

storeContainerDependencies

protected void storeContainerDependencies(java.lang.Object context,
                                          java.util.Map<java.lang.String,java.lang.String> initParameters,
                                          java.util.Map<java.lang.String,java.lang.String> configuration,
                                          BasicTilesContainer container)
                                   throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

createFactory

protected static java.lang.Object createFactory(java.util.Map<java.lang.String,java.lang.String> configuration,
                                                java.lang.String initParameterName)
                                         throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

resolveFactoryName

protected static java.lang.String resolveFactoryName(java.util.Map<java.lang.String,java.lang.String> configuration,
                                                     java.lang.String parameterName)
                                              throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

getInitParameter

protected static java.lang.String getInitParameter(java.lang.Object context,
                                                   java.lang.String parameterName)
                                            throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException

getInitParameterMap

protected static java.util.Map<java.lang.String,java.lang.String> getInitParameterMap(java.lang.Object context)
                                                                               throws org.apache.tiles.TilesException
Throws:
org.apache.tiles.TilesException