org.apache.tiles.factory
Class BasicTilesContainerFactory

Package class diagram package BasicTilesContainerFactory
java.lang.Object
  extended by org.apache.tiles.factory.AbstractTilesContainerFactory
      extended by org.apache.tiles.factory.BasicTilesContainerFactory
Direct Known Subclasses:
CompleteAutoloadTilesContainerFactory

public class BasicTilesContainerFactory
extends AbstractTilesContainerFactory

Factory that builds a standard Tiles container using only Java code.

Since:
2.1.0
Version:
$Rev: 1310865 $ $Date: 2012-04-07 17:01:22 -0400 (Sat, 07 Apr 2012) $

Field Summary
protected static String DEFINITION_RENDERER_NAME
          The definition renderer name.
protected static String STRING_RENDERER_NAME
          The string renderer name.
protected static String TEMPLATE_RENDERER_NAME
          The template renderer name.
 
Fields inherited from class org.apache.tiles.factory.AbstractTilesContainerFactory
CONTAINER_FACTORY_INIT_PARAM
 
Constructor Summary
BasicTilesContainerFactory()
           
 
Method Summary
protected  AttributeEvaluatorFactory createAttributeEvaluatorFactory(org.apache.tiles.request.ApplicationContext applicationContext, LocaleResolver resolver)
          Creates the attribute evaluator factory to use.
 TilesContainer createContainer(org.apache.tiles.request.ApplicationContext applicationContext)
          Creates a Tiles container.
protected  TilesContainer createDecoratedContainer(TilesContainer originalContainer, org.apache.tiles.request.ApplicationContext context)
          Instantiate the container that will be injected to child objects.
protected  org.apache.tiles.request.render.Renderer createDefaultAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory, org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Creates the default attribute renderer.
protected  org.apache.tiles.request.render.Renderer createDefinitionAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory, org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Creates a AttributeRenderer using a DefinitionRenderer.
protected  DefinitionsFactory createDefinitionsFactory(org.apache.tiles.request.ApplicationContext applicationContext, LocaleResolver resolver)
          Creates the definitions factory.
protected  DefinitionsReader createDefinitionsReader(org.apache.tiles.request.ApplicationContext applicationContext)
          Creates the definitions reader.
protected  DefinitionDAO<Locale> createLocaleDefinitionDao(org.apache.tiles.request.ApplicationContext applicationContext, LocaleResolver resolver)
          Creates a Locale-based definition DAO.
protected  LocaleResolver createLocaleResolver(org.apache.tiles.request.ApplicationContext applicationContext)
          Creates the locale resolver.
protected
<T> PatternDefinitionResolver<T>
createPatternDefinitionResolver(Class<T> customizationKeyClass)
          Creates a new pattern definition resolver.
protected  PreparerFactory createPreparerFactory(org.apache.tiles.request.ApplicationContext applicationContext)
          Creates the preparer factory to use.
