com.macvu.tiles.xmlDefinition
Class CacheFactorySet

java.lang.Object
  com.macvu.tiles.xmlDefinition.CacheFactorySet

All Implemented Interfaces:

java.io.Serializable, org.apache.struts.tiles.ComponentDefinitionsFactory

Direct Known Subclasses:

CacheI18nFactorySet

public abstract class CacheFactorySet
extends java.lang.Object
implements org.apache.struts.tiles.ComponentDefinitionsFactory

See Also:

Serialized Form

Field Summary

protected java.util.Map

factories Loaded factories

Constructor Summary

CacheFactorySet()
Constructor.

Method Summary

protected abstract CacheDefinitionFactory	createFactory(java.lang.Object key, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Create a factory for specified key.
protected abstract CacheDefinitionFactory	getDefaultFactory() Get default factory.
org.apache.struts.tiles.ComponentDefinition	getDefinition(java.lang.String name, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Get a definition by its name.
protected abstract java.lang.Object	getDefinitionsFactoryKey(java.lang.String name, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Extract key that will be used to get the sub factory.
protected CacheDefinitionFactory	getFactory(java.lang.Object key, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Get a factory by its key.
abstract void	initFactory(javax.servlet.ServletContext servletContext, java.util.Map properties) Init factory set.
java.lang.String	toString() Return String representation.

Methods inherited from class java.lang.Object

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

Field Detail

factories

protected java.util.Map factories

Loaded factories

Constructor Detail

CacheFactorySet

public CacheFactorySet()

Constructor.

Method Detail

getDefinitionsFactoryKey

protected abstract java.lang.Object getDefinitionsFactoryKey(java.lang.String name,
                                                             javax.servlet.ServletRequest request,
                                                             javax.servlet.ServletContext servletContext)

Extract key that will be used to get the sub factory.

Parameters:

name - Name of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

Returns:

Object.

getDefaultFactory

protected abstract CacheDefinitionFactory getDefaultFactory()

Get default factory.

Returns:

Default factory.

getFactory

protected CacheDefinitionFactory getFactory(java.lang.Object key,
                                            javax.servlet.ServletRequest request,
                                            javax.servlet.ServletContext servletContext)
                                     throws org.apache.struts.tiles.DefinitionsFactoryException

Get a factory by its key. If key is null, return defaultFactory. Search in loaded factories. If not found, create factory and store return value in loaded factories.

Parameters:

key - Key of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

Throws:

org.apache.struts.tiles.DefinitionsFactoryException - If an error occur while creating factory.

getDefinition

public org.apache.struts.tiles.ComponentDefinition getDefinition(java.lang.String name,
                                                                 javax.servlet.ServletRequest request,
                                                                 javax.servlet.ServletContext servletContext)
                                                          throws org.apache.struts.tiles.NoSuchDefinitionException,
                                                                 org.apache.struts.tiles.DefinitionsFactoryException

Get a definition by its name.

Specified by:

getDefinition in interface org.apache.struts.tiles.ComponentDefinitionsFactory

Parameters:

name - Name of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

Throws:

org.apache.struts.tiles.NoSuchDefinitionException - No definition found for specified name

org.apache.struts.tiles.DefinitionsFactoryException - General exception

createFactory

protected abstract CacheDefinitionFactory createFactory(java.lang.Object key,
                                                        javax.servlet.ServletRequest request,
                                                        javax.servlet.ServletContext servletContext)
                                                 throws org.apache.struts.tiles.DefinitionsFactoryException

Create a factory for specified key. This method is called by getFactory() when the requested factory doesn't already exist. Must return a factory, or a default one. Real implementation needs to provide this method.

Parameters:

key - Key of requested definition.

request - Current servlet request.

servletContext - Current servlet context

Throws:

org.apache.struts.tiles.DefinitionsFactoryException - If an error occur while creating factory.

initFactory

public abstract void initFactory(javax.servlet.ServletContext servletContext,
                                 java.util.Map properties)
                          throws org.apache.struts.tiles.DefinitionsFactoryException

Init factory set.

Specified by:

initFactory in interface org.apache.struts.tiles.ComponentDefinitionsFactory

Parameters:

servletContext - Current servlet context

properties - properties used to initialized factory set;

Throws:

org.apache.struts.tiles.DefinitionsFactoryException

toString

public java.lang.String toString()

Return String representation.

Overrides:

toString in class java.lang.Object

Returns:

String representation.