Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
DefaultHandler
org.apache.commons.digester.Digester
public class Digester
extends DefaultHandler
XmlMapper
class that was part of Tomcat 3.0 and 3.1,
but is organized somewhat differently.
See the Digester
Developer Guide for more information.
IMPLEMENTATION NOTE - A single Digester instance may
only be used within the context of a single thread at a time, and a call
to parse()
must be completed before another can be initiated
even from the same thread.
IMPLEMENTATION NOTE - A bug in Xerces 2.0.2 prevents
the support of XML schema. You need Xerces 2.1/2.3 and up to make
this class working with XML schema
Field Summary | |
protected String |
|
private static String |
|
protected static String |
|
protected StringBuffer |
|
protected ArrayStack |
|
protected ClassLoader |
|
protected boolean |
|
private ContentHandler |
|
protected EntityResolver |
|
protected HashMap |
|
protected ErrorHandler |
|
protected SAXParserFactory |
|
protected List |
|
protected Locator |
|
protected Log |
|
protected String |
|
protected ArrayStack |
|
protected boolean |
|
protected HashMap |
|
protected ArrayStack |
|
protected SAXParser |
|
protected String |
|
protected XMLReader |
|
protected Object |
|
protected Rules |
|
protected Log |
|
protected String |
|
protected String |
|
protected ArrayStack |
|
private StackAction |
|
private HashMap |
|
protected Substitutor |
|
protected boolean |
|
protected boolean |
|
Constructor Summary | |
| |
| |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
void |
|
protected void |
|
InputSource |
|
InputSource |
|
SAXException |
|
SAXException |
|
SAXException |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
ClassLoader |
|
int |
|
String |
|
Map |
|
ContentHandler | |
int |
|
Locator |
|
EntityResolver |
|
ErrorHandler |
|
SAXParserFactory |
|
boolean |
|
Log |
|
String |
|
boolean |
|
SAXParser |
|
Object |
|
String |
|
XMLReader |
|
(package private) Map |
|
Object |
|
String |
|
Rules |
|
(package private) List |
|
Log |
|
String |
|
String |
|
StackAction |
|
Substitutor |
|
boolean |
|
boolean |
|
XMLReader |
|
void |
|
protected void |
|
boolean |
|
void |
|
void |
|
void |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
Object |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
InputSource |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected String JAXP_SCHEMA_LANGUAGE
Deprecated. This is now managed by
ParserFeatureSetterFactory
private static final String JAXP_SCHEMA_SOURCE
The JAXP 1.2 property required to set up the schema location. Removed in digester 1.6 - introduced for tomcat4 backport
protected static final String W3C_XML_SCHEMA
The schema language supported. By default, we use this one.
protected StringBuffer bodyText
The body text of the current element.
protected ArrayStack bodyTexts
The stack of body text string buffers for surrounding elements.
protected ClassLoader classLoader
The class loader to use for instantiating application objects. If not specified, the context class loader, or the class loader used to load Digester itself, is used, based on the value of theuseContextClassLoader
variable.
protected boolean configured
Has this Digester been configured yet.
private ContentHandler customContentHandler
If not null, then calls by the parser to this object's characters, startElement, endElement and processingInstruction methods are forwarded to the specified object. This is intended to allow rules to temporarily "take control" of the sax events. In particular, this is used by NodeCreateRule. See setCustomContentHandler.
protected EntityResolver entityResolver
The EntityResolver used by the SAX parser. By default it use this class
protected HashMap entityValidator
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.
protected ErrorHandler errorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.
protected SAXParserFactory factory
The SAXParserFactory that is created the first time we need it.
protected List inputSources
List
ofInputSource
instances created by acreateInputSourceFromURL()
method call. These represent open input streams that need to be closed to avoid resource leaks, as well as potentially locked JAR files on Windows.
protected Locator locator
The Locator associated with our parser.
protected Log log
The Log to which most logging calls will be made.
protected String match
The current match pattern for nested element processing.
protected ArrayStack matches
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch(). As each xml element in the input is entered, the matching rules are pushed onto this stack. After the end tag is reached, the matches are popped again. The depth of is stack is therefore exactly the same as the current "nesting" level of the input xml.
- Since:
- 1.6
protected boolean namespaceAware
Do we want a "namespace aware" parser.
protected HashMap namespaces
Registered namespaces we are currently processing. The key is the namespace prefix that was declared in the document. The value is an ArrayStack of the namespace URIs this prefix has been mapped to -- the top Stack element is the most current one. (This architecture is required because documents can declare nested uses of the same prefix for different Namespace URIs).
protected ArrayStack params
The parameters stack being utilized by CallMethodRule and CallParamRule rules.
protected SAXParser parser
The SAXParser we will use to parse the input stream.
protected String publicId
The public identifier of the DTD we are currently parsing under (if any).
protected XMLReader reader
The XMLReader used to parse digester rules.
protected Object root
The "root" element of the stack (in other words, the last object that was popped.
protected Rules rules
TheRules
implementation containing our collection ofRule
instances and associated matching policy. If not established before the first rule is added, a default implementation will be provided.
protected Log saxLog
The Log to which all SAX event related logging calls will be made.
protected String schemaLanguage
The XML schema language to use for validating an XML instance. By default this value is set toW3C_XML_SCHEMA
protected String schemaLocation
The XML schema to use for validating an XML instance.
protected ArrayStack stack
The object stack being constructed.
private StackAction stackAction
Object which will receive callbacks for every pop/push action on the default stack or named stacks.
private HashMap stacksByName
Stacks used for interrule communication, indexed by name String
protected Substitutor substitutor
An optional class that substitutes values in attributes and body text. This may be null and so a null check is always required before use.
protected boolean useContextClassLoader
Do we want to use the Context ClassLoader when loading classes for instantiating new objects. Default isfalse
.
protected boolean validating
Do we want to use a validating parser.
public Digester()
Construct a new Digester with default properties.
public Digester(SAXParser parser)
Construct a new Digester, allowing a SAXParser to be passed in. This allows Digester to be used in environments which are unfriendly to JAXP1.1 (such as WebLogic 6.0). This may help in places where you are able to load JAXP 1.1 classes yourself.
public Digester(XMLReader reader)
Construct a new Digester, allowing an XMLReader to be passed in. This allows Digester to be used in environments which are unfriendly to JAXP1.1 (such as WebLogic 6.0). Note that if you use this option you have to configure namespace and validation support yourself, as these properties only affect the SAXParser and emtpy constructor.
public void addBeanPropertySetter(String pattern)
Add a "bean property setter" rule for the specified parameters.
- Parameters:
pattern
- Element matching pattern
- See Also:
BeanPropertySetterRule
public void addBeanPropertySetter(String pattern, String propertyName)
Add a "bean property setter" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternpropertyName
- Name of property to set
- See Also:
BeanPropertySetterRule
public void addCallMethod(String pattern, String methodName)
Add an "call method" rule for a method which accepts no arguments.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to be called
- See Also:
CallMethodRule
public void addCallMethod(String pattern, String methodName, int paramCount)
Add an "call method" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)
- See Also:
CallMethodRule
public void addCallMethod(String pattern, String methodName, int paramCount, paramTypes[] )
Add an "call method" rule for the specified parameters. IfparamCount
is set to zero the rule will use the body of the matched element as the single argument of the method, unlessparamTypes
is null or empty, in this case the rule will call the specified method with no arguments.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)
- See Also:
CallMethodRule
public void addCallMethod(String pattern, String methodName, int paramCount, paramTypes[] )
Add an "call method" rule for the specified parameters. IfparamCount
is set to zero the rule will use the body of the matched element as the single argument of the method, unlessparamTypes
is null or empty, in this case the rule will call the specified method with no arguments.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)
- See Also:
CallMethodRule
public void addCallParam(String pattern, int paramIndex)
Add a "call parameter" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternparamIndex
- Zero-relative parameter index to set (from the body of this element)
- See Also:
CallParamRule
public void addCallParam(String pattern, int paramIndex, String attributeName)
Add a "call parameter" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternparamIndex
- Zero-relative parameter index to set (from the specified attribute)attributeName
- Attribute whose value is used as the parameter value
- See Also:
CallParamRule
public void addCallParam(String pattern, int paramIndex, boolean fromStack)
Add a "call parameter" rule. This will either take a parameter from the stack or from the current element body text.
- Parameters:
paramIndex
- The zero-relative parameter numberfromStack
- Should the call parameter be taken from the top of the stack?
- See Also:
CallParamRule
public void addCallParam(String pattern, int paramIndex, int stackIndex)
Add a "call parameter" rule that sets a parameter from the stack. This takes a parameter from the given position on the stack.
- Parameters:
paramIndex
- The zero-relative parameter numberstackIndex
- set the call parameter to the stackIndex'th object down the stack, where 0 is the top of the stack, 1 the next element down and so on
- See Also:
CallMethodRule
public void addCallParamPath(String pattern, int paramIndex)
Add a "call parameter" rule that sets a parameter from the currentDigester
matching path. This is sometimes useful when using rules that support wildcards.
- Parameters:
pattern
- the pattern that this rule should matchparamIndex
- The zero-relative parameter number
- See Also:
CallMethodRule
public void addFactoryCreate(String pattern, Class clazz)
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.
- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory class
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, Class clazz, String attributeName)
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.
- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, Class clazz, String attributeName, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
ignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, Class clazz, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, String className)
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.
- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory class
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, String className, String attributeName)
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.
- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, String className, String attributeName, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
ignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, String className, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, ObjectCreationFactory creationFactory)
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.
- Parameters:
pattern
- Element matching patterncreationFactory
- Previously instantiated ObjectCreationFactory to be utilized
- See Also:
FactoryCreateRule
public void addFactoryCreate(String pattern, ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patterncreationFactory
- Previously instantiated ObjectCreationFactory to be utilizedignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.
- See Also:
FactoryCreateRule
public void addObjectCreate(String pattern, Class clazz)
Add an "object create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclazz
- Java class to be created
- See Also:
ObjectCreateRule
public void addObjectCreate(String pattern, String className)
Add an "object create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclassName
- Java class name to be created
- See Also:
ObjectCreateRule
public void addObjectCreate(String pattern, String attributeName, Class clazz)
Add an "object create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternattributeName
- Attribute name that optionally overridesclazz
- Default Java class to be created the default Java class name to be created
- See Also:
ObjectCreateRule
public void addObjectCreate(String pattern, String className, String attributeName)
Add an "object create" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternclassName
- Default Java class name to be createdattributeName
- Attribute name that optionally overrides the default Java class name to be created
- See Also:
ObjectCreateRule
public void addObjectParam(String pattern, int paramIndex, Object paramObj)
Add a "call parameter" rule that sets a parameter from a caller-provided object. This can be used to pass constants such as strings to methods; it can also be used to pass mutable objects, providing ways for objects to do things like "register" themselves with some shared object. Note that when attempting to locate a matching method to invoke, the true type of the paramObj is used, so that despite the paramObj being passed in here as type Object, the target method can declare its parameters as being the true type of the object (or some ancestor type, according to the usual type-conversion rules).
- Parameters:
paramIndex
- The zero-relative parameter numberparamObj
- Any arbitrary object to be passed to the target method.
- Since:
- 1.6
- See Also:
CallMethodRule
public void addRule(String pattern, Rule rule)
Register a new Rule matching the specified pattern. This method sets theDigester
property on the rule.
- Parameters:
pattern
- Element matching patternrule
- Rule to be registered
public void addRuleSet(RuleSet ruleSet)
Register a set of Rule instances defined in a RuleSet.
- Parameters:
ruleSet
- The RuleSet instance to configure from
public void addSetNestedProperties(String pattern)
Adds anSetNestedPropertiesRule
.
- Parameters:
pattern
- register the rule with this pattern
- Since:
- 1.6
public void addSetNestedProperties(String pattern, String elementName, String propertyName)
Adds anSetNestedPropertiesRule
.
- Parameters:
pattern
- register the rule with this patternelementName
- elment name that a property maps topropertyName
- property name of the element mapped from
- Since:
- 1.6
public void addSetNestedProperties(String pattern, String[] elementNames, String[] propertyNames)
Adds anSetNestedPropertiesRule
.
- Parameters:
pattern
- register the rule with this patternelementNames
- elment names that (in order) map to propertiespropertyNames
- property names that (in order) elements are mapped to
- Since:
- 1.6
public void addSetNext(String pattern, String methodName)
Add a "set next" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element
- See Also:
SetNextRule
public void addSetNext(String pattern, String methodName, String paramType)
Add a "set next" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent elementparamType
- Java class name of the expected parameter type (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)
- See Also:
SetNextRule
public void addSetProperties(String pattern)
Add a "set properties" rule for the specified parameters.
- Parameters:
pattern
- Element matching pattern
- See Also:
SetPropertiesRule
public void addSetProperties(String pattern, String attributeName, String propertyName)
Add a "set properties" rule with a single overridden parameter. SeeSetPropertiesRule.SetPropertiesRule(String attributeName, String propertyName)
- Parameters:
pattern
- Element matching patternattributeName
- map this attributepropertyName
- to this property
- See Also:
SetPropertiesRule
public void addSetProperties(String pattern, String[] attributeNames, String[] propertyNames)
Add a "set properties" rule with overridden parameters. SeeSetPropertiesRule.SetPropertiesRule(String [] attributeNames, String [] propertyNames)
- Parameters:
pattern
- Element matching patternattributeNames
- names of attributes with custom mappingspropertyNames
- property names these attributes map to
- See Also:
SetPropertiesRule
public void addSetProperty(String pattern, String name, String value)
Add a "set property" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternname
- Attribute name containing the property name to be setvalue
- Attribute name containing the property value to set
- See Also:
SetPropertyRule
public void addSetRoot(String pattern, String methodName)
AddSetRootRule
with the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the root object
- See Also:
SetRootRule
public void addSetRoot(String pattern, String methodName, String paramType)
AddSetRootRule
with the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the root objectparamType
- Java class name of the expected parameter type
- See Also:
SetRootRule
public void addSetTop(String pattern, String methodName)
Add a "set top" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element
- See Also:
SetTopRule
public void addSetTop(String pattern, String methodName, String paramType)
Add a "set top" rule for the specified parameters.
- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent elementparamType
- Java class name of the expected parameter type (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)
- See Also:
SetTopRule
public void characters(buffer[] , int start, int length) throws SAXException
Process notification of character data received from the body of an XML element.
- Parameters:
start
- Starting offset into the bufferlength
- Number of characters from the buffer
protected void cleanup()
Clean up allocated resources after parsing is complete. The default method closes input streams that have been created by Digester itself. If you override this method in a subclass, be sure to callsuper.cleanup()
to invoke this logic.
- Since:
- 1.8
public void clear()
Clear the current contents of the default object stack, the param stack, all named stacks, and other internal variables. Calling this method might allow another document of the same type to be correctly parsed. However this method was not intended for this purpose. In general, a separate Digester object should be created for each document to be parsed.
protected void configure()
Provide a hook for lazy configuration of thisDigester
instance. The default implementation does nothing, but subclasses can override as needed. Note This method may be called more than once. Once only initialization code should be placed ininitialize()
or the code should take responsibility by checking and setting theconfigured
flag.
public InputSource createInputSourceFromURL(String url) throws MalformedURLException, IOException
Convenience method that creates anInputSource
from the string version of a URL.
- Parameters:
url
- URL for which to create anInputSource
- Since:
- 1.8
public InputSource createInputSourceFromURL(URL url) throws MalformedURLException, IOException
Given a URL, return an InputSource that reads from that URL. Ideally this function would not be needed and code could just usenew InputSource(entityURL)
. Unfortunately it appears that when the entityURL points to a file within a jar archive a caching mechanism inside the InputSource implementation causes a file-handle to the jar file to remain open. On Windows systems this then causes the jar archive file to be locked on disk ("in use") which makes it impossible to delete the jar file - and that really stuffs up "undeploy" in webapps in particular. In JDK1.4 and later, Apache XercesJ is used as the xml parser. The InputSource object provided is converted into an XMLInputSource, and eventually passed to an instance of XMLDocumentScannerImpl to specify the source data to be converted into tokens for the rest of the XMLReader code to handle. XMLDocumentScannerImpl calls fEntityManager.startDocumentEntity(source), where fEntityManager is declared in ancestor class XMLScanner to be an XMLEntityManager. In that class, if the input source stream is null, then:URL location = new URL(expandedSystemId); URLConnection connect = location.openConnection(); if (connect instanceof HttpURLConnection) { setHttpProperties(connect,xmlInputSource); } stream = connect.getInputStream();This method pretty much duplicates the standard behaviour, except that it calls URLConnection.setUseCaches(false) before opening the connection.
- Since:
- 1.8
public SAXException createSAXException(Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- Returns:
- the new exception
public SAXException createSAXException(String message)
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- Returns:
- the new exception
public SAXException createSAXException(String message, Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- Returns:
- the new exception
public void endDocument() throws SAXException
Process notification of the end of the document being reached.
public void endElement(String namespaceURI, String localName, String qName) throws SAXException
Process notification of the end of an XML element being reached.
- Parameters:
namespaceURI
- - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName
- - The qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.
public void endPrefixMapping(String prefix) throws SAXException
Process notification that a namespace prefix is going out of scope.
- Parameters:
prefix
- Prefix that is going out of scope
public void error(SAXParseException exception) throws SAXException
Forward notification of a parsing error to the application supplied error handler (if any).
- Parameters:
exception
- The error information
public void fatalError(SAXParseException exception) throws SAXException
Forward notification of a fatal parsing error to the application supplied error handler (if any).
- Parameters:
exception
- The fatal error information
public String findNamespaceURI(String prefix)
Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull
. These mappings come and go dynamically as the document is parsed.
- Parameters:
prefix
- Prefix to look up
public ClassLoader getClassLoader()
Return the class loader to be used for instantiating application objects when required. This is determined based upon the following rules:
- The class loader set by
setClassLoader()
, if any- The thread context class loader, if it exists and the
useContextClassLoader
property is set to true- The class loader used to load the Digester class itself.
public int getCount()
Return the current depth of the element stack.
public String getCurrentElementName()
Return the name of the XML element that is currently being processed.
public Map getCurrentNamespaces()
Get the most current namespaces for all prefixes.
- Returns:
- Map A map with namespace prefixes as keys and most current namespace URIs for the corresponding prefixes as values
- Since:
- 1.8
public ContentHandler getCustomContentHandler()
public int getDebug()
Deprecated. This method now always returns 0. Digester uses the apache jakarta commons-logging library; see the documentation for that library for more information.
Return the debugging detail level of our currently enabled logger.
public Locator getDocumentLocator()
Gets the document locator associated with our parser.
- Returns:
- the Locator supplied by the document parser
public EntityResolver getEntityResolver()
Return the Entity Resolver used by the SAX parser.
- Returns:
- Return the Entity Resolver used by the SAX parser.
public ErrorHandler getErrorHandler()
Return the error handler for this Digester.
public SAXParserFactory getFactory()
Return the SAXParserFactory we will use, creating one if necessary.
public boolean getFeature(String feature) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
Returns a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
. See the saxproject website for information about the standard SAX2 feature flags.
- Parameters:
feature
- Name of the feature to inquire about
public Log getLogger()
Return the current Logger associated with this instance of the Digester
public String getMatch()
Return the current rule match path
public boolean getNamespaceAware()
Return the "namespace aware" flag for parsers we create.
public SAXParser getParser()
Return the SAXParser we will use to parse the input stream. If there is a problem creating the parser, returnnull
.
public Object getProperty(String property) throws SAXNotRecognizedException, SAXNotSupportedException
Return the current value of the specified property for the underlyingXMLReader
implementation. See the saxproject website for information about the standard SAX2 properties.
- Parameters:
property
- Property name to be retrieved
public String getPublicId()
Return the public identifier of the DTD we are currently parsing under, if any.
public XMLReader getReader()
Deprecated. Use getXMLReader() instead, which can throw a SAXException if the reader cannot be instantiated
By setting the reader in the constructor, you can bypass JAXP and be able to use digester in Weblogic 6.0.
(package private) Map getRegistrations()
Return the set of DTD URL registrations, keyed by public identifier.
public Object getRoot()
Returns the root element of the tree of objects created as a result of applying the rule objects to the input XML. If the digester stack was "primed" by explicitly pushing a root object onto the stack before parsing started, then that root object is returned here. Alternatively, if a Rule which creates an object (eg ObjectCreateRule) matched the root element of the xml, then the object created will be returned here. In other cases, the object most recently pushed onto an empty digester stack is returned. This would be a most unusual use of digester, however; one of the previous configurations is much more likely. Note that when using one of the Digester.parse methods, the return value from the parse method is exactly the same as the return value from this method. However when the Digester is being used as a SAXContentHandler, no such return value is available; in this case, this method allows you to access the root object that has been created after parsing has completed.
- Returns:
- the root object that has been created after parsing or null if the digester has not parsed any XML yet.
public String getRuleNamespaceURI()
Return the namespace URI that will be applied to all subsequently addedRule
objects.
public Rules getRules()
Return theRules
implementation object containing our rules collection and associated matching policy. If none has been established, a default implementation will be created and returned.
(package private) List getRules(String match)
Deprecated. Call
match()
on theRules
implementation returned bygetRules()
Return the set of rules that apply to the specified match position. The selected rules are those that match exactly, or those rules that specify a suffix match and the tail of the rule matches the current match position. Exact matches have precedence over suffix matches, then (among suffix matches) the longest match is preferred.
- Parameters:
match
- The current match position
public Log getSAXLogger()
Gets the logger used for logging SAX-related information. Note the output is finely grained.
- Since:
- 1.6
public String getSchema()
Return the XML Schema URI used for validating an XML instance.
public String getSchemaLanguage()
Return the XML Schema language used when parsing.
public Substitutor getSubstitutor()
Gets theSubstitutor
used to convert attributes and body text.
- Returns:
- Substitutor, null if not substitutions are to be performed.
public boolean getUseContextClassLoader()
Return the boolean as to whether the context classloader should be used.
public boolean getValidating()
Return the validating parser flag.
public XMLReader getXMLReader() throws SAXException
Return the XMLReader to be used for parsing the input document. FIX ME: there is a bug in JAXP/XERCES that prevent the use of a parser that contains a schema with a DTD.
public void ignorableWhitespace(buffer[] , int start, int len) throws SAXException
Process notification of ignorable whitespace received from the body of an XML element.
- Parameters:
start
- Starting offset into the bufferlen
- Number of characters from the buffer
protected void initialize()
Provides a hook for lazy initialization of thisDigester
instance. The default implementation does nothing, but subclasses can override as needed. Digester (by default) only calls this method once. Note This method will be called byconfigure()
only when theconfigured
flag is false. Subclasses that overrideconfigure
or who setconfigured
may find that this method may be called more than once.
- Since:
- 1.6
public boolean isEmpty(String stackName)
Is the stack with the given name empty? Note: a stack is considered empty if no objects have been pushed onto it yet.
- Parameters:
stackName
- the name of the stack whose emptiness should be evaluated
- Returns:
- true if the given stack if empty
- Since:
- 1.6
public void log(String message)
Deprecated. Call getLogger() and use it's logging methods
Log a message to our associated logger.
- Parameters:
message
- The message to be logged
public void log(String message, Throwable exception)
Deprecated. Call getLogger() and use it's logging methods
Log a message and exception to our associated logger.
- Parameters:
message
- The message to be logged
public void notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration event.
- Parameters:
name
- The notation namepublicId
- The public identifier (if any)systemId
- The system identifier (if any)
public Object parse(File file) throws IOException, SAXException
Parse the content of the specified file using this Digester. Returns the root element from the object stack (if any).
- Parameters:
file
- File containing the XML data to be parsed
public Object parse(InputSource input) throws IOException, SAXException
Parse the content of the specified input source using this Digester. Returns the root element from the object stack (if any).
- Parameters:
input
- Input source containing the XML data to be parsed
public Object parse(InputStream input) throws IOException, SAXException
Parse the content of the specified input stream using this Digester. Returns the root element from the object stack (if any).
- Parameters:
input
- Input stream containing the XML data to be parsed
public Object parse(Reader reader) throws IOException, SAXException
Parse the content of the specified reader using this Digester. Returns the root element from the object stack (if any).
- Parameters:
reader
- Reader containing the XML data to be parsed
public Object parse(String uri) throws IOException, SAXException
Parse the content of the specified URI using this Digester. Returns the root element from the object stack (if any).
- Parameters:
uri
- URI containing the XML data to be parsed
public Object parse(URL url) throws IOException, SAXException
Parse the content of the specified URL using this Digester. Returns the root element from the object stack (if any).
- Parameters:
- Since:
- 1.8
public Object peek()
Return the top object on the stack without removing it. If there are no objects on the stack, returnnull
.
public Object peek(String stackName)
Gets the top object from the stack with the given name. This method does not remove the object from the stack. Note: a stack is considered empty if no objects have been pushed onto it yet.
- Parameters:
stackName
- the name of the stack to be peeked
- Returns:
- the top
Object
on the stack or null if the stack is either empty or has not been created yet
- Since:
- 1.6
public Object peek(String stackName, int n)
Gets the top object from the stack with the given name. This method does not remove the object from the stack. Note: a stack is considered empty if no objects have been pushed onto it yet.
- Parameters:
stackName
- the name of the stack to be peekedn
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.
- Returns:
- the specified
Object
on the stack.
- Since:
- 1.6
public Object peek(int n)
Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element. If the specified index is out of range, returnnull
.
- Parameters:
n
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.
public Object peekParams()
Return the top object on the parameters stack without removing it. If there are no objects on the stack, returnnull
. The parameters stack is used to storeCallMethodRule
parameters. Seeparams
.
public Object peekParams(int n)
Return the n'th object down the parameters stack, where 0 is the top element and [getCount()-1] is the bottom element. If the specified index is out of range, returnnull
. The parameters stack is used to storeCallMethodRule
parameters. Seeparams
.
- Parameters:
n
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.
public Object pop()
Pop the top object off of the stack, and return it. If there are no objects on the stack, returnnull
.
public Object pop(String stackName)
Pops (gets and removes) the top object from the stack with the given name. Note: a stack is considered empty if no objects have been pushed onto it yet.
- Parameters:
stackName
- the name of the stack from which the top value is to be popped.
- Returns:
- the top
Object
on the stack or or null if the stack is either empty or has not been created yet
- Since:
- 1.6
public Object popParams()
Pop the top object off of the parameters stack, and return it. If there are no objects on the stack, returnnull
. The parameters stack is used to storeCallMethodRule
parameters. Seeparams
.
public void processingInstruction(String target, String data) throws SAXException
Process notification of a processing instruction that was encountered.
- Parameters:
target
- The processing instruction targetdata
- The processing instruction data (if any)
public void push(Object object)
Push a new object onto the top of the object stack.
- Parameters:
object
- The new object
public void push(String stackName, Object value)
Pushes the given object onto the stack with the given name. If no stack already exists with the given name then one will be created.
- Parameters:
stackName
- the name of the stack onto which the object should be pushedvalue
- the Object to be pushed onto the named stack.
- Since:
- 1.6
public void pushParams(Object object)
Push a new object onto the top of the parameters stack. The parameters stack is used to storeCallMethodRule
parameters. Seeparams
.
- Parameters:
object
- The new object
public void register(String publicId, String entityURL)
Convenience method that registers the string version of an entity URL instead of a URL version.
- Parameters:
publicId
- Public identifier of the entity to be resolvedentityURL
- The URL to use for reading this entity
public void register(String publicId, URL entityURL)
Register the specified DTD URL for the specified public identifier. This must be called before the first call toparse()
.Digester
contains an internalEntityResolver
implementation. This mapsPUBLICID
's to URLs (from which the resource will be loaded). A common use case for this method is to register local URLs (possibly computed at runtime by a classloader) for DTDs. This allows the performance advantage of using a local version without having to ensure everySYSTEM
URI on every processed xml document is local. This implementation provides only basic functionality. If more sophisticated features are required, usingsetEntityResolver(EntityResolver)
to set a custom resolver is recommended. Note: This method will have no effect when a customEntityResolver
has been set. (Setting a customEntityResolver
overrides the internal implementation.)
- Parameters:
publicId
- Public identifier of the DTD to be resolvedentityURL
- The URL to use for reading this DTD
- Since:
- 1.8
public void resetRoot()
This method allows the "root" variable to be reset to null. It is not considered safe for a digester instance to be reused to parse multiple xml documents. However if you are determined to do so, then you should call both clear() and resetRoot() before each parse.
- Since:
- 1.7
public InputSource resolveEntity(String publicId, String systemId) throws SAXException
Resolve the requested external entity.
- Parameters:
publicId
- The public identifier of the entity being referencedsystemId
- The system identifier of the entity being referenced
public void setClassLoader(ClassLoader classLoader)
Set the class loader to be used for instantiating application objects when required.
- Parameters:
classLoader
- The new class loader to use, ornull
to revert to the standard rules
public void setCustomContentHandler(ContentHandler handler)
Redirects (or cancels redirecting) of SAX ContentHandler events to an external object. When this object's customContentHandler is non-null, any SAX events received from the parser will simply be passed on to the specified object instead of this object handling them. This allows Rule classes to take control of the SAX event stream for a while in order to do custom processing. Such a rule should save the old value before setting a new one, and restore the old value in order to resume normal digester processing. An example of a Rule which needs this feature is NodeCreateRule. Note that saving the old value is probably not needed as it should always be null; a custom rule that wants to take control could only have been called when there was no custom content handler. But it seems cleaner to properly save/restore the value and maybe some day this will come in useful. Note also that this is not quite equivalent todigester.getXMLReader().setContentHandler(handler)for these reasons:
- Some xml parsers don't like having setContentHandler called after parsing has started. The Aelfred parser is one example.
- Directing the events via the Digester object potentially allows us to log information about those SAX events at the digester level.
- Since:
- 1.7
public void setDebug(int debug)
Deprecated. This method now has no effect at all. Digester uses the apache jakarta comons-logging library; see the documentation for that library for more information.
Set the debugging detail level of our currently enabled logger.
- Parameters:
debug
- New debugging detail level (0=off, increasing integers for more detail)
public void setDocumentLocator(Locator locator)
Sets the document locator associated with our parser.
- Parameters:
locator
- The new locator
public void setEntityResolver(EntityResolver entityResolver)
Set theEntityResolver
used by SAX when resolving public id and system id. This must be called before the first call toparse()
.
- Parameters:
entityResolver
- a class that implement theEntityResolver
interface.
public void setErrorHandler(ErrorHandler errorHandler)
Set the error handler for this Digester.
- Parameters:
errorHandler
- The new error handler
public void setFeature(String feature, boolean value) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
Sets a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
. See the saxproject website for information about the standard SAX2 feature flags. In order to be effective, this method must be called before thegetParser()
method is called for the first time, either directly or indirectly.
- Parameters:
feature
- Name of the feature to set the status forvalue
- The new value for this feature
public void setLogger(Log log)
Set the current logger for this Digester.
public void setNamespaceAware(boolean namespaceAware)
Set the "namespace aware" flag for parsers we create.
- Parameters:
namespaceAware
- The new "namespace aware" flag
public void setProperty(String property, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
Set the current value of the specified property for the underlyingXMLReader
implementation. See the saxproject website for information about the standard SAX2 properties.
- Parameters:
property
- Property name to be setvalue
- Property value to be set
public void setPublicId(String publicId)
Set the publid id of the current file being parse.
- Parameters:
publicId
- the DTD/Schema public's id.
public void setRuleNamespaceURI(String ruleNamespaceURI)
Set the namespace URI that will be applied to all subsequently addedRule
objects.
- Parameters:
ruleNamespaceURI
- Namespace URI that must match on all subsequently added rules, ornull
for matching regardless of the current namespace URI
public void setRules(Rules rules)
Set theRules
implementation object containing our rules collection and associated matching policy.
- Parameters:
rules
- New Rules implementation
public void setSAXLogger(Log saxLog)
Sets the logger used for logging SAX-related information. Note the output is finely grained.
- Parameters:
saxLog
- Log, not null
- Since:
- 1.6
public void setSchema(String schemaLocation)
Set the XML Schema URI used for validating the input XML. It is often desirable to force the input document to be validated against a particular schema regardless of what type the input document declares itself to be. This method allows that to be done. Note, however, that there is no standard API for enabling this feature on the underlying SAX parser; this method therefore only works for those parsers explicitly supported by Digester's ParserFeatureSetterFactory class. If the underlying parser does not support the feature, or is not one of the supported parsers, then an exception will be thrown when getParser is called (explicitly, or implicitly via the parse method). See also method setSchemaLanguage which allows the type of the schema specified here to be defined. By default, the schema is expected to be a W3C xml schema definition. IMPORTANT NOTE: This functionality was never very reliable, and has been horribly broken since the 1.6 release of Digester. There are currently no plans to fix it, so you are strongly recommended to avoid using this method. Instead, create an XMLParser instance yourself, configure validation appropriately, and pass it as a parameter to the Digester constructor.
- Parameters:
schemaLocation
- a URI to the schema.
public void setSchemaLanguage(String schemaLanguage)
Set the XML Schema language used when parsing. By default, we use W3C.
- Parameters:
schemaLanguage
- a URI to the schema language.
public void setStackAction(StackAction stackAction)
Define a callback object which is invoked whever an object is pushed onto a digester object stack, or popped off one.
- Since:
- 1.8
public void setSubstitutor(Substitutor substitutor)
Sets theSubstitutor
to be used to convert attributes and body text.
- Parameters:
substitutor
- the Substitutor to be used to convert attributes and body text or null if not substitution of these values is to be performed.
public void setUseContextClassLoader(boolean use)
Determine whether to use the Context ClassLoader (the one found by callingThread.currentThread().getContextClassLoader()
) to resolve/load classes that are defined in various rules. If not using Context ClassLoader, then the class-loading defaults to using the calling-class' ClassLoader.
- Parameters:
use
- determines whether to use Context ClassLoader.
public void setValidating(boolean validating)
Set the validating parser flag. This must be called beforeparse()
is called the first time.
- Parameters:
validating
- The new validating parser flag.
public void skippedEntity(String name) throws SAXException
Process notification of a skipped entity.
- Parameters:
name
- Name of the skipped entity
public void startDocument() throws SAXException
Process notification of the beginning of the document being reached.
public void startElement(String namespaceURI, String localName, String qName, Attributes list) throws SAXException
Process notification of the start of an XML element being reached.
- Parameters:
namespaceURI
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.qName
- The qualified name (with prefix), or the empty string if qualified names are not available.\list
- The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
public void startPrefixMapping(String prefix, String namespaceURI) throws SAXException
Process notification that a namespace prefix is coming in to scope.
- Parameters:
prefix
- Prefix that is being declarednamespaceURI
- Corresponding namespace URI being mapped to
public void unparsedEntityDecl(String name, String publicId, String systemId, String notation)
Receive notification of an unparsed entity declaration event.
- Parameters:
name
- The unparsed entity namepublicId
- The public identifier (if any)systemId
- The system identifier (if any)notation
- The name of the associated notation
public void warning(SAXParseException exception) throws SAXException
Forward notification of a parse warning to the application supplied error handler (if any).
- Parameters:
exception
- The warning information