Package org.apache.commons.chain.config

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 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:
  • catalogClass -- Fully qualified name of the implementation class used to create new Catalog instances. If not specified, the default value is org.apache.commons.chain.impl.CatalogBase.
  • catalogElement -- Name of the XML element representing the addition of a Catalog. Any such catalog that is created will be registered with the CatalogFactory instance for our application, under the name specified by the nameAttribute attribute (if present), or as the default Catalog. If not specified, the default value is catalog.
  • chainClass -- Fully qualified name of the implementation class used to create new Chain instances. If not specified, the default value is org.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 to org.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 the classAttribute property. [command]
  • defineElement -- Name of the XML element that associates the element specified by the nameAttribute attributes with a Command or Chain implementation class named by the classAttribute 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$ $Date$
Author:
Craig R. McClanahan

  • Constructor Details

    • ConfigRuleSet

      public ConfigRuleSet()
      The Default-Constructor for this class.

  • Method Details

    • getCatalogClass

      public String getCatalogClass()
      Return the fully qualified Catalog implementation class.
      Returns:
      The Catalog's class name.

    • setCatalogClass

      public void setCatalogClass(String catalogClass)
      Set the fully qualified Catalog implementation class.
      Parameters:
      catalogClass - The new Catalog implementation class

    • getCatalogElement

      public String getCatalogElement()
      Return the element name of a catalog element.
      Returns:
      The element name of a catalog element.

    • setCatalogElement

      public void setCatalogElement(String catalogElement)
      Set the element name of a catalog element.
      Parameters:
      catalogElement - The new element name

    • getChainClass

      public String getChainClass()
      Return the fully qualified Chain implementation class.
      Returns:
      The Chain's class name.

    • setChainClass

      public void setChainClass(String chainClass)
      Set the fully qualified Chain implementation class.
      Parameters:
      chainClass - The new Chain implementation class

    • getChainElement

      public String getChainElement()
      Return the element name of a chain element.
      Returns:
      The element name of a catalog element.

    • setChainElement

      public void setChainElement(String chainElement)
      Set the element name of a chain element.
      Parameters:
      chainElement - The new element name

    • getClassAttribute

      public String getClassAttribute()
      Return the attribute name of a class attribute.
      Returns:
      The attribute name of a class attribute.

    • setClassAttribute

      public void setClassAttribute(String classAttribute)
      Set the attribute name of a class attribute.
      Parameters:
      classAttribute - The new attribute name

    • getCommandElement

      public String getCommandElement()
      Return the element name of a command element.
      Returns:
      The element name of a command element.

    • setCommandElement

      public void setCommandElement(String commandElement)
      Set the element name of a command element.
      Parameters:
      commandElement - The new element name

    • getDefineElement

      public String getDefineElement()
      Return the element name of a define element.
      Returns:
      The element name of a define element.

    • setDefineElement

      public void setDefineElement(String defineElement)
      Set the element name of a define element.
      Parameters:
      defineElement - The new element name

    • getNameAttribute

      public String getNameAttribute()
      Return the attribute name of a name attribute.
      Returns:
      The attribute name of an attribute element.

    • setNameAttribute

      public void setNameAttribute(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.