Class ConfigRuleSet
- java.lang.Object
-
- org.apache.commons.digester.RuleSetBase
-
- org.apache.commons.chain.config.ConfigRuleSet
-
- All Implemented Interfaces:
org.apache.commons.digester.RuleSet
public class ConfigRuleSet extends org.apache.commons.digester.RuleSetBase
Digester
RuleSet
for configuring Chain of Responsibility command chains, and adding them to an appropriateCatalog
. The following properties may be configured prior to executing theaddRuleInstance()
method in order to influence the rules that get added, with default values in square brackets:- catalogClass -- Fully qualified name of the
implementation class used to create new
Catalog
instances. If not specified, the default value isorg.apache.commons.chain.impl.CatalogBsae
. - catalogElement -- Name of the XML element representing
the addition of a
Catalog
. Any such catalog that is created will be registered with theCatalogFactory
instance for our application, under the name specified by thenameAttribute
attribute (if present), or as the defaultCatalog
. If not specified, the default value iscatalog
. - chainClass -- Fully qualified name of the implementation
class used to create new
Chain
instances. If not specified, the default value isorg.apache.commons.chain.impl.ChainBase
. - chainElement -- Name of the XML element representing
the addition of a
Chain
. A chain element has the same functionality as a command element, except that it defaults the implementation class toorg.apache.commons.chain.impl.ChainBase
. [chain] - classAttribute -- Attribute on a chain (optional) or command (required) element that specifies the fully qualified class name of the implementation class that should be instantiated. [className]
- commandElement -- Name of the XML element
representing the addition of a
Command
. An implementation class name must be provided on the attribute named by theclassAttribute
property. [command] - defineElement -- Name of the XML element
that associates the element specified by the
nameAttribute
attributes with aCommand
orChain
implementation class named by theclassAttribute
attribute. [define] - nameAttribute -- Attribute on an outermost chain or
command element that will be used to register this command with the
associated
Catalog
instance on the stack. [name] - namespaceURI -- The XML namespace URI with which these
rules will be associated, or
null
for no namespace. [null]
- Version:
- $Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
- Author:
- Craig R. McClanahan
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
catalogClass
private java.lang.String
catalogElement
private java.lang.String
chainClass
private java.lang.String
chainElement
private java.lang.String
classAttribute
private java.lang.String
commandElement
private java.lang.String
defineElement
private java.lang.String
nameAttribute
-
Constructor Summary
Constructors Constructor Description ConfigRuleSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRuleInstances(org.apache.commons.digester.Digester digester)
Add the set of Rule instances defined in this RuleSet to the specifiedDigester
instance, associating them with our namespace URI (if any).java.lang.String
getCatalogClass()
Return the fully qualifiedCatalog
implementation class.java.lang.String
getCatalogElement()
Return the element name of a catalog element.java.lang.String
getChainClass()
Return the fully qualifiedChain
implementation class.java.lang.String
getChainElement()
Return the element name of a chain element.java.lang.String
getClassAttribute()
Return the attribute name of a class attribute.java.lang.String
getCommandElement()
Return the element name of a command element.java.lang.String
getDefineElement()
Return the element name of a define element.java.lang.String
getNameAttribute()
Return the attribute name of a name attribute.void
setCatalogClass(java.lang.String catalogClass)
Set the fully qualifiedCatalog
implementation class.void
setCatalogElement(java.lang.String catalogElement)
Set the element name of a catalog element.void
setChainClass(java.lang.String chainClass)
Set the fully qualifiedChain
implementation class.void
setChainElement(java.lang.String chainElement)
Set the element name of a chain element.void
setClassAttribute(java.lang.String classAttribute)
Set the attribute name of a class attribute.void
setCommandElement(java.lang.String commandElement)
Set the element name of a command element.void
setDefineElement(java.lang.String defineElement)
Set the element name of a define element.void
setNameAttribute(java.lang.String nameAttribute)
Set the attribute name of a name attribute.
-
-
-
Field Detail
-
catalogClass
private java.lang.String catalogClass
-
catalogElement
private java.lang.String catalogElement
-
chainClass
private java.lang.String chainClass
-
chainElement
private java.lang.String chainElement
-
classAttribute
private java.lang.String classAttribute
-
commandElement
private java.lang.String commandElement
-
defineElement
private java.lang.String defineElement
-
nameAttribute
private java.lang.String nameAttribute
-
-
Method Detail
-
getCatalogClass
public java.lang.String getCatalogClass()
Return the fully qualified
Catalog
implementation class.- Returns:
- The Catalog's class name.
-
setCatalogClass
public void setCatalogClass(java.lang.String catalogClass)
Set the fully qualified
Catalog
implementation class.- Parameters:
catalogClass
- The newCatalog
implementation class
-
getCatalogElement
public java.lang.String getCatalogElement()
Return the element name of a catalog element.
- Returns:
- The element name of a catalog element.
-
setCatalogElement
public void setCatalogElement(java.lang.String catalogElement)
Set the element name of a catalog element.
- Parameters:
catalogElement
- The new element name
-
getChainClass
public java.lang.String getChainClass()
Return the fully qualified
Chain
implementation class.- Returns:
- The Chain's class name.
-
setChainClass
public void setChainClass(java.lang.String chainClass)
Set the fully qualified
Chain
implementation class.- Parameters:
chainClass
- The newChain
implementation class
-
getChainElement
public java.lang.String getChainElement()
Return the element name of a chain element.
- Returns:
- The element name of a catalog element.
-
setChainElement
public void setChainElement(java.lang.String chainElement)
Set the element name of a chain element.
- Parameters:
chainElement
- The new element name
-
getClassAttribute
public java.lang.String getClassAttribute()
Return the attribute name of a class attribute.
- Returns:
- The attribute name of a class attribute.
-
setClassAttribute
public void setClassAttribute(java.lang.String classAttribute)
Set the attribute name of a class attribute.
- Parameters:
classAttribute
- The new attribute name
-
getCommandElement
public java.lang.String getCommandElement()
Return the element name of a command element.
- Returns:
- The element name of a command element.
-
setCommandElement
public void setCommandElement(java.lang.String commandElement)
Set the element name of a command element.
- Parameters:
commandElement
- The new element name
-
getDefineElement
public java.lang.String getDefineElement()
Return the element name of a define element.
- Returns:
- The element name of a define element.
-
setDefineElement
public void setDefineElement(java.lang.String defineElement)
Set the element name of a define element.
- Parameters:
defineElement
- The new element name
-
getNameAttribute
public java.lang.String getNameAttribute()
Return the attribute name of a name attribute.
- Returns:
- The attribute name of an attribute element.
-
setNameAttribute
public void setNameAttribute(java.lang.String nameAttribute)
Set the attribute name of a name attribute.
- Parameters:
nameAttribute
- The new attribute name
-
addRuleInstances
public void addRuleInstances(org.apache.commons.digester.Digester digester)
Add the set of Rule instances defined in this RuleSet to the specified
Digester
instance, associating them with our namespace URI (if any). This method should only be called by a Digester instance.- Specified by:
addRuleInstances
in interfaceorg.apache.commons.digester.RuleSet
- Specified by:
addRuleInstances
in classorg.apache.commons.digester.RuleSetBase
- Parameters:
digester
- Digester instance to which the new Rule instances should be added.
-
-