Package | Description |
---|---|
org.apache.commons.digester |
The Digester package provides for rules-based processing of arbitrary
XML documents.
|
org.apache.commons.digester.plugins |
Provides an easy mechanism whereby new digestion rules
can be added dynamically during a digestion.
|
org.apache.commons.digester.plugins.strategies |
This package contains "rule-finding" strategy classes, and their associated
"helper" loader classes.
|
org.apache.commons.digester.xmlrules |
The
xmlrules package provides for XML-based definition of
rules for Digester . |
Modifier and Type | Field and Description |
---|---|
protected Digester |
RulesBase.digester
The Digester instance with which this Rules instance is associated.
|
protected Digester |
Rule.digester
The Digester with which this Rule is associated.
|
protected Digester |
AbstractObjectCreationFactory.digester
The associated
Digester instance that was set up by
FactoryCreateRule upon initialization. |
Modifier and Type | Method and Description |
---|---|
Digester |
RulesBase.getDigester()
Return the Digester instance with which this Rules instance is
associated.
|
Digester |
Rule.getDigester()
Return the Digester with which this Rule is associated.
|
Digester |
ObjectCreationFactory.getDigester()
Returns the
Digester that was set by the
FactoryCreateRule upon initialization. |
Digester |
WithDefaultsRulesWrapper.getDigester()
Gets digester using these Rules
|
Digester |
AbstractRulesImpl.getDigester()
Return the Digester instance with which this Rules instance is
associated.
|
Digester |
AbstractObjectCreationFactory.getDigester()
Returns the
Digester that was set by the
FactoryCreateRule upon initialization. |
Digester |
Rules.getDigester()
Return the Digester instance with which this Rules instance is
associated.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
RuleSetBase.addRuleInstances(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). |
void |
RuleSet.addRuleInstances(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). |
Object |
StackAction.onPop(Digester d,
String stackName,
Object o)
Invoked just after an object has been popped from a digester stack.
|
Object |
StackAction.onPush(Digester d,
String stackName,
Object o)
Invoked just before an object is to be pushed onto a digester stack.
|
void |
RulesBase.setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.
|
void |
Rule.setDigester(Digester digester)
Set the
Digester with which this Rule is associated. |
void |
ObjectCreationFactory.setDigester(Digester digester)
Set the
Digester to allow the implementation to do logging,
classloading based on the digester's classloader, etc. |
void |
CallMethodRule.setDigester(Digester digester)
Set the associated digester.
|
void |
WithDefaultsRulesWrapper.setDigester(Digester digester)
Sets digeseter using these Rules
|
void |
SetNestedPropertiesRule.setDigester(Digester digester)
Invoked when rule is added to digester.
|
void |
AbstractRulesImpl.setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.
|
void |
AbstractObjectCreationFactory.setDigester(Digester digester)
Set the
Digester to allow the implementation to do logging,
classloading based on the digester's classloader, etc. |
void |
Rules.setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.
|
Modifier and Type | Field and Description |
---|---|
protected Digester |
PluginRules.digester
The Digester instance with which this Rules instance is associated.
|
Modifier and Type | Method and Description |
---|---|
Digester |
PluginRules.getDigester()
Return the Digester instance with which this instance is associated.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
RuleLoader.addRules(Digester d,
String path)
Configures the digester with custom rules for some plugged-in
class.
|
void |
Declaration.configure(Digester digester,
String pattern)
Attempt to load custom rules for the target class at the specified
pattern.
|
static void |
PluginDeclarationRule.declarePlugin(Digester digester,
Properties props) |
abstract RuleLoader |
RuleFinder.findLoader(Digester d,
Class pluginClass,
Properties p)
Apply the finder algorithm to attempt to locate a source of
digester rules for the specified plugin class.
|
RuleLoader |
PluginManager.findLoader(Digester digester,
String id,
Class pluginClass,
Properties props)
Given a plugin class and some associated properties, scan the
list of known RuleFinder instances until one detects a source of
custom rules for this plugin (aka a RuleLoader).
|
void |
Declaration.init(Digester digester,
PluginManager pm)
Must be called exactly once, and must be called before any call
to the configure method.
|
abstract Rules |
RulesFactory.newRules(Digester d,
Class pluginClass)
Return an instance of some Rules implementation that the plugged-in
class shall use to match its private parsing rules.
|
void |
PluginRules.setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.
|
Modifier and Type | Method and Description |
---|---|
void |
LoaderSetProperties.addRules(Digester digester,
String path)
Just add a SetPropertiesRule at the specified path.
|
void |
LoaderFromClass.addRules(Digester d,
String path)
Just invoke the target method.
|
void |
LoaderFromStream.addRules(Digester d,
String path)
Add the rules previously loaded from the input stream into the
specified digester.
|
RuleLoader |
FinderSetProperties.findLoader(Digester d,
Class pluginClass,
Properties p)
Returns a RuleLoader unless the properties contain an entry
with the name matching constructor param propsAttr, and the value
matching what is in falseval.
|
RuleLoader |
FinderFromDfltMethod.findLoader(Digester d,
Class pluginClass,
Properties p)
If there exists on the plugin class a method with name matching the
constructor's methodName value then locate the appropriate Method on
the plugin class and return an object encapsulating that info.
|
RuleLoader |
FinderFromClass.findLoader(Digester digester,
Class pluginClass,
Properties p)
If there exists a property with the name matching constructor param
ruleClassAttr, then load the specified class, locate the appropriate
rules-adding method on that class, and return an object encapsulating
that info.
|
RuleLoader |
FinderFromFile.findLoader(Digester d,
Class pluginClass,
Properties p)
If there exists a property with the name specified in the constructor,
then load that file, run it through the xmlrules module and return an
object encapsulating those rules.
|
RuleLoader |
FinderFromResource.findLoader(Digester d,
Class pluginClass,
Properties p)
If there exists a property with the name matching constructor param
resourceAttr, then load that file, run it through the xmlrules
module and return an object encapsulating those rules.
|
RuleLoader |
FinderFromDfltClass.findLoader(Digester digester,
Class pluginClass,
Properties p)
If there exists a class whose name is the plugin class name + the
suffix specified to the constructor, then load that class, locate
the appropriate rules-adding method on that class, and return an
object encapsulating that info.
|
RuleLoader |
FinderFromMethod.findLoader(Digester d,
Class pluginClass,
Properties p)
If there exists a property with the name matching constructor param
methodAttr, then locate the appropriate Method on the plugin class
and return an object encapsulating that info.
|
RuleLoader |
FinderFromDfltResource.findLoader(Digester d,
Class pluginClass,
Properties p)
If there exists a resource file whose name is equal to the plugin
class name + the suffix specified in the constructor, then
load that file, run it through the xmlrules module and return an object
encapsulating those rules.
|
static RuleLoader |
FinderFromResource.loadRules(Digester d,
Class pluginClass,
InputStream is,
String resourceName)
Open the specified resource file (ie a file in the classpath,
including being within a jar in the classpath), run it through
the xmlrules module and return an object encapsulating those rules.
|
Modifier and Type | Field and Description |
---|---|
protected Digester |
DigesterRuleParser.targetDigester
This is the digester to which we are adding the rules that we parse
from the Rules XML document.
|
Modifier and Type | Method and Description |
---|---|
static Digester |
DigesterLoader.createDigester(InputSource rulesSource)
Creates a new digester and initializes it from the specified InputSource
|
static Digester |
DigesterLoader.createDigester(InputSource rulesSource,
Digester rulesDigester)
Creates a new digester and initializes it from the specified InputSource.
|
static Digester |
DigesterLoader.createDigester(URL rulesXml)
Creates a new digester and initializes it from the specified XML file
|
static Digester |
DigesterLoader.createDigester(URL rulesXml,
Digester rulesDigester)
Creates a new digester and initializes it from the specified XML file.
|
Modifier and Type | Method and Description |
---|---|
void |
FromXmlRuleSet.addRuleInstances(Digester digester)
Adds to the digester the set of Rule instances defined in the
XML file for this rule set.
|
void |
DigesterRuleParser.addRuleInstances(Digester digester)
Add to the given digester the set of Rule instances used to parse an XML
document defining Digester rules.
|
void |
FromXmlRuleSet.addRuleInstances(Digester digester,
String basePath)
Adds to the digester the set of Rule instances defined in the
XML file for this rule set.
|
static Digester |
DigesterLoader.createDigester(InputSource rulesSource,
Digester rulesDigester)
Creates a new digester and initializes it from the specified InputSource.
|
static Digester |
DigesterLoader.createDigester(URL rulesXml,
Digester rulesDigester)
Creates a new digester and initializes it from the specified XML file.
|
void |
DigesterRulesSource.getRules(Digester digester)
Creates and adds Digester Rules to a given Rules object
|
void |
DigesterRuleParser.setTarget(Digester d)
Sets the digester into which to add the parsed rules
|
Constructor and Description |
---|
DigesterRuleParser(Digester targetDigester)
Constructs a rule set for converting XML digester rule descriptions
into Rule objects, and adding them to the given Digester
|
FromXmlRuleSet(InputSource inputSource,
Digester rulesDigester)
Constructs a FromXmlRuleSet using the default DigesterRuleParser and
a ruleDigester for loading the rules xml.
|
FromXmlRuleSet(InputSource inputSource,
DigesterRuleParser parser,
Digester rulesDigester) |
FromXmlRuleSet(URL rulesXml,
Digester rulesDigester)
Constructs a FromXmlRuleSet using the default DigesterRuleParser and
a ruleDigester for loading the rules xml.
|
FromXmlRuleSet(URL rulesXml,
DigesterRuleParser parser,
Digester rulesDigester) |
Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.