org.apache.commons.workflow.base
Class BaseRuleSet

java.lang.Object
  extended by org.apache.commons.digester.RuleSetBase
      extended by org.apache.commons.workflow.base.BaseRuleSet
All Implemented Interfaces:
org.apache.commons.digester.RuleSet
Direct Known Subclasses:
CoreRuleSet, IoRuleSet, WebRuleSet

public class BaseRuleSet
extends org.apache.commons.digester.RuleSetBase

RuleSet for the basic Activity definitions of the Workflow Management System, typically associated with the base prefix. This library is normally associated with the namespace URI:

   http://commons.apache.org/workflow/base
 

This class also serves as a convenience base class for the RuleSet implementations for Step libraries. Subclasses MUST override the no-arguments constructor to set the correct namespace URI, and MUST override (and replace) the addRuleInstances() method to add the relevant rules for that particular library.

Version:
$Revision: 561366 $ $Date: 2007-07-31 16:58:29 +0100 (Tue, 31 Jul 2007) $
Author:
Craig R. McClanahan

Field Summary
 
Fields inherited from class org.apache.commons.digester.RuleSetBase
namespaceURI
 
Constructor Summary
BaseRuleSet()
          Construct a default instance of the RuleSet.
 
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).
protected  void addStandardDescriptor(org.apache.commons.digester.Digester digester, String element)
          Add the standard set of rules for a new Descriptor that should be recognized.
protected  void addStandardStep(org.apache.commons.digester.Digester digester, String element, String name)
          Add the standard set of rules for a new Step that should be recognized.
 void setNamespaceURI(String namespaceURI)
          Set the namespace URI that these rules apply to.
 
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
 

Constructor Detail

BaseRuleSet

public BaseRuleSet()
Construct a default instance of the RuleSet.

Method Detail

setNamespaceURI

public void setNamespaceURI(String namespaceURI)
Set the namespace URI that these rules apply to. This is only needed if you want to reset the default value created by a subclass.

Parameters:
namespaceURI - The new namespace URI

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.

addStandardDescriptor

protected void addStandardDescriptor(org.apache.commons.digester.Digester digester,
                                     String element)
Add the standard set of rules for a new Descriptor that should be recognized.

Parameters:
digester - Digester to which we are adding new rules
element - Element name to be matched

addStandardStep

protected void addStandardStep(org.apache.commons.digester.Digester digester,
                               String element,
                               String name)
Add the standard set of rules for a new Step that should be recognized.

Parameters:
digester - Digester to which we are adding new rules
element - Element name to be matched
name - Fully qualified class name of the implementation class


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.