Class Digester
- All Implemented Interfaces:
- ContentHandler,- DTDHandler,- EntityResolver,- ErrorHandler,- DeclHandler,- EntityResolver2,- LexicalHandler
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
 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
- 
Nested Class SummaryNested Classes
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected StringBuilderThe body text of the current element.protected ArrayStack<StringBuilder>The stack of body text string buffers for surrounding elements.protected ClassLoaderThe class loader to use for instantiating application objects.protected StringBuilderGenerated code.protected booleanHas this Digester been configured yet.protected EntityResolverThe EntityResolver used by the SAX parser.The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.protected ErrorHandlerThe application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.protected SAXParserFactoryThe SAXParserFactory that is created the first time we need it.Fake attributes map (attributes are often used for object creation).protected LocatorThe Locator associated with our parser.protected LogThe Log to which most logging calls will be made.protected StringThe current match pattern for nested element processing.protected ArrayStack<List<Rule>>Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().protected booleanDo we want a "namespace aware" parser.protected HashMap<String,ArrayStack<String>> Registered namespaces we are currently processing.protected ArrayStack<Object>The parameters stack being utilized by CallMethodRule and CallParamRule rules.protected SAXParserThe SAXParser we will use to parse the input stream.protected static IntrospectionUtils.PropertySource[]protected StringThe public identifier of the DTD we are currently parsing under (if any).protected XMLReaderThe XMLReader used to parse digester rules.protected ObjectThe "root" element of the stack (in other words, the last object that was popped.protected RulesTheRulesimplementation containing our collection ofRuleinstances and associated matching policy.protected booleanWarn on missing attributes and elements.protected LogThe Log to which all SAX event related logging calls will be made.protected static final StringManagerprotected IntrospectionUtils.PropertySource[]protected ArrayStack<Object>The object stack being constructed.protected booleanDo we want to use the Context ClassLoader when loading classes for instantiating new objects.protected booleanDo we want to use a validating parser.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddCallMethod(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.static voidaddGeneratedClass(String className) 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.voidRegister 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.voidaddSetProperties(String pattern, String[] excludes) 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 voidProvide a hook for lazy configuration of thisDigesterinstance.Create a SAX exception which also understands about the location in the digester file where the exception occurscreateSAXException(String message) Create a SAX exception which also understands about the location in the digester file where the exception occurscreateSAXException(String message, Exception e) Create a SAX exception which also understands about the location in the digester file where the exception occursvoidProcess 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.voidvoidendPrefixMapping(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).findNamespaceURI(String prefix) Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull.Return the class loader to be used for instantiating application objects when required.intgetCount()Gets the document locator associated with our parser.Return the Entity Resolver used by the SAX parser.SAX parser factory method.static String[]getMatch()booleangetProperty(String property) Return the current value of the specified property for the underlyingXMLReaderimplementation.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.getRules()Return theRulesimplementation object containing our rules collection and associated matching policy.booleanGets the logger used for logging SAX-related information.booleanbooleanReturn 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.static booleanstatic ObjectloadGeneratedClass(String className) voidnotationDecl(String name, String publicId, String systemId) Receive notification of a notation declaration event.Parse the content of the specified file using this Digester.parse(InputStream input) Parse the content of the specified input stream using this Digester.parse(InputSource input) Parse the content of the specified input source using this Digester.peek()Return the top object on the stack without removing it.peek(int n) Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element.Return the top object on the parameters stack without removing it.pop()Pop the top object off of the stack, and return it.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 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 the specified DTD URL for the specified public identifier.static voidvoidreset()resolveEntity(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.static voidsetGeneratedCodeLoader(Digester.GeneratedCodeLoader generatedCodeLoader) voidvoidSet 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.voidSet 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.voidProcess notification of the beginning of the document being reached.voidvoidstartElement(String namespaceURI, String localName, String qName, Attributes list) Process notification of the start of an XML element being reached.voidvoidstartPrefixMapping(String prefix, String namespaceURI) Process notification that a namespace prefix is coming in to scope.toVariableName(Object object) 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.DefaultHandler2attributeDecl, comment, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, getExternalSubset, internalEntityDecl, resolveEntity, startCDATA, startEntityMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.xml.sax.ContentHandlerdeclaration
- 
Field Details- 
propertySources
- 
sm
- 
source
- 
bodyTextThe body text of the current element.
- 
bodyTextsThe stack of body text string buffers for surrounding elements.
- 
matchesStack 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
 
- 
classLoaderThe 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.
- 
configuredprotected boolean configuredHas this Digester been configured yet.
- 
entityResolverThe EntityResolver used by the SAX parser. By default it use this class
- 
entityValidatorThe URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.
- 
errorHandlerThe application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.
- 
factoryThe SAXParserFactory that is created the first time we need it.
- 
locatorThe Locator associated with our parser.
- 
matchThe current match pattern for nested element processing.
- 
namespaceAwareprotected boolean namespaceAwareDo we want a "namespace aware" parser.
- 
namespacesRegistered 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).
- 
paramsThe parameters stack being utilized by CallMethodRule and CallParamRule rules.
- 
parserThe SAXParser we will use to parse the input stream.
- 
publicIdThe public identifier of the DTD we are currently parsing under (if any).
- 
readerThe XMLReader used to parse digester rules.
- 
rootThe "root" element of the stack (in other words, the last object that was popped.
- 
rulesTheRulesimplementation containing our collection ofRuleinstances and associated matching policy. If not established before the first rule is added, a default implementation will be provided.
- 
stackThe object stack being constructed.
- 
useContextClassLoaderprotected boolean useContextClassLoaderDo we want to use the Context ClassLoader when loading classes for instantiating new objects. Default isfalse.
- 
validatingprotected boolean validatingDo we want to use a validating parser.
- 
rulesValidationprotected boolean rulesValidationWarn on missing attributes and elements.
- 
fakeAttributesFake attributes map (attributes are often used for object creation).
- 
logThe Log to which most logging calls will be made.
- 
saxLogThe Log to which all SAX event related logging calls will be made.
- 
codeGenerated code.
- 
known
 
- 
- 
Constructor Details- 
Digesterpublic Digester()
 
- 
- 
Method Details- 
setPropertySource
- 
setPropertySource
- 
addGeneratedClass
- 
getGeneratedClasses
- 
isGeneratedCodeLoaderSetpublic static boolean isGeneratedCodeLoaderSet()
- 
setGeneratedCodeLoader
- 
loadGeneratedClass
- 
replaceSystemPropertiespublic static void replaceSystemProperties()
- 
startGeneratingCodepublic void startGeneratingCode()
- 
endGeneratingCodepublic void endGeneratingCode()
- 
getGeneratedCode
- 
setKnown
- 
toVariableName
- 
findNamespaceURIReturn 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
 
- 
getClassLoaderReturn 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 
- 
setClassLoaderSet the class loader to be used for instantiating application objects when required.- Parameters:
- classLoader- The new class loader to use, or- nullto revert to the standard rules
 
- 
getCountpublic int getCount()- Returns:
- the current depth of the element stack.
 
- 
getCurrentElementName- Returns:
- the name of the XML element that is currently being processed.
 
- 
getErrorHandler- Returns:
- the error handler for this Digester.
 
- 
setErrorHandlerSet the error handler for this Digester.- Parameters:
- errorHandler- The new error handler
 
- 
getFactorypublic SAXParserFactory getFactory() throws SAXNotRecognizedException, SAXNotSupportedException, ParserConfigurationExceptionSAX parser factory method.- Returns:
- the SAXParserFactory we will use, creating one if necessary.
- Throws:
- ParserConfigurationException- Error creating parser
- SAXNotSupportedException- Error creating parser
- SAXNotRecognizedException- Error creating parser
 
- 
setFeaturepublic 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 for
- value- The new value for this feature
- Throws:
- ParserConfigurationException- if a parser configuration error occurs
- SAXNotRecognizedException- if the property name is not recognized
- SAXNotSupportedException- if the property name is recognized but not supported
 
- 
getLogger- Returns:
- the current Logger associated with this instance of the Digester
 
- 
setLoggerSet the current logger for this Digester.- Parameters:
- log- The logger that will be used
 
- 
getSAXLoggerGets the logger used for logging SAX-related information. Note the output is finely grained.- Returns:
- the SAX logger
- Since:
- 1.6
 
- 
setSAXLoggerSets the logger used for logging SAX-related information. Note the output is finely grained.- Parameters:
- saxLog- Log, not null
- Since:
- 1.6
 
- 
getMatch- Returns:
- the current rule match path
 
- 
getNamespaceAwarepublic boolean getNamespaceAware()- Returns:
- the "namespace aware" flag for parsers we create.
 
- 
setNamespaceAwarepublic void setNamespaceAware(boolean namespaceAware) Set the "namespace aware" flag for parsers we create.- Parameters:
- namespaceAware- The new "namespace aware" flag
 
- 
setPublicIdSet the public id of the current file being parse.- Parameters:
- publicId- the DTD/Schema public's id.
 
- 
getPublicId- Returns:
- the public identifier of the DTD we are currently parsing under, if any.
 
- 
getParser- Returns:
- the SAXParser we will use to parse the input stream.  If there
 is a problem creating the parser, return null.
 
- 
getPropertypublic 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 recognized
- SAXNotSupportedException- if the property name is recognized but not supported
 
- 
getRulesReturn 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
 
- 
setRulesSet theRulesimplementation object containing our rules collection and associated matching policy.- Parameters:
- rules- New Rules implementation
 
- 
getUseContextClassLoaderpublic boolean getUseContextClassLoader()- Returns:
- the boolean as to whether the context classloader should be used.
 
- 
setUseContextClassLoaderpublic 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.
 
- 
getValidatingpublic boolean getValidating()- Returns:
- the validating parser flag.
 
- 
setValidatingpublic 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.
 
- 
getRulesValidationpublic boolean getRulesValidation()- Returns:
- the rules validation flag.
 
- 
setRulesValidationpublic 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- Returns:
- the fake attributes list.
 
- 
isFakeAttributeDetermine if an attribute is a fake attribute.- Parameters:
- object- The object
- name- The attribute name
- Returns:
- trueif this is a fake attribute
 
- 
setFakeAttributesSet the fake attributes.- Parameters:
- fakeAttributes- The new fake attributes.
 
- 
getXMLReaderReturn 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
 
- 
charactersProcess notification of character data received from the body of an XML element.- Specified by:
- charactersin interface- ContentHandler
- Overrides:
- charactersin class- DefaultHandler
- Parameters:
- buffer- The characters from the XML document
- start- Starting offset into the buffer
- length- Number of characters from the buffer
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
endDocumentProcess notification of the end of the document being reached.- Specified by:
- endDocumentin interface- ContentHandler
- Overrides:
- endDocumentin class- DefaultHandler
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
endElementProcess notification of the end of an XML element being reached.- Specified by:
- endElementin interface- ContentHandler
- Overrides:
- endElementin class- DefaultHandler
- 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
 
- 
endPrefixMappingProcess notification that a namespace prefix is going out of scope.- Specified by:
- endPrefixMappingin interface- ContentHandler
- Overrides:
- endPrefixMappingin class- DefaultHandler
- Parameters:
- prefix- Prefix that is going out of scope
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
ignorableWhitespaceProcess notification of ignorable whitespace received from the body of an XML element.- Specified by:
- ignorableWhitespacein interface- ContentHandler
- Overrides:
- ignorableWhitespacein class- DefaultHandler
- Parameters:
- buffer- The characters from the XML document
- start- Starting offset into the buffer
- len- Number of characters from the buffer
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
processingInstructionProcess notification of a processing instruction that was encountered.- Specified by:
- processingInstructionin interface- ContentHandler
- Overrides:
- processingInstructionin class- DefaultHandler
- Parameters:
- target- The processing instruction target
- data- The processing instruction data (if any)
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
getDocumentLocatorGets the document locator associated with our parser.- Returns:
- the Locator supplied by the document parser
 
- 
setDocumentLocatorSets the document locator associated with our parser.- Specified by:
- setDocumentLocatorin interface- ContentHandler
- Overrides:
- setDocumentLocatorin class- DefaultHandler
- Parameters:
- locator- The new locator
 
- 
skippedEntityProcess notification of a skipped entity.- Specified by:
- skippedEntityin interface- ContentHandler
- Overrides:
- skippedEntityin class- DefaultHandler
- Parameters:
- name- Name of the skipped entity
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
startDocumentProcess notification of the beginning of the document being reached.- Specified by:
- startDocumentin interface- ContentHandler
- Overrides:
- startDocumentin class- DefaultHandler
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
startElementpublic 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 interface- ContentHandler
- Overrides:
- startElementin class- DefaultHandler
- 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
 
- 
startPrefixMappingProcess notification that a namespace prefix is coming in to scope.- Specified by:
- startPrefixMappingin interface- ContentHandler
- Overrides:
- startPrefixMappingin class- DefaultHandler
- Parameters:
- prefix- Prefix that is being declared
- namespaceURI- Corresponding namespace URI being mapped to
- Throws:
- SAXException- if a parsing error is to be reported
 
- 
notationDeclReceive notification of a notation declaration event.- Specified by:
- notationDeclin interface- DTDHandler
- Overrides:
- notationDeclin class- DefaultHandler
- Parameters:
- name- The notation name
- publicId- The public identifier (if any)
- systemId- The system identifier (if any)
 
- 
unparsedEntityDeclReceive notification of an unparsed entity declaration event.- Specified by:
- unparsedEntityDeclin interface- DTDHandler
- Overrides:
- unparsedEntityDeclin class- DefaultHandler
- Parameters:
- name- The unparsed entity name
- publicId- The public identifier (if any)
- systemId- The system identifier (if any)
- notation- The name of the associated notation
 
- 
setEntityResolverSet 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 the- EntityResolverinterface.
 
- 
getEntityResolverReturn the Entity Resolver used by the SAX parser.- Returns:
- Return the Entity Resolver used by the SAX parser.
 
- 
resolveEntitypublic InputSource resolveEntity(String name, String publicId, String baseURI, String systemId) throws SAXException, IOException - Specified by:
- resolveEntityin interface- EntityResolver2
- Overrides:
- resolveEntityin class- DefaultHandler2
- Throws:
- SAXException
- IOException
 
- 
startDTD- Specified by:
- startDTDin interface- LexicalHandler
- Overrides:
- startDTDin class- DefaultHandler2
- Throws:
- SAXException
 
- 
errorForward notification of a parsing error to the application supplied error handler (if any).- Specified by:
- errorin interface- ErrorHandler
- Overrides:
- errorin class- DefaultHandler
- Parameters:
- exception- The error information
- Throws:
- SAXException- if a parsing exception occurs
 
- 
fatalErrorForward notification of a fatal parsing error to the application supplied error handler (if any).- Specified by:
- fatalErrorin interface- ErrorHandler
- Overrides:
- fatalErrorin class- DefaultHandler
- Parameters:
- exception- The fatal error information
- Throws:
- SAXException- if a parsing exception occurs
 
- 
warningForward notification of a parse warning to the application supplied error handler (if any).- Specified by:
- warningin interface- ErrorHandler
- Overrides:
- warningin class- DefaultHandler
- Parameters:
- exception- The warning information
- Throws:
- SAXException- if a parsing exception occurs
 
- 
parseParse 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 occurs
- SAXException- if a parsing exception occurs
 
- 
parseParse 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 occurs
- SAXException- if a parsing exception occurs
 
- 
parseParse 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 occurs
- SAXException- if a parsing exception occurs
 
- 
registerRegister 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 resolved
- entityURL- The URL to use for reading this DTD
 
- 
addRuleRegister a new Rule matching the specified pattern. This method sets the Digesterproperty on the rule.- Parameters:
- pattern- Element matching pattern
- rule- Rule to be registered
 
- 
addRuleSetRegister a set of Rule instances defined in a RuleSet.- Parameters:
- ruleSet- The RuleSet instance to configure from
 
- 
addCallMethodAdd an "call method" rule for a method which accepts no arguments.- Parameters:
- pattern- Element matching pattern
- methodName- Method name to be called
- See Also:
 
- 
addCallMethodAdd an "call method" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- methodName- Method name to be called
- paramCount- Number of expected parameters (or zero for a single parameter from the body of this element)
- See Also:
 
- 
addCallParamAdd a "call parameter" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- paramIndex- Zero-relative parameter index to set (from the body of this element)
- See Also:
 
- 
addFactoryCreatepublic void addFactoryCreate(String pattern, ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- creationFactory- Previously instantiated ObjectCreationFactory to be utilized
- ignoreCreateExceptions- when- trueany exceptions thrown during object creation will be ignored.
- See Also:
 
- 
addObjectCreateAdd an "object create" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- className- Java class name to be created
- See Also:
 
- 
addObjectCreateAdd an "object create" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- className- Default Java class name to be created
- attributeName- Attribute name that optionally overrides the default Java class name to be created
- See Also:
 
- 
addSetNextAdd a "set next" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- methodName- Method name to call on the parent element
- paramType- Java class name of the expected parameter type (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as- java.lang.Booleanfor a- booleanparameter)
- See Also:
 
- 
addSetPropertiesAdd a "set properties" rule for the specified parameters.- Parameters:
- pattern- Element matching pattern
- See Also:
 
- 
addSetProperties
- 
clearpublic 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. 
- 
resetpublic void reset()
- 
peekReturn the top object on the stack without removing it. If there are no objects on the stack, returnnull.- Returns:
- the top object
 
- 
peekReturn 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
 
- 
popPop the top object off of the stack, and return it. If there are no objects on the stack, returnnull.- Returns:
- the top object
 
- 
pushPush a new object onto the top of the object stack.- Parameters:
- object- The new object
 
- 
getRootWhen 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.
 
- 
configureprotected 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. 
- 
peekParamsReturn 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
 
- 
popParamsPop 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
 
- 
pushParamsPush a new object onto the top of the parameters stack. The parameters stack is used to store CallMethodRuleparameters. Seeparams.- Parameters:
- object- The new object
 
- 
createSAXExceptionCreate a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
- message- The error message
- e- The root cause
- Returns:
- the new exception
 
- 
createSAXExceptionCreate 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
 
- 
createSAXExceptionCreate 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
 
 
-