org.apache.struts.tiles.xmlDefinition
クラス FactorySet

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

すべての実装インタフェース:

ComponentDefinitionsFactory, java.io.Serializable

直系の既知のサブクラス:

I18nFactorySet

public abstract class FactorySet

extends java.lang.Object

implements 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().

関連項目:

直列化された形式

フィールドの概要

protected java.util.Map

factories Loaded factories

コンストラクタの概要

FactorySet()
Constructor.

メソッドの概要

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

クラス java.lang.Object から継承したメソッド

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

フィールドの詳細

factories

protected java.util.Map factories

Loaded factories

コンストラクタの詳細

FactorySet

public FactorySet()

Constructor.

メソッドの詳細

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.

パラメータ:

name - Name of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

戻り値:

Object.

getDefaultFactory

protected abstract DefinitionsFactory getDefaultFactory()

Get default factory.

戻り値:

Default factory.

getFactory

protected DefinitionsFactory getFactory(java.lang.Object key,
                                        javax.servlet.ServletRequest request,
                                        javax.servlet.ServletContext servletContext)
                                 throws 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.

パラメータ:

key - Key of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

例外:

DefinitionsFactoryException - If an error occur while creating factory.

getDefinition

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

Get a definition by its name.

定義:

インタフェース ComponentDefinitionsFactory 内の getDefinition

パラメータ:

name - Name of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

例外:

NoSuchDefinitionException - No definition found for specified name

DefinitionsFactoryException - General exception

createFactory

protected abstract DefinitionsFactory createFactory(java.lang.Object key,
                                                    javax.servlet.ServletRequest request,
                                                    javax.servlet.ServletContext servletContext)
                                             throws 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.

パラメータ:

key - Key of requested definition.

request - Current servlet request.

servletContext - Current servlet context

例外:

DefinitionsFactoryException - If an error occur while creating factory.

initFactory

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

Init factory set.

定義:

インタフェース ComponentDefinitionsFactory 内の initFactory

パラメータ:

servletContext - Current servlet context

properties - properties used to initialized factory set;

例外:

DefinitionsFactoryException - An error occur during initialization.

toString

public java.lang.String toString()

Return String representation.

戻り値:

String representation.