|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.digester.RuleSetBase
org.apache.commons.digester.xmlrules.DigesterRuleParser
This is a RuleSet that parses XML into Digester rules, and then adds those rules to a 'target' Digester.
| Nested Class Summary | |
private class |
DigesterRuleParser.BeanPropertySetterRuleFactory
Factory for creating a BeanPropertySetterRule. |
protected class |
DigesterRuleParser.CallMethodRuleFactory
Factory for creating a CallMethodRule. |
protected class |
DigesterRuleParser.CallParamRuleFactory
Factory for creating a CallParamRule. |
protected class |
DigesterRuleParser.FactoryCreateRuleFactory
Factory for creating a FactoryCreateRule |
private class |
DigesterRuleParser.IncludeRule
A rule for including one rules XML file within another. |
protected class |
DigesterRuleParser.ObjectCreateRuleFactory
Factory for creating a ObjectCreateRule |
protected class |
DigesterRuleParser.ObjectParamRuleFactory
Factory for creating a ObjectParamRule |
private class |
DigesterRuleParser.PatternRule
A rule for extracting the pattern matching strings from the rules XML. |
protected class |
DigesterRuleParser.PatternStack
A stack whose toString method returns a '/'-separated concatenation of all the elements in the stack. |
private class |
DigesterRuleParser.RulesPrefixAdapter
Wraps a Rules object. |
protected class |
DigesterRuleParser.SetNextRuleFactory
Factory for creating a SetNextRuleFactory |
protected class |
DigesterRuleParser.SetPropertiesAliasRule
A rule for adding a attribute-property alias to the custom alias mappings of the containing SetPropertiesRule rule. |
protected class |
DigesterRuleParser.SetPropertiesRuleFactory
Factory for creating a SetPropertiesRule |
protected class |
DigesterRuleParser.SetPropertyRuleFactory
Factory for creating a SetPropertyRule |
protected class |
DigesterRuleParser.SetRootRuleFactory
Factory for creating a SetRootRuleFactory |
protected class |
DigesterRuleParser.SetTopRuleFactory
Factory for creating a SetTopRuleFactory |
| Field Summary | |
protected java.lang.String |
basePath
See setBasePath(java.lang.String). |
static java.lang.String |
DIGESTER_PUBLIC_ID
|
private java.lang.String |
digesterDtdUrl
path to the DTD |
private java.util.Set |
includedFiles
Used to detect circular includes |
protected DigesterRuleParser.PatternStack |
patternStack
A stack used to maintain the current pattern. |
protected Digester |
targetDigester
This is the digester to which we are adding the rules that we parse from the Rules XML document. |
| Fields inherited from class org.apache.commons.digester.RuleSetBase |
namespaceURI |
| Constructor Summary | |
|
DigesterRuleParser()
Constructs a DigesterRuleParser. |
|
DigesterRuleParser(Digester targetDigester)
Constructs a rule set for converting XML digester rule descriptions into Rule objects, and adding them to the given Digester |
private |
DigesterRuleParser(Digester targetDigester,
DigesterRuleParser.PatternStack stack,
java.util.Set includedFiles)
Constructs a rule set for parsing an XML digester rule file that has been included within an outer XML digester rule file. |
| Method Summary | |
void |
add(Rule rule)
Adds a rule the the target digester. |
void |
addRuleInstances(Digester digester)
Add to the given digester the set of Rule instances used to parse an XML document defining Digester rules. |
protected java.lang.String |
getDigesterRulesDTD()
Returns the location of the DTD used to validate the digester rules XML document. |
void |
setBasePath(java.lang.String path)
Set a base pattern beneath which all the rules loaded by this object will be registered. |
void |
setDigesterRulesDTD(java.lang.String dtdURL)
Sets the location of the digester rules DTD. |
void |
setTarget(Digester d)
Sets the digester into which to add the parsed rules |
| 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 |
public static final java.lang.String DIGESTER_PUBLIC_ID
private java.lang.String digesterDtdUrl
protected Digester targetDigester
protected java.lang.String basePath
setBasePath(java.lang.String).
protected DigesterRuleParser.PatternStack patternStack
private java.util.Set includedFiles
| Constructor Detail |
public DigesterRuleParser()
setTarget(Digester)
public DigesterRuleParser(Digester targetDigester)
targetDigester - the Digester to add the rules to
private DigesterRuleParser(Digester targetDigester,
DigesterRuleParser.PatternStack stack,
java.util.Set includedFiles)
targetDigester - the Digester to add the rules tostack - Stack containing the prefix pattern string to be prepended
to any pattern parsed by this rule set.| Method Detail |
public void setTarget(Digester d)
d - the Digester to add the rules topublic void setBasePath(java.lang.String path)
public void setDigesterRulesDTD(java.lang.String dtdURL)
protected java.lang.String getDigesterRulesDTD()
public void add(Rule rule)
rule - a Rule to add to the target digester.public void addRuleInstances(Digester digester)
If you extend this class to support additional rules, your implementation
should of this method should call this implementation first: i.e.
super.addRuleInstances(digester);
addRuleInstances in interface RuleSetaddRuleInstances in class RuleSetBasedigester - Digester instance to which the new Rule instances
should be added.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||