Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> struts >> tiles >> [ xmlDefinition overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.struts.tiles.xmlDefinition
Class FactorySet  

java.lang.Object
  org.apache.struts.tiles.xmlDefinition.FactorySet

All Implemented Interfaces:

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

Direct Known Subclasses:

I18nFactorySet

---

public abstract class FactorySet

extends java.lang.Object

implements org.apache.struts.tiles.ComponentDefinitionsFactory

Component Definitions factory. This factory contains several factories identified by a key. The getDefinition() method first looks for the factory key, retrieves or creates this factory and then calls its getDefinition().

---

Field Summary
protected  java.util.Map	factories           Loaded factories

 

Constructor Summary

FactorySet()           Constructor.

 

Method Summary
protected abstract  DefinitionsFactory	createFactory(java.lang.Object key, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext)           Create a factory for specified key.
protected abstract  DefinitionsFactory	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  DefinitionsFactory	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

FactorySet

public FactorySet()

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.

---

getDefaultFactory

protected abstract DefinitionsFactory getDefaultFactory()

Get default factory.

---

getFactory

protected DefinitionsFactory 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.

---

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

---

createFactory

protected abstract DefinitionsFactory 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.

---

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

---

toString

public java.lang.String toString()

Return String representation.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> struts >> tiles >> [ xmlDefinition overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---