Class FromXmlRuleSet

  • All Implemented Interfaces:
    RuleSet

    public class FromXmlRuleSet
    extends RuleSetBase
    A Digester rule set where the rules come from an XML file.
    Since:
    1.2
    • 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
        rulesDigester - the digester to read the rules xml.
      • 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.
      • FromXmlRuleSet

        public FromXmlRuleSet​(org.xml.sax.InputSource inputSource)
        Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.
        Parameters:
        inputSource - load the xml rules from this InputSource
      • FromXmlRuleSet

        public FromXmlRuleSet​(org.xml.sax.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.
      • FromXmlRuleSet

        public FromXmlRuleSet​(org.xml.sax.InputSource inputSource,
                              DigesterRuleParser parser)
        Parameters:
        inputSource - load the xml rules from this InputSource
        parser - an instance of DigesterRuleParser, for parsing the rules from XML
      • FromXmlRuleSet

        public FromXmlRuleSet​(org.xml.sax.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 Detail

      • addRuleInstances

        public void addRuleInstances​(Digester digester,
                                     java.lang.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.

        Parameters:
        digester - is the digester that rules will be added to.
        basePath - is a path that will be prefixed to every pattern string defined in the xmlrules input file.
        Throws:
        XmlLoadException
        Since:
        1.6
        See Also:
        RuleSetBase