| java.lang.Object
 org.apache.struts.tiles.xmlDefinition.FactorySet
org.apache.struts.tiles.xmlDefinition.I18nFactorySet
All known Subclasses: org.apache.struts.tiles.CustomI18nFactorySet,
| I18nFactorySet | | public class I18nFactorySet extends FactorySet (Code) | | Definitions factory.
This implementation allows to have a set of definition factories.
There is a main factory and one factory for each file associated to a Locale.
To retrieve a definition, we first search for the appropriate factory using
the Locale found in session context. If no factory is found, use the
default one. Then we ask the factory for the definition.
A definition factory file is loaded using main filename extended with locale code
(ex : templateDefinitions_fr.xml). If no file is found under this name, use default file.
|
| Method Summary | |
| protected DefinitionsFactory | createDefaultFactory(ServletContext servletContext)
Create default factory .
Create InstancesMapper for specified Locale.
If creation failes, use default mapper and log error message.
Parameters:
servletContext - Current servlet context. | | protected DefinitionsFactory | createFactory(Object key, ServletRequest request, ServletContext servletContext)
Create a factory for specified key.
If creation failes, return default factory and log an error message.
Parameters:
key - The key.
Parameters:
request - Servlet request.
Parameters:
servletContext - Servlet context. | | protected DefinitionsFactory | getDefaultFactory()
Get default factory. | | protected Object | getDefinitionsFactoryKey(String name, ServletRequest request, ServletContext servletContext)
Extract key that will be used to get the sub factory.
Parameters:
name - Name of requested definition
Parameters:
request - Current servlet request.
Parameters:
servletContext - Current servlet context. | | public void | initFactory(ServletContext servletContext, Map properties)
Initialization method.
Init the factory by reading appropriate configuration file.
This method is called exactly once immediately after factory creation in
case of internal creation (by DefinitionUtil).
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
properties - Map of name/property passed to newly created factory. | | protected void | initFactory(ServletContext servletContext, String proposedFilename)
Initialization method. | | protected XmlDefinitionsSet | parseXmlFile(ServletContext servletContext, String filename, XmlDefinitionsSet xmlDefinitions)
Parse specified xml file and add definition to specified definitions set.
This method is used to load several description files in one instances list.
If filename exists and definition set is null, create a new set. | | protected XmlDefinitionsSet | parseXmlFiles(ServletContext servletContext, String postfix, XmlDefinitionsSet xmlDefinitions)
Parse files associated to postix if they exist.
For each name in filenames, append postfix before file extension,
then try to load the corresponding file.
If file doesn't exist, try next one. | | public String | toString()
Return String representation. |
| DEFAULT_DEFINITION_FILENAMES | | final public static String DEFAULT_DEFINITION_FILENAMES(Code) | | Possible definition filenames.
|
| DEFINITIONS_CONFIG_PARAMETER_NAME | | final public static String DEFINITIONS_CONFIG_PARAMETER_NAME(Code) | | Config file parameter name.
|
| FILENAME_EXTENSION | | final public static String FILENAME_EXTENSION(Code) | | Default filenames extension.
|
| PARSER_DETAILS_PARAMETER_NAME | | final public static String PARSER_DETAILS_PARAMETER_NAME(Code) | | Config file parameter name.
|
| PARSER_VALIDATE_PARAMETER_NAME | | final public static String PARSER_VALIDATE_PARAMETER_NAME(Code) | | Config file parameter name.
|
| isValidatingParser | | protected boolean isValidatingParser(Code) | | Do we want validating parser. Default is false.
Can be set from servlet config file.
|
| log | | protected static Log log(Code) | | Commons Logging instance.
|
| parserDetailLevel | | protected int parserDetailLevel(Code) | | Parser detail level. Default is 0.
Can be set from servlet config file.
|
| xmlParser | | protected transient XmlParser xmlParser(Code) | | XML parser used.
Attribute is transient to allow serialization. In this implementaiton,
xmlParser is created each time we need it ;-(.
|
| I18nFactorySet | | public I18nFactorySet(ServletContext servletContext, Map properties) throws DefinitionsFactoryException(Code) | | Constructor.
Init the factory by reading appropriate configuration file.
Parameters:
servletContext - Servlet context.
Parameters:
properties - Map containing all properties.
throws:
FactoryNotFoundException - Can't find factory configuration file. |
| getDefinitionsFactoryKey | | protected Object getDefinitionsFactoryKey(String name, ServletRequest request, ServletContext servletContext)(Code) | | Extract key that will be used to get the sub factory.
Parameters:
name - Name of requested definition
Parameters:
request - Current servlet request.
Parameters:
servletContext - Current servlet context. the key or null if not found. |
| initFactory | | public void initFactory(ServletContext servletContext, Map properties) throws DefinitionsFactoryException(Code) | | Initialization method.
Init the factory by reading appropriate configuration file.
This method is called exactly once immediately after factory creation in
case of internal creation (by DefinitionUtil).
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
properties - Map of name/property passed to newly created factory. Map can containsmore properties than requested.
throws:
DefinitionsFactoryException - An error occur during initialization. |
| initFactory | | protected void initFactory(ServletContext servletContext, String proposedFilename) throws DefinitionsFactoryException, FileNotFoundException(Code) | | Initialization method.
Init the factory by reading appropriate configuration file.
This method is called exactly once immediately after factory creation in
case of internal creation (by DefinitionUtil).
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
proposedFilename - File names, comma separated, to use as base file names.
throws:
DefinitionsFactoryException - An error occur during initialization. |
| parseXmlFile | | protected XmlDefinitionsSet parseXmlFile(ServletContext servletContext, String filename, XmlDefinitionsSet xmlDefinitions) throws DefinitionsFactoryException(Code) | | Parse specified xml file and add definition to specified definitions set.
This method is used to load several description files in one instances list.
If filename exists and definition set is null, create a new set. Otherwise, return
passed definition set (can be null).
Parameters:
servletContext - Current servlet context. Used to open file.
Parameters:
filename - Name of file to parse.
Parameters:
xmlDefinitions - Definitions set to which definitions will be added. If null, a definitionsset is created on request. XmlDefinitionsSet The definitions set created or passed as parameter.
throws:
DefinitionsFactoryException - On errors parsing file. |
| parseXmlFiles | | protected XmlDefinitionsSet parseXmlFiles(ServletContext servletContext, String postfix, XmlDefinitionsSet xmlDefinitions) throws DefinitionsFactoryException(Code) | | Parse files associated to postix if they exist.
For each name in filenames, append postfix before file extension,
then try to load the corresponding file.
If file doesn't exist, try next one. Each file description is added to
the XmlDefinitionsSet description.
The XmlDefinitionsSet description is created only if there is a definition file.
Inheritance is not resolved in the returned XmlDefinitionsSet.
If no description file can be opened and no definiion set is provided, return null.
Parameters:
postfix - Postfix to add to each description file.
Parameters:
xmlDefinitions - Definitions set to which definitions will be added. If null, a definitionsset is created on request. XmlDefinitionsSet The definitions set created or passed as parameter.
throws:
DefinitionsFactoryException - On errors parsing file. |
| toString | | public String toString()(Code) | | Return String representation.
String representation. |
| Fields inherited from org.apache.struts.tiles.xmlDefinition.FactorySet | protected Map factories(Code)(Java Doc)
|
| Methods inherited from org.apache.struts.tiles.xmlDefinition.FactorySet | abstract protected DefinitionsFactory createFactory(Object key, ServletRequest request, ServletContext servletContext) throws DefinitionsFactoryException(Code)(Java Doc)
abstract protected DefinitionsFactory getDefaultFactory()(Code)(Java Doc)
public ComponentDefinition getDefinition(String name, ServletRequest request, ServletContext servletContext) throws NoSuchDefinitionException, DefinitionsFactoryException(Code)(Java Doc)
abstract protected Object getDefinitionsFactoryKey(String name, ServletRequest request, ServletContext servletContext)(Code)(Java Doc)
protected DefinitionsFactory getFactory(Object key, ServletRequest request, ServletContext servletContext) throws DefinitionsFactoryException(Code)(Java Doc)
abstract public void initFactory(ServletContext servletContext, Map properties) throws DefinitionsFactoryException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|