protected  org.apache.tiles.request.render.RendererFactory createRendererFactory(org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Creates a renderer factory.
protected  org.apache.tiles.request.render.Renderer createStringAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory, org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Creates an attribute renderer to render strings.
protected  org.apache.tiles.request.render.Renderer createTemplateAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory, org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Creates a AttributeRenderer that uses a DispatchRenderer.
protected  List<org.apache.tiles.request.ApplicationResource> getSources(org.apache.tiles.request.ApplicationContext applicationContext)
          Returns a list containing the resources to be parsed.
protected  BasicTilesContainer instantiateContainer(org.apache.tiles.request.ApplicationContext context)
          Instantiate the container, without initialization.
protected  UnresolvingLocaleDefinitionsFactory instantiateDefinitionsFactory(org.apache.tiles.request.ApplicationContext applicationContext, LocaleResolver resolver)
          Instantiate a new definitions factory based on Locale.
protected  BaseLocaleUrlDefinitionDAO instantiateLocaleDefinitionDao(org.apache.tiles.request.ApplicationContext applicationContext, LocaleResolver resolver)
          Instantiate (and does not initialize) a Locale-based definition DAO.
protected  void registerAttributeRenderers(org.apache.tiles.request.render.BasicRendererFactory rendererFactory, org.apache.tiles.request.ApplicationContext applicationContext, TilesContainer container, AttributeEvaluatorFactory attributeEvaluatorFactory)
          Registers attribute renderers in a BasicRendererFactory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STRING_RENDERER_NAME

protected static final String STRING_RENDERER_NAME
The string renderer name.

See Also:
Constant Field Values

TEMPLATE_RENDERER_NAME

protected static final String TEMPLATE_RENDERER_NAME
The template renderer name.

See Also:
Constant Field Values

DEFINITION_RENDERER_NAME

protected static final String DEFINITION_RENDERER_NAME
The definition renderer name.

See Also:
Constant Field Values
Constructor Detail

BasicTilesContainerFactory

public BasicTilesContainerFactory()
Method Detail

createContainer

public TilesContainer createContainer(org.apache.tiles.request.ApplicationContext applicationContext)
Creates a Tiles container.

Specified by:
createContainer in class AbstractTilesContainerFactory
Parameters:
applicationContext - The Tiles application context object.
Returns:
The created container.

instantiateContainer

protected BasicTilesContainer instantiateContainer(org.apache.tiles.request.ApplicationContext context)
Instantiate the container, without initialization.

Parameters:
context - The Tiles application context object.
Returns:
The instantiated container.
Since:
2.1.1

createDecoratedContainer

protected TilesContainer createDecoratedContainer(TilesContainer originalContainer,
                                                  org.apache.tiles.request.ApplicationContext context)
Instantiate the container that will be injected to child objects.

Parameters:
originalContainer - The original instantiated container.
context - The Tiles application context object.
Returns:
The instantiated container.
Since:
3.0.0

createDefinitionsFactory

protected DefinitionsFactory createDefinitionsFactory(org.apache.tiles.request.ApplicationContext applicationContext,
                                                      LocaleResolver resolver)
Creates the definitions factory. By default it creates a UnresolvingLocaleDefinitionsFactory with default dependencies.

Parameters:
applicationContext - The Tiles application context.
resolver - The locale resolver.
Returns:
The definitions factory.
Since:
2.1.1

instantiateDefinitionsFactory

protected UnresolvingLocaleDefinitionsFactory instantiateDefinitionsFactory(org.apache.tiles.request.ApplicationContext applicationContext,
                                                                            LocaleResolver resolver)
Instantiate a new definitions factory based on Locale.

Parameters:
applicationContext - The Tiles application context.
resolver - The locale resolver.
Returns:
The definitions factory.
Since:
2.2.1

instantiateLocaleDefinitionDao

protected BaseLocaleUrlDefinitionDAO instantiateLocaleDefinitionDao(org.apache.tiles.request.ApplicationContext applicationContext,
                                                                    LocaleResolver resolver)
Instantiate (and does not initialize) a Locale-based definition DAO.

Parameters:
applicationContext - The Tiles application context.
resolver - The locale resolver.
Returns:
The definition DAO.
Since:
2.1.1

createLocaleDefinitionDao

protected DefinitionDAO<Locale> createLocaleDefinitionDao(org.apache.tiles.request.ApplicationContext applicationContext,
                                                          LocaleResolver resolver)
Creates a Locale-based definition DAO.

Parameters:
applicationContext - The Tiles application context.
resolver - The locale resolver.
Returns:
The definition DAO.
Since:
2.1.1

createLocaleResolver

protected LocaleResolver createLocaleResolver(org.apache.tiles.request.ApplicationContext applicationContext)
Creates the locale resolver. By default it creates a DefaultLocaleResolver.

Parameters:
applicationContext - The Tiles application context.
Returns:
The locale resolver.
Since:
2.1.1

createDefinitionsReader

protected DefinitionsReader createDefinitionsReader(org.apache.tiles.request.ApplicationContext applicationContext)
Creates the definitions reader. By default it creates a DigesterDefinitionsReader.

Parameters:
applicationContext - The Tiles application context.
Returns:
The definitions reader.
Since:
2.1.1

getSources

protected List<org.apache.tiles.request.ApplicationResource> getSources(org.apache.tiles.request.ApplicationContext applicationContext)
Returns a list containing the resources to be parsed. By default, it returns a list containing the resource at "/WEB-INF/tiles.xml".

Parameters:
applicationContext - The Tiles application context.
Returns:
The resources.
Since:
2.1.1

createAttributeEvaluatorFactory

protected AttributeEvaluatorFactory createAttributeEvaluatorFactory(org.apache.tiles.request.ApplicationContext applicationContext,
                                                                    LocaleResolver resolver)
Creates the attribute evaluator factory to use. By default it returns a BasicAttributeEvaluatorFactory containing the DirectAttributeEvaluator as the default evaluator.

Parameters:
applicationContext - The Tiles application context.
resolver - The locale resolver.
Returns:
The evaluator factory.
Since:
2.2.0

createPreparerFactory

protected PreparerFactory createPreparerFactory(org.apache.tiles.request.ApplicationContext applicationContext)
Creates the preparer factory to use. By default it returns a BasicPreparerFactory.

Parameters:
applicationContext - The Tiles application context.
Returns:
The preparer factory.
Since:
2.1.1

createRendererFactory

protected org.apache.tiles.request.render.RendererFactory createRendererFactory(org.apache.tiles.request.ApplicationContext applicationContext,
                                                                                TilesContainer container,
                                                                                AttributeEvaluatorFactory attributeEvaluatorFactory)
Creates a renderer factory. By default it returns a BasicRendererFactory, composed of an UntypedAttributeRenderer as default, and delegates of StringRenderer, DispatchRenderer, DefinitionRenderer.

Parameters:
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Returns:
The renderer factory.
Since:
2.2.0

createDefaultAttributeRenderer

protected org.apache.tiles.request.render.Renderer createDefaultAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory,
                                                                                  org.apache.tiles.request.ApplicationContext applicationContext,
                                                                                  TilesContainer container,
                                                                                  AttributeEvaluatorFactory attributeEvaluatorFactory)
Creates the default attribute renderer. By default it is an ChainedDelegateRenderer.

Parameters:
rendererFactory - The renderer factory to configure.
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Returns:
The default attribute renderer.
Since:
3.0.0

createPatternDefinitionResolver

protected <T> PatternDefinitionResolver<T> createPatternDefinitionResolver(Class<T> customizationKeyClass)
Creates a new pattern definition resolver. By default, it instantiate a BasicPatternDefinitionResolver with WildcardDefinitionPatternMatcherFactory to manage wildcard substitution.

Type Parameters:
T - The type of the customization key.
Parameters:
customizationKeyClass - The customization key class.
Returns:
The pattern definition resolver.
Since:
2.2.0

registerAttributeRenderers

protected void registerAttributeRenderers(org.apache.tiles.request.render.BasicRendererFactory rendererFactory,
                                          org.apache.tiles.request.ApplicationContext applicationContext,
                                          TilesContainer container,
                                          AttributeEvaluatorFactory attributeEvaluatorFactory)
Registers attribute renderers in a BasicRendererFactory. By default, it registers delegates to StringRenderer, DispatchRenderer and DefinitionRenderer.

Parameters:
rendererFactory - The renderer factory to configure.
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Since:
2.2.0

createStringAttributeRenderer

protected org.apache.tiles.request.render.Renderer createStringAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory,
                                                                                 org.apache.tiles.request.ApplicationContext applicationContext,
                                                                                 TilesContainer container,
                                                                                 AttributeEvaluatorFactory attributeEvaluatorFactory)
Creates an attribute renderer to render strings.

Parameters:
rendererFactory - The renderer factory to configure.
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Returns:
The renderer.
Since:
3.0.0

createTemplateAttributeRenderer

protected org.apache.tiles.request.render.Renderer createTemplateAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory,
                                                                                   org.apache.tiles.request.ApplicationContext applicationContext,
                                                                                   TilesContainer container,
                                                                                   AttributeEvaluatorFactory attributeEvaluatorFactory)
Creates a AttributeRenderer that uses a DispatchRenderer.

Parameters:
rendererFactory - The renderer factory to configure.
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Returns:
The renderer.
Since:
2.2.1

createDefinitionAttributeRenderer

protected org.apache.tiles.request.render.Renderer createDefinitionAttributeRenderer(org.apache.tiles.request.render.BasicRendererFactory rendererFactory,
                                                                                     org.apache.tiles.request.ApplicationContext applicationContext,
                                                                                     TilesContainer container,
                                                                                     AttributeEvaluatorFactory attributeEvaluatorFactory)
Creates a AttributeRenderer using a DefinitionRenderer.

Parameters:
rendererFactory - The renderer factory to configure.
applicationContext - The Tiles application context.
container - The container.
attributeEvaluatorFactory - The attribute evaluator factory.
Returns:
The renderer.
Since:
3.0.0


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.