Package org.apache.tiles.impl.mgmt

Class CachingTilesContainer

java.lang.Object

org.apache.tiles.TilesContainerWrapper

org.apache.tiles.impl.mgmt.CachingTilesContainer

All Implemented Interfaces:

MutableTilesContainer, TilesContainer

public class CachingTilesContainer
extends TilesContainerWrapper
implements MutableTilesContainer

Manages custom and configured definitions, so they can be used by the container, instead of using a simple DefinitionsFactory.

Version:

$Rev: 1045365 $ $Date: 2010-12-14 07:46:46 +1100 (Tue, 14 Dec 2010) $

Field Summary

Fields inherited from class org.apache.tiles.TilesContainerWrapper

container

Constructor Summary

Constructors

Constructor	Description
CachingTilesContainer(TilesContainer originalContainer)	Constructor.
CachingTilesContainer(TilesContainer originalContainer, java.lang.String definitionsAttributeName)	Constructor.

Method Summary

Modifier and Type	Method	Description
Definition	getDefinition(java.lang.String definition, org.apache.tiles.request.Request request)	Returns a definition by name.
boolean	isValidDefinition(java.lang.String definition, org.apache.tiles.request.Request request)	Determine whether or not the definition exists.
void	register(Definition definition, org.apache.tiles.request.Request request)	Register a new definition with the container.
void	render(java.lang.String definition, org.apache.tiles.request.Request request)	Render the given tiles request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tiles.TilesContainer

endContext, evaluate, getApplicationContext, getAttributeContext, prepare, render, render, renderContext, startContext

Methods inherited from class org.apache.tiles.TilesContainerWrapper

endContext, evaluate, getApplicationContext, getAttributeContext, getWrappedContainer, prepare, render, render, renderContext, startContext

Constructor Detail

CachingTilesContainer

public CachingTilesContainer(TilesContainer originalContainer)

Constructor.

Parameters:

originalContainer - The original container to wrap.

CachingTilesContainer

public CachingTilesContainer(TilesContainer originalContainer,
                             java.lang.String definitionsAttributeName)

Constructor.

Parameters:

originalContainer - The original container to wrap.

definitionsAttributeName - The name of the attribute in which storing custom definitions.

Method Detail

getDefinition

public Definition getDefinition(java.lang.String definition,
                                org.apache.tiles.request.Request request)

Returns a definition by name.

Specified by:

getDefinition in interface TilesContainer

Overrides:

getDefinition in class TilesContainerWrapper

Parameters:

definition - The name of the definition.

request - The current request.

Returns:

The requested definition, either main or custom.

Throws:

DefinitionsFactoryException - If something goes wrong when obtaining a main definition.

isValidDefinition

public boolean isValidDefinition(java.lang.String definition,
                                 org.apache.tiles.request.Request request)

Determine whether or not the definition exists.

Specified by:

isValidDefinition in interface TilesContainer

Overrides:

isValidDefinition in class TilesContainerWrapper

Parameters:

definition - the name of the definition.

request - The request.

Returns:

true if the definition is found.

register

public void register(Definition definition,
                     org.apache.tiles.request.Request request)

Register a new definition with the container.

Specified by:

register in interface MutableTilesContainer

Parameters:

definition - The definition to register.

request - TODO

render

public void render(java.lang.String definition,
                   org.apache.tiles.request.Request request)

Render the given tiles request.

Specified by:

render in interface TilesContainer

Overrides:

render in class TilesContainerWrapper

Parameters:

definition - the current definition.

request - The request.