Save This Page
Home » commons-digester-1.8-src » org.apache.commons » digester » xmlrules » [javadoc | source]
org.apache.commons.digester.xmlrules
public class: FromXmlRuleSet [javadoc | source]
java.lang.Object
   org.apache.commons.digester.RuleSetBase
      org.apache.commons.digester.xmlrules.FromXmlRuleSet

All Implemented Interfaces:
    RuleSet

A Digester rule set where the rules come from an XML file.
Field Summary
public static final  String DIGESTER_DTD_PATH     
Fields inherited from org.apache.commons.digester.RuleSetBase:
namespaceURI
Constructor:
 public FromXmlRuleSet(URL rulesXml) 
    Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.
    Parameters:
    rulesXml - the path to the XML document defining the Digester rules
 public FromXmlRuleSet(InputSource inputSource) 
    Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.
    Parameters:
    inputSource - load the xml rules from this InputSource
 public FromXmlRuleSet(URL rulesXml,
    Digester rulesDigester) 
    Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
    Parameters:
    rulesXml - the path to the XML document defining the Digester rules
    rulesDigester - the digester to read the rules xml.
 public FromXmlRuleSet(URL rulesXml,
    DigesterRuleParser parser) 
    Parameters:
    rulesXml - the path to the XML document defining the Digester rules
    parser - an instance of DigesterRuleParser, for parsing the rules from XML
 public FromXmlRuleSet(InputSource inputSource,
    Digester rulesDigester) 
    Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
    Parameters:
    inputSource - load the xml rules from this InputSource
    rulesDigester - the digester to read the rules xml.
 public FromXmlRuleSet(InputSource inputSource,
    DigesterRuleParser parser) 
    Parameters:
    inputSource - load the xml rules from this InputSource
    parser - an instance of DigesterRuleParser, for parsing the rules from XML
 public FromXmlRuleSet(URL rulesXml,
    DigesterRuleParser parser,
    Digester rulesDigester) 
    Parameters:
    rulesXml - the path to the XML document defining the Digester rules
    parser - an instance of DigesterRuleParser, for parsing the rules from XML
    rulesDigester - the digester used to load the Xml rules.
 public FromXmlRuleSet(InputSource inputSource,
    DigesterRuleParser parser,
    Digester rulesDigester) 
    Parameters:
    inputSource - load the xml rules from this InputSource
    parser - an instance of DigesterRuleParser, for parsing the rules from XML
    rulesDigester - the digester used to load the Xml rules.
Method from org.apache.commons.digester.xmlrules.FromXmlRuleSet Summary:
addRuleInstances,   addRuleInstances
Methods from org.apache.commons.digester.RuleSetBase:
addRuleInstances,   getNamespaceURI
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.digester.xmlrules.FromXmlRuleSet Detail:
 public  void addRuleInstances(Digester digester) throws XmlLoadException 
    Adds to the digester the set of Rule instances defined in the XML file for this rule set.
 public  void addRuleInstances(Digester digester,
    String basePath) throws XmlLoadException 
    Adds to the digester the set of Rule instances defined in the XML file for this rule set.

    Note that this method doesn't have a matching one on the DigesterLoader class, because it is not expected to be widely used, and DigesterLoader's load method is already heavily overloaded.