com.free2be.dimensions.tiles
Class ConfigurableFactorySet

java.lang.Object
  org.apache.struts.tiles.xmlDefinition.FactorySet
      com.free2be.dimensions.tiles.ConfigurableFactorySet

All Implemented Interfaces:

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

public class ConfigurableFactorySet
extends org.apache.struts.tiles.xmlDefinition.FactorySet

This class represents a FactorySet configurable via an external XML file.

See Also:

Serialized Form

Field Summary

protected static org.apache.commons.logging.Log	log The log object to use.
protected java.lang.String[]	registrations An empty string array, for the moment...

Fields inherited from class org.apache.struts.tiles.xmlDefinition.FactorySet

factories

Constructor Summary

ConfigurableFactorySet()
Creates a new instance of ConfigurableFactorySet

ConfigurableFactorySet(javax.servlet.ServletContext context, java.util.Map properties)
Instantiates a new ConfigurableFactorySet, though it is never called...

Method Summary

protected org.apache.struts.tiles.xmlDefinition.DefinitionsFactory	createFactory(java.lang.Object obj, javax.servlet.ServletRequest request, javax.servlet.ServletContext context) Creates a new factory with the given object as a key.
protected org.apache.struts.tiles.xmlDefinition.DefinitionsFactory	getDefaultFactory() Returns the default factory.
protected java.lang.Object	getDefinitionsFactoryKey(java.lang.String name, javax.servlet.ServletRequest request, javax.servlet.ServletContext context) Returns the key of a definitions factory, depending on the status of the application.
protected org.apache.commons.digester.Digester	initConfigDigester() Initializes the digester used to parse the configuration file.
void	initFactory(javax.servlet.ServletContext context, java.util.Map properties) Initializes the factory.
protected void	parseConfigFile(javax.servlet.ServletContext context, org.apache.commons.digester.Digester digester, java.lang.String path) Parses the confguration file.

Methods inherited from class org.apache.struts.tiles.xmlDefinition.FactorySet

getDefinition, getFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

registrations

protected java.lang.String[] registrations

An empty string array, for the moment...

log

protected static org.apache.commons.logging.Log log

The log object to use.

Constructor Detail

ConfigurableFactorySet

public ConfigurableFactorySet()

Creates a new instance of ConfigurableFactorySet

ConfigurableFactorySet

public ConfigurableFactorySet(javax.servlet.ServletContext context,
                              java.util.Map properties)
                       throws org.apache.struts.tiles.DefinitionsFactoryException

Instantiates a new ConfigurableFactorySet, though it is never called...

Parameters:

context - The servlet context.

properties - The properties passed via the plugin.

Throws:

org.apache.struts.tiles.DefinitionsFactoryException - If something goes wrong.

Method Detail

createFactory

protected org.apache.struts.tiles.xmlDefinition.DefinitionsFactory createFactory(java.lang.Object obj,
                                                                                 javax.servlet.ServletRequest request,
                                                                                 javax.servlet.ServletContext context)
                                                                          throws org.apache.struts.tiles.DefinitionsFactoryException

Creates a new factory with the given object as a key.

Specified by:

createFactory in class org.apache.struts.tiles.xmlDefinition.FactorySet

Parameters:

obj - The object to use. It must be a "Decision".

request - The servlet request to use.

context - The servlet context.

Returns:

The correct DefinitionsFactory.

Throws:

org.apache.struts.tiles.DefinitionsFactoryException - If something goes wrong.

getDefaultFactory

protected org.apache.struts.tiles.xmlDefinition.DefinitionsFactory getDefaultFactory()

Returns the default factory.

Specified by:

getDefaultFactory in class org.apache.struts.tiles.xmlDefinition.FactorySet

Returns:

The default factory.

getDefinitionsFactoryKey

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

Returns the key of a definitions factory, depending on the status of the application. The configured Decider will be used.

Specified by:

getDefinitionsFactoryKey in class org.apache.struts.tiles.xmlDefinition.FactorySet

Parameters:

name - The name of the definition.

request - The servlet request.

context - The servlet context.

Returns:

The key. It will be a "Decision".

initFactory

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

Initializes the factory.

Specified by:

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

Specified by:

initFactory in class org.apache.struts.tiles.xmlDefinition.FactorySet

Parameters:

context - The servlet context.

properties - The properties that come with the plugin.

Throws:

org.apache.struts.tiles.DefinitionsFactoryException - If something goes wrong.

initConfigDigester

protected org.apache.commons.digester.Digester initConfigDigester()
                                                           throws javax.servlet.ServletException

Initializes the digester used to parse the configuration file.

Returns:

The created digester.

Throws:

javax.servlet.ServletException - If something goes wrong.

parseConfigFile

protected void parseConfigFile(javax.servlet.ServletContext context,
                               org.apache.commons.digester.Digester digester,
                               java.lang.String path)
                        throws javax.servlet.UnavailableException

Parses the confguration file.

Parameters:

context - The servlet context to use.

digester - The digester to use.

path - The path of the file to digest.

Throws:

javax.servlet.UnavailableException - If something goes wrong.