org.apache.commons.digester.xmlrules
Class FromXmlRuleSet

java.lang.Object
  |
  +--org.apache.commons.digester.RuleSetBase
        |
        +--org.apache.commons.digester.xmlrules.FromXmlRuleSet

All Implemented Interfaces:

RuleSet

public class FromXmlRuleSet

extends RuleSetBase

A Digester rule set where the rules come from an XML file.

Author:

David H. Martin - Initial Contribution, Scott Sanders - Added ASL, removed external dependencies, Henri Chen - Added rulesDigester

Field Summary

static java.lang.String	DIGESTER_DTD_PATH
private DigesterRuleParser	parser The rule set for parsing the Digester rules
private Digester	rulesDigester The digester for loading the rules xml.
private java.net.URL	xmlRules The file containing the Digester rules, in XML.

Fields inherited from class org.apache.commons.digester.RuleSetBase

namespaceURI

Constructor Summary

FromXmlRuleSet(java.net.URL rulesXml)
Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.

FromXmlRuleSet(java.net.URL rulesXml, Digester rulesDigester)
Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.

FromXmlRuleSet(java.net.URL rulesXml, DigesterRuleParser parser)

FromXmlRuleSet(java.net.URL rulesXml, DigesterRuleParser parser, Digester rulesDigester)

Method Summary

void	addRuleInstances(Digester digester) Adds to the digester the set of Rule instances defined in the XML file for this rule set.

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

DIGESTER_DTD_PATH

public static final java.lang.String DIGESTER_DTD_PATH

See Also:

Constant Field Values

xmlRules

private java.net.URL xmlRules

The file containing the Digester rules, in XML.

parser

private DigesterRuleParser parser

The rule set for parsing the Digester rules

rulesDigester

private Digester rulesDigester

The digester for loading the rules xml.

Constructor Detail

FromXmlRuleSet

public FromXmlRuleSet(java.net.URL rulesXml)

Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.

Parameters:

rulesXml - the path to the XML document defining the Digester rules

FromXmlRuleSet

public FromXmlRuleSet(java.net.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

FromXmlRuleSet

public FromXmlRuleSet(java.net.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

FromXmlRuleSet

public FromXmlRuleSet(java.net.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.

Method Detail

addRuleInstances

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.

Specified by:

addRuleInstances in interface RuleSet

Specified by:

addRuleInstances in class RuleSetBase

Parameters:

digester - Digester instance to which the new Rule instances should be added.

XmlLoadException

See Also:

RuleSetBase