Class Digester
- java.lang.Object
-
- org.xml.sax.helpers.DefaultHandler
-
- org.xml.sax.ext.DefaultHandler2
-
- org.apache.tomcat.util.digester.Digester
-
- All Implemented Interfaces:
ContentHandler,DTDHandler,EntityResolver,ErrorHandler,DeclHandler,EntityResolver2,LexicalHandler
public class Digester extends DefaultHandler2
A Digester processes an XML input stream by matching a series of element nesting patterns to execute Rules that have been added prior to the start of parsing. This package was inspired by the
XmlMapperclass 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDigester.EnvironmentPropertySourceDeprecated.UseEnvironmentPropertySourceThis will be removed in Tomcat 10 onwards.
-
Field Summary
Fields Modifier and Type Field Description protected StringBuilderbodyTextThe body text of the current element.protected ArrayStack<StringBuilder>bodyTextsThe stack of body text string buffers for surrounding elements.protected ClassLoaderclassLoaderThe class loader to use for instantiating application objects.protected booleanconfiguredHas this Digester been configured yet.protected EntityResolverentityResolverThe EntityResolver used by the SAX parser.protected HashMap<String,String>entityValidatorThe URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.protected ErrorHandlererrorHandlerThe application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.protected SAXParserFactoryfactoryThe SAXParserFactory that is created the first time we need it.protected Map<Class<?>,List<String>>fakeAttributesFake attributes map (attributes are often used for object creation).protected LocatorlocatorThe Locator associated with our parser.protected LoglogThe Log to which most logging calls will be made.protected StringmatchThe current match pattern for nested element processing.protected ArrayStack<List<Rule>>matchesStack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().protected booleannamespaceAwareDo we want a "namespace aware" parser.protected HashMap<String,ArrayStack<String>>namespacesRegistered namespaces we are currently processing.protected ArrayStack<Object>paramsThe parameters stack being utilized by CallMethodRule and CallParamRule rules.protected SAXParserparserThe SAXParser we will use to parse the input stream.protected static IntrospectionUtils.PropertySource[]propertySourcesprotected StringpublicIdThe public identifier of the DTD we are currently parsing under (if any).protected XMLReaderreaderThe XMLReader used to parse digester rules.protected ObjectrootThe "root" element of the stack (in other words, the last object that was popped.protected RulesrulesTheRulesimplementation containing our collection ofRuleinstances and associated matching policy.protected booleanrulesValidationWarn on missing attributes and elements.protected LogsaxLogThe Log to which all SAX event related logging calls will be made.protected static StringManagersmprotected IntrospectionUtils.PropertySource[]sourceprotected ArrayStack<Object>stackThe object stack being constructed.protected booleanuseContextClassLoaderDo we want to use the Context ClassLoader when loading classes for instantiating new objects.protected booleanvalidatingDo we want to use a validating parser.
-
Constructor Summary
Constructors Constructor Description Digester()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddCallMethod(String pattern, String methodName)Add an "call method" rule for a method which accepts no arguments.voidaddCallMethod(String pattern, String methodName, int paramCount)Add an "call method" rule for the specified parameters.voidaddCallParam(String pattern, int paramIndex)Add a "call parameter" rule for the specified parameters.voidaddFactoryCreate(String pattern, ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)Add a "factory create" rule for the specified parameters.voidaddObjectCreate(String pattern, String className)Add an "object create" rule for the specified parameters.voidaddObjectCreate(String pattern, String className, String attributeName)Add an "object create" rule for the specified parameters.voidaddRule(String pattern, Rule rule)Register a new Rule matching the specified pattern.voidaddRuleSet(RuleSet ruleSet)Register a set of Rule instances defined in a RuleSet.voidaddSetNext(String pattern, String methodName, String paramType)Add a "set next" rule for the specified parameters.voidaddSetProperties(String pattern)Add a "set properties" rule for the specified parameters.voidcharacters(char[] buffer, int start, int length)Process notification of character data received from the body of an XML element.voidclear()Clear the current contents of the object stack.protected voidconfigure()Provide a hook for lazy configuration of thisDigesterinstance.SAXExceptioncreateSAXException(Exception e)Create a SAX exception which also understands about the location in the digester file where the exception occursSAXExceptioncreateSAXException(String message)Create a SAX exception which also understands about the location in the digester file where the exception occursSAXExceptioncreateSAXException(String message, Exception e)Create a SAX exception which also understands about the location in the digester file where the exception occursvoidendDocument()Process notification of the end of the document being reached.voidendElement(String namespaceURI, String localName, String qName)Process notification of the end of an XML element being reached.voidendPrefixMapping(String prefix)Process notification that a namespace prefix is going out of scope.voiderror(SAXParseException exception)Forward notification of a parsing error to the application supplied error handler (if any).voidfatalError(SAXParseException exception)Forward notification of a fatal parsing error to the application supplied error handler (if any).StringfindNamespaceURI(String prefix)Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull.ClassLoadergetClassLoader()Return the class loader to be used for instantiating application objects when required.intgetCount()StringgetCurrentElementName()LocatorgetDocumentLocator()Gets the document locator associated with our parser.EntityResolvergetEntityResolver()Return the Entity Resolver used by the SAX parser.ErrorHandlergetErrorHandler()SAXParserFactorygetFactory()SAX parser factory method.Map<Class<?>,List<String>>getFakeAttributes()LoggetLogger()StringgetMatch()booleangetNamespaceAware()SAXParsergetParser()ObjectgetProperty(String property)Return the current value of the specified property for the underlyingXMLReaderimplementation.StringgetPublicId()ObjectgetRoot()When the Digester is being used as a SAXContentHandler, this method allows you to access the root object that has been created after parsing.StringgetRuleNamespaceURI()Deprecated.Unused.RulesgetRules()Return theRulesimplementation object containing our rules collection and associated matching policy.booleangetRulesValidation()LoggetSAXLogger()Gets the logger used for logging SAX-related information.booleangetUseContextClassLoader()booleangetValidating()XMLReadergetXMLReader()Return the XMLReader to be used for parsing the input document.voidignorableWhitespace(char[] buffer, int start, int len)Process notification of ignorable whitespace received from the body of an XML element.booleanisFakeAttribute(Object object, String name)Determine if an attribute is a fake attribute.voidnotationDecl(String name, String publicId, String systemId)Receive notification of a notation declaration event.Objectparse(File file)Parse the content of the specified file using this Digester.Objectparse(InputStream input)Parse the content of the specified input stream using this Digester.Objectparse(InputSource input)Parse the content of the specified input source using this Digester.Objectpeek()Return the top object on the stack without removing it.Objectpeek(int n)Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element.ObjectpeekParams()Return the top object on the parameters stack without removing it.Objectpop()Pop the top object off of the stack, and return it.ObjectpopParams()Pop the top object off of the parameters stack, and return it.voidprocessingInstruction(String target, String data)Process notification of a processing instruction that was encountered.voidpush(Object object)Push a new object onto the top of the object stack.voidpushParams(Object object)Push a new object onto the top of the parameters stack.voidregister(String publicId, String entityURL)Register the specified DTD URL for the specified public identifier.static voidreplaceSystemProperties()voidreset()InputSourceresolveEntity(String name, String publicId, String baseURI, String systemId)voidsetClassLoader(ClassLoader classLoader)Set the class loader to be used for instantiating application objects when required.voidsetDocumentLocator(Locator locator)Sets the document locator associated with our parser.voidsetEntityResolver(EntityResolver entityResolver)Set theEntityResolverused by SAX when resolving public id and system id.voidsetErrorHandler(ErrorHandler errorHandler)Set the error handler for this Digester.voidsetFakeAttributes(Map<Class<?>,List<String>> fakeAttributes)Set the fake attributes.voidsetFeature(String feature, boolean value)Sets a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader.voidsetLogger(Log log)Set the current logger for this Digester.voidsetNamespaceAware(boolean namespaceAware)Set the "namespace aware" flag for parsers we create.static voidsetPropertySource(IntrospectionUtils.PropertySource propertySource)static voidsetPropertySource(IntrospectionUtils.PropertySource[] propertySources)voidsetPublicId(String publicId)Set the public id of the current file being parse.voidsetRuleNamespaceURI(String ruleNamespaceURI)Deprecated.Unused.voidsetRules(Rules rules)Set theRulesimplementation object containing our rules collection and associated matching policy.voidsetRulesValidation(boolean rulesValidation)Set the rules validation flag.voidsetSAXLogger(Log saxLog)Sets the logger used for logging SAX-related information.voidsetUseContextClassLoader(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.voidsetValidating(boolean validating)Set the validating parser flag.voidskippedEntity(String name)Process notification of a skipped entity.voidstartDocument()Process notification of the beginning of the document being reached.voidstartDTD(String name, String publicId, String systemId)voidstartElement(String namespaceURI, String localName, String qName, Attributes list)Process notification of the start of an XML element being reached.voidstartPrefixMapping(String prefix, String namespaceURI)Process notification that a namespace prefix is coming in to scope.voidunparsedEntityDecl(String name, String publicId, String systemId, String notation)Receive notification of an unparsed entity declaration event.voidwarning(SAXParseException exception)Forward notification of a parse warning to the application supplied error handler (if any).-
Methods inherited from class org.xml.sax.ext.DefaultHandler2
attributeDecl, comment, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, getExternalSubset, internalEntityDecl, resolveEntity, startCDATA, startEntity
-
-
-
-
Field Detail
-
propertySources
protected static IntrospectionUtils.PropertySource[] propertySources
-
sm
protected static final StringManager sm
-
source
protected IntrospectionUtils.PropertySource[] source
-
bodyText
protected StringBuilder bodyText
The body text of the current element.
-
bodyTexts
protected ArrayStack<StringBuilder> bodyTexts
The stack of body text string buffers for surrounding elements.
-
matches
protected ArrayStack<List<Rule>> 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
-
classLoader
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 theuseContextClassLoadervariable.
-
configured
protected boolean configured
Has this Digester been configured yet.
-
entityResolver
protected EntityResolver entityResolver
The EntityResolver used by the SAX parser. By default it use this class
-
entityValidator
protected HashMap<String,String> entityValidator
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.
-
errorHandler
protected ErrorHandler errorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.
-
factory
protected SAXParserFactory factory
The SAXParserFactory that is created the first time we need it.
-
locator
protected Locator locator
The Locator associated with our parser.
-
match
protected String match
The current match pattern for nested element processing.
-
namespaceAware
protected boolean namespaceAware
Do we want a "namespace aware" parser.
-
namespaces
protected HashMap<String,ArrayStack<String>> 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).
-
params
protected ArrayStack<Object> params
The parameters stack being utilized by CallMethodRule and CallParamRule rules.
-
parser
protected SAXParser parser
The SAXParser we will use to parse the input stream.
-
publicId
protected String publicId
The public identifier of the DTD we are currently parsing under (if any).
-
reader
protected XMLReader reader
The XMLReader used to parse digester rules.
-
root
protected Object root
The "root" element of the stack (in other words, the last object that was popped.
-
rules
protected Rules rules
TheRulesimplementation containing our collection ofRuleinstances and associated matching policy. If not established before the first rule is added, a default implementation will be provided.
-
stack
protected ArrayStack<Object> stack
The object stack being constructed.
-
useContextClassLoader
protected boolean useContextClassLoader
Do we want to use the Context ClassLoader when loading classes for instantiating new objects. Default isfalse.
-
validating
protected boolean validating
Do we want to use a validating parser.
-
rulesValidation
protected boolean rulesValidation
Warn on missing attributes and elements.
-
fakeAttributes
protected Map<Class<?>,List<String>> fakeAttributes
Fake attributes map (attributes are often used for object creation).
-
log
protected Log log
The Log to which most logging calls will be made.
-
saxLog
protected Log saxLog
The Log to which all SAX event related logging calls will be made.
-
-
Method Detail
-
setPropertySource
public static void setPropertySource(IntrospectionUtils.PropertySource propertySource)
-
setPropertySource
public static void setPropertySource(IntrospectionUtils.PropertySource[] propertySources)
-
replaceSystemProperties
public static void replaceSystemProperties()
-
findNamespaceURI
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- Returns:
- the namespace URI
-
getClassLoader
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
useContextClassLoaderproperty is set to true - The class loader used to load the Digester class itself.
- Returns:
- the classloader
- The class loader set by
-
setClassLoader
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, ornullto revert to the standard rules
-
getCount
public int getCount()
- Returns:
- the current depth of the element stack.
-
getCurrentElementName
public String getCurrentElementName()
- Returns:
- the name of the XML element that is currently being processed.
-
getErrorHandler
public ErrorHandler getErrorHandler()
- Returns:
- the error handler for this Digester.
-
setErrorHandler
public void setErrorHandler(ErrorHandler errorHandler)
Set the error handler for this Digester.- Parameters:
errorHandler- The new error handler
-
getFactory
public SAXParserFactory getFactory() throws SAXNotRecognizedException, SAXNotSupportedException, ParserConfigurationException
SAX parser factory method.- Returns:
- the SAXParserFactory we will use, creating one if necessary.
- Throws:
ParserConfigurationException- Error creating parserSAXNotSupportedException- Error creating parserSAXNotRecognizedException- Error creating parser
-
setFeature
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 http://www.saxproject.org/apidoc/xml/sax/package-summary.html#package-description 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- Throws:
ParserConfigurationException- if a parser configuration error occursSAXNotRecognizedException- if the property name is not recognizedSAXNotSupportedException- if the property name is recognized but not supported
-
getLogger
public Log getLogger()
- Returns:
- the current Logger associated with this instance of the Digester
-
setLogger
public void setLogger(Log log)
Set the current logger for this Digester.- Parameters:
log- The logger that will be used
-
getSAXLogger
public Log getSAXLogger()
Gets the logger used for logging SAX-related information. Note the output is finely grained.- Returns:
- the SAX logger
- Since:
- 1.6
-
setSAXLogger
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
-
getMatch
public String getMatch()
- Returns:
- the current rule match path
-
getNamespaceAware
public boolean getNamespaceAware()
- Returns:
- the "namespace aware" flag for parsers we create.
-
setNamespaceAware
public void setNamespaceAware(boolean namespaceAware)
Set the "namespace aware" flag for parsers we create.- Parameters:
namespaceAware- The new "namespace aware" flag
-
setPublicId
public void setPublicId(String publicId)
Set the public id of the current file being parse.- Parameters:
publicId- the DTD/Schema public's id.
-
getPublicId
public String getPublicId()
- Returns:
- the public identifier of the DTD we are currently parsing under, if any.
-
getRuleNamespaceURI
@Deprecated public String getRuleNamespaceURI()
Deprecated.Unused. Will be removed in Tomcat 9- Returns:
- the namespace URI that will be applied to all subsequently
added
Ruleobjects.
-
setRuleNamespaceURI
@Deprecated public void setRuleNamespaceURI(String ruleNamespaceURI)
Deprecated.Unused. Will be removed in Tomcat 9Set the namespace URI that will be applied to all subsequently addedRuleobjects.- Parameters:
ruleNamespaceURI- Namespace URI that must match on all subsequently added rules, ornullfor matching regardless of the current namespace URI
-
getParser
public SAXParser getParser()
- Returns:
- the SAXParser we will use to parse the input stream. If there
is a problem creating the parser, return
null.
-
getProperty
public Object getProperty(String property) throws SAXNotRecognizedException, SAXNotSupportedException
Return the current value of the specified property for the underlyingXMLReaderimplementation. See http://www.saxproject.org/apidoc/xml/sax/package-summary.html#package-description for information about the standard SAX2 properties.- Parameters:
property- Property name to be retrieved- Returns:
- the property value
- Throws:
SAXNotRecognizedException- if the property name is not recognizedSAXNotSupportedException- if the property name is recognized but not supported
-
getRules
public Rules getRules()
Return theRulesimplementation object containing our rules collection and associated matching policy. If none has been established, a default implementation will be created and returned.- Returns:
- the rules
-
setRules
public void setRules(Rules rules)
Set theRulesimplementation object containing our rules collection and associated matching policy.- Parameters:
rules- New Rules implementation
-
getUseContextClassLoader
public boolean getUseContextClassLoader()
- Returns:
- the boolean as to whether the context classloader should be used.
-
setUseContextClassLoader
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.
-
getValidating
public boolean getValidating()
- Returns:
- the validating parser flag.
-
setValidating
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.
-
getRulesValidation
public boolean getRulesValidation()
- Returns:
- the rules validation flag.
-
setRulesValidation
public void setRulesValidation(boolean rulesValidation)
Set the rules validation flag. This must be called beforeparse()is called the first time.- Parameters:
rulesValidation- The new rules validation flag.
-
getFakeAttributes
public Map<Class<?>,List<String>> getFakeAttributes()
- Returns:
- the fake attributes list.
-
isFakeAttribute
public boolean isFakeAttribute(Object object, String name)
Determine if an attribute is a fake attribute.- Parameters:
object- The objectname- The attribute name- Returns:
trueif this is a fake attribute
-
setFakeAttributes
public void setFakeAttributes(Map<Class<?>,List<String>> fakeAttributes)
Set the fake attributes.- Parameters:
fakeAttributes- The new fake attributes.
-
getXMLReader
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.- Returns:
- the XML reader
- Throws:
SAXException- if no XMLReader can be instantiated
-
characters
public void characters(char[] buffer, int start, int length) throws SAXExceptionProcess notification of character data received from the body of an XML element.- Specified by:
charactersin interfaceContentHandler- Overrides:
charactersin classDefaultHandler- Parameters:
buffer- The characters from the XML documentstart- Starting offset into the bufferlength- Number of characters from the buffer- Throws:
SAXException- if a parsing error is to be reported
-
endDocument
public void endDocument() throws SAXExceptionProcess notification of the end of the document being reached.- Specified by:
endDocumentin interfaceContentHandler- Overrides:
endDocumentin classDefaultHandler- Throws:
SAXException- if a parsing error is to be reported
-
endElement
public void endElement(String namespaceURI, String localName, String qName) throws SAXException
Process notification of the end of an XML element being reached.- Specified by:
endElementin interfaceContentHandler- Overrides:
endElementin classDefaultHandler- 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.- Throws:
SAXException- if a parsing error is to be reported
-
endPrefixMapping
public void endPrefixMapping(String prefix) throws SAXException
Process notification that a namespace prefix is going out of scope.- Specified by:
endPrefixMappingin interfaceContentHandler- Overrides:
endPrefixMappingin classDefaultHandler- Parameters:
prefix- Prefix that is going out of scope- Throws:
SAXException- if a parsing error is to be reported
-
ignorableWhitespace
public void ignorableWhitespace(char[] buffer, int start, int len) throws SAXExceptionProcess notification of ignorable whitespace received from the body of an XML element.- Specified by:
ignorableWhitespacein interfaceContentHandler- Overrides:
ignorableWhitespacein classDefaultHandler- Parameters:
buffer- The characters from the XML documentstart- Starting offset into the bufferlen- Number of characters from the buffer- Throws:
SAXException- if a parsing error is to be reported
-
processingInstruction
public void processingInstruction(String target, String data) throws SAXException
Process notification of a processing instruction that was encountered.- Specified by:
processingInstructionin interfaceContentHandler- Overrides:
processingInstructionin classDefaultHandler- Parameters:
target- The processing instruction targetdata- The processing instruction data (if any)- Throws:
SAXException- if a parsing error is to be reported
-
getDocumentLocator
public Locator getDocumentLocator()
Gets the document locator associated with our parser.- Returns:
- the Locator supplied by the document parser
-
setDocumentLocator
public void setDocumentLocator(Locator locator)
Sets the document locator associated with our parser.- Specified by:
setDocumentLocatorin interfaceContentHandler- Overrides:
setDocumentLocatorin classDefaultHandler- Parameters:
locator- The new locator
-
skippedEntity
public void skippedEntity(String name) throws SAXException
Process notification of a skipped entity.- Specified by:
skippedEntityin interfaceContentHandler- Overrides:
skippedEntityin classDefaultHandler- Parameters:
name- Name of the skipped entity- Throws:
SAXException- if a parsing error is to be reported
-
startDocument
public void startDocument() throws SAXExceptionProcess notification of the beginning of the document being reached.- Specified by:
startDocumentin interfaceContentHandler- Overrides:
startDocumentin classDefaultHandler- Throws:
SAXException- if a parsing error is to be reported
-
startElement
public void startElement(String namespaceURI, String localName, String qName, Attributes list) throws SAXException
Process notification of the start of an XML element being reached.- Specified by:
startElementin interfaceContentHandler- Overrides:
startElementin classDefaultHandler- 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.- Throws:
SAXException- if a parsing error is to be reported
-
startPrefixMapping
public void startPrefixMapping(String prefix, String namespaceURI) throws SAXException
Process notification that a namespace prefix is coming in to scope.- Specified by:
startPrefixMappingin interfaceContentHandler- Overrides:
startPrefixMappingin classDefaultHandler- Parameters:
prefix- Prefix that is being declarednamespaceURI- Corresponding namespace URI being mapped to- Throws:
SAXException- if a parsing error is to be reported
-
notationDecl
public void notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration event.- Specified by:
notationDeclin interfaceDTDHandler- Overrides:
notationDeclin classDefaultHandler- Parameters:
name- The notation namepublicId- The public identifier (if any)systemId- The system identifier (if any)
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notation)
Receive notification of an unparsed entity declaration event.- Specified by:
unparsedEntityDeclin interfaceDTDHandler- Overrides:
unparsedEntityDeclin classDefaultHandler- Parameters:
name- The unparsed entity namepublicId- The public identifier (if any)systemId- The system identifier (if any)notation- The name of the associated notation
-
setEntityResolver
public void setEntityResolver(EntityResolver entityResolver)
Set theEntityResolverused by SAX when resolving public id and system id. This must be called before the first call toparse().- Parameters:
entityResolver- a class that implement theEntityResolverinterface.
-
getEntityResolver
public EntityResolver getEntityResolver()
Return the Entity Resolver used by the SAX parser.- Returns:
- Return the Entity Resolver used by the SAX parser.
-
resolveEntity
public InputSource resolveEntity(String name, String publicId, String baseURI, String systemId) throws SAXException, IOException
- Specified by:
resolveEntityin interfaceEntityResolver2- Overrides:
resolveEntityin classDefaultHandler2- Throws:
SAXExceptionIOException
-
startDTD
public void startDTD(String name, String publicId, String systemId) throws SAXException
- Specified by:
startDTDin interfaceLexicalHandler- Overrides:
startDTDin classDefaultHandler2- Throws:
SAXException
-
error
public void error(SAXParseException exception) throws SAXException
Forward notification of a parsing error to the application supplied error handler (if any).- Specified by:
errorin interfaceErrorHandler- Overrides:
errorin classDefaultHandler- Parameters:
exception- The error information- Throws:
SAXException- if a parsing exception occurs
-
fatalError
public void fatalError(SAXParseException exception) throws SAXException
Forward notification of a fatal parsing error to the application supplied error handler (if any).- Specified by:
fatalErrorin interfaceErrorHandler- Overrides:
fatalErrorin classDefaultHandler- Parameters:
exception- The fatal error information- Throws:
SAXException- if a parsing exception occurs
-
warning
public void warning(SAXParseException exception) throws SAXException
Forward notification of a parse warning to the application supplied error handler (if any).- Specified by:
warningin interfaceErrorHandler- Overrides:
warningin classDefaultHandler- Parameters:
exception- The warning information- Throws:
SAXException- if a parsing exception occurs
-
parse
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- Returns:
- the root object
- Throws:
IOException- if an input/output error occursSAXException- if a parsing exception occurs
-
parse
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- Returns:
- the root object
- Throws:
IOException- if an input/output error occursSAXException- if a parsing exception occurs
-
parse
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- Returns:
- the root object
- Throws:
IOException- if an input/output error occursSAXException- if a parsing exception occurs
-
register
public void register(String publicId, String entityURL)
Register the specified DTD URL for the specified public identifier. This must be called before the first call to
parse().Digestercontains an internalEntityResolverimplementation. 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 everySYSTEMURI on every processed xml document is local. This implementation provides only basic functionality. If more sophisticated features are required, usingsetEntityResolver(org.xml.sax.EntityResolver)to set a custom resolver is recommended.Note: This method will have no effect when a custom
EntityResolverhas been set. (Setting a customEntityResolveroverrides the internal implementation.)- Parameters:
publicId- Public identifier of the DTD to be resolvedentityURL- The URL to use for reading this DTD
-
addRule
public void addRule(String pattern, Rule rule)
Register a new Rule matching the specified pattern. This method sets the
Digesterproperty on the rule.- Parameters:
pattern- Element matching patternrule- Rule to be registered
-
addRuleSet
public void addRuleSet(RuleSet ruleSet)
Register a set of Rule instances defined in a RuleSet.- Parameters:
ruleSet- The RuleSet instance to configure from
-
addCallMethod
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
-
addCallMethod
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
-
addCallParam
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
-
addFactoryCreate
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- whentrueany exceptions thrown during object creation will be ignored.- See Also:
FactoryCreateRule
-
addObjectCreate
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
-
addObjectCreate
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
-
addSetNext
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 corresponding Java wrapper class instead, such asjava.lang.Booleanfor abooleanparameter)- See Also:
SetNextRule
-
addSetProperties
public void addSetProperties(String pattern)
Add a "set properties" rule for the specified parameters.- Parameters:
pattern- Element matching pattern- See Also:
SetPropertiesRule
-
clear
public void clear()
Clear the current contents of the object stack.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.
-
reset
public void reset()
-
peek
public Object peek()
Return the top object on the stack without removing it. If there are no objects on the stack, returnnull.- Returns:
- the top object
-
peek
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.- Returns:
- the specified object
-
pop
public Object pop()
Pop the top object off of the stack, and return it. If there are no objects on the stack, returnnull.- Returns:
- the top object
-
push
public void push(Object object)
Push a new object onto the top of the object stack.- Parameters:
object- The new object
-
getRoot
public Object getRoot()
When the Digester is being used as a SAXContentHandler, this method allows you to access the root object that has been created after parsing.- Returns:
- the root object that has been created after parsing or null if the digester has not parsed any XML yet.
-
configure
protected void configure()
Provide a hook for lazy configuration of this
Digesterinstance. The default implementation does nothing, but subclasses can override as needed.Note This method may be called more than once.
-
peekParams
public Object peekParams()
Return the top object on the parameters stack without removing it. If there are no objects on the stack, return
null.The parameters stack is used to store
CallMethodRuleparameters. Seeparams.- Returns:
- the top object on the parameters stack
-
popParams
public Object popParams()
Pop the top object off of the parameters stack, and return it. If there are no objects on the stack, return
null.The parameters stack is used to store
CallMethodRuleparameters. Seeparams.- Returns:
- the top object on the parameters stack
-
pushParams
public void pushParams(Object object)
Push a new object onto the top of the parameters stack.
The parameters stack is used to store
CallMethodRuleparameters. Seeparams.- Parameters:
object- The new object
-
createSAXException
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- Parameters:
message- The error messagee- The root cause- Returns:
- the new exception
-
createSAXException
public SAXException createSAXException(Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
e- The root cause- Returns:
- the new exception
-
createSAXException
public SAXException createSAXException(String message)
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
message- The error message- Returns:
- the new exception
-
-