org.apache.commons.chain.config
Class ConfigRuleSet

java.lang.Object
  extended by org.apache.commons.digester.RuleSetBase
      extended by 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 appropriate Catalog. The following properties may be configured prior to executing the addRuleInstance() method in order to influence the rules that get added, with default values in square brackets:

Version:
$Revision: 1.9 $ $Date: 2004/11/30 05:52:23 $
Author:
Craig R. McClanahan

Field Summary
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
           
 
Fields inherited from class org.apache.commons.digester.RuleSetBase
namespaceURI
 
Constructor Summary
ConfigRuleSet()
           
 
Method Summary
 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).
 java.lang.String getCatalogClass()
          Return the fully qualified Catalog implementation class.
 java.lang.String getCatalogElement()
          Return the element name of a catalog element.
 java.lang.String getChainClass()
          Return the fully qualified Chain 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 qualified Catalog 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 qualified Chain 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.
 
Methods inherited from class org.apache.commons.digester.RuleSetBase
getNamespaceURI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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
Constructor Detail

ConfigRuleSet

public ConfigRuleSet()
Method Detail

getCatalogClass

public java.lang.String getCatalogClass()

Return the fully qualified Catalog implementation class.


setCatalogClass

public void setCatalogClass(java.lang.String catalogClass)

Set the fully qualified Catalog implementation class.

Parameters:
catalogClass - The new Catalog implementation class

getCatalogElement

public java.lang.String getCatalogElement()

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


setChainClass

public void setChainClass(java.lang.String chainClass)

Set the fully qualified Chain implementation class.

Parameters:
chainClass - The new Chain implementation class

getChainElement

public java.lang.String getChainElement()

Return the element name of a chain 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.


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.


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.


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.


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 interface org.apache.commons.digester.RuleSet
Specified by:
addRuleInstances in class org.apache.commons.digester.RuleSetBase
Parameters:
digester - Digester instance to which the new Rule instances should be added.