Package org.apache.xerces.parsers
Class DOMParser
java.lang.Object
org.apache.xerces.parsers.XMLParser
org.apache.xerces.parsers.AbstractXMLDocumentParser
org.apache.xerces.parsers.AbstractDOMParser
org.apache.xerces.parsers.DOMParser
- All Implemented Interfaces:
org.apache.xerces.xni.XMLDocumentHandler,org.apache.xerces.xni.XMLDTDContentModelHandler,org.apache.xerces.xni.XMLDTDHandler
This is the main Xerces DOM parser class. It uses the abstract DOM
parser with a document scanner, a dtd scanner, and a validator, as
well as a grammar pool.
- Version:
- $Id: DOMParser.java 699892 2008-09-28 21:08:27Z mrglavas $
- Author:
- Arnaud Le Hors, IBM, Andy Clark, IBM
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanUse EntityResolver2.protected static final StringProperty identifier: symbol table.protected static final StringFeature identifier: EntityResolver2.protected static final StringProperty identifier: XML grammar pool.Fields inherited from class org.apache.xerces.parsers.AbstractDOMParser
CORE_DOCUMENT_CLASS_NAME, CREATE_CDATA_NODES_FEATURE, CREATE_ENTITY_REF_NODES, CURRENT_ELEMENT_NODE, DEFAULT_DOCUMENT_CLASS_NAME, DEFER_NODE_EXPANSION, DOCUMENT_CLASS_NAME, fBaseURIStack, fCreateCDATANodes, fCreateEntityRefNodes, fCurrentCDATASection, fCurrentCDATASectionIndex, fCurrentEntityDecl, fCurrentNode, fCurrentNodeIndex, fDeferNodeExpansion, fDeferredDocumentImpl, fDeferredEntityDecl, fDocument, fDocumentClassName, fDocumentImpl, fDocumentIndex, fDocumentType, fDocumentTypeIndex, fDOMFilter, fErrorHandler, fFilterReject, fFirstChunk, fInCDATASection, fIncludeComments, fIncludeIgnorableWhitespace, fInDTD, fInDTDExternalSubset, fInEntityRef, fInternalSubset, fNamespaceAware, fRejectedElementDepth, fRoot, fSkippedElemStack, fStorePSVI, fStringBuffer, INCLUDE_COMMENTS_FEATURE, INCLUDE_IGNORABLE_WHITESPACE, NAMESPACES, PSVI_DOCUMENT_CLASS_NAMEFields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
fDocumentSource, fDTDContentModelSource, fDTDSourceFields inherited from class org.apache.xerces.parsers.XMLParser
ENTITY_RESOLVER, ERROR_HANDLER, fConfigurationFields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCEFields inherited from interface org.apache.xerces.xni.XMLDTDHandler
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a DOM parser using the dtd/xml schema parser configuration.DOMParser(SymbolTable symbolTable) Constructs a DOM parser using the specified symbol table.DOMParser(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool) Constructs a DOM parser using the specified symbol table and grammar pool.DOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config) Constructs a DOM parser using the specified parser configuration. -
Method Summary
Modifier and TypeMethodDescriptionReturn the current entity resolver.Return the current error handler.booleangetFeature(String featureId) Query the state of a feature.getProperty(String propertyId) Query the value of a property.org.apache.xerces.xni.parser.XMLParserConfigurationReturns this parser's XMLParserConfiguration.voidParses the input source specified by the given system identifier.voidparse(InputSource inputSource) parsevoidsetEntityResolver(EntityResolver resolver) Sets the resolver used to resolve external entities.voidsetErrorHandler(ErrorHandler errorHandler) Allow an application to register an error event handler.voidsetFeature(String featureId, boolean state) Set the state of any feature in a SAX2 parser.voidsetProperty(String propertyId, Object value) Set the value of any property in a SAX2 parser.Methods inherited from class org.apache.xerces.parsers.AbstractDOMParser
abort, attributeDecl, characters, comment, createAttrNode, createElementNode, doctypeDecl, dropDocumentReferences, elementDecl, emptyElement, endAttlist, endCDATA, endConditional, endDocument, endDTD, endElement, endExternalSubset, endGeneralEntity, endParameterEntity, externalEntityDecl, getDocument, getDocumentClassName, handleBaseURI, handleBaseURI, ignorableWhitespace, ignoredCharacters, internalEntityDecl, notationDecl, processingInstruction, reset, setCharacterData, setDocumentClassName, setLocale, startAttlist, startCDATA, startConditional, startDocument, startDTD, startElement, startExternalSubset, startGeneralEntity, startParameterEntity, textDecl, unparsedEntityDecl, xmlDeclMethods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
any, element, empty, endContentModel, endGroup, getDocumentSource, getDTDContentModelSource, getDTDSource, occurrence, pcdata, separator, setDocumentSource, setDTDContentModelSource, setDTDSource, startContentModel, startGroup
-
Field Details
-
USE_ENTITY_RESOLVER2
Feature identifier: EntityResolver2.- See Also:
-
SYMBOL_TABLE
Property identifier: symbol table.- See Also:
-
XMLGRAMMAR_POOL
Property identifier: XML grammar pool.- See Also:
-
fUseEntityResolver2
protected boolean fUseEntityResolver2Use EntityResolver2.
-
-
Constructor Details
-
DOMParser
public DOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config) Constructs a DOM parser using the specified parser configuration. -
DOMParser
public DOMParser()Constructs a DOM parser using the dtd/xml schema parser configuration. -
DOMParser
Constructs a DOM parser using the specified symbol table. -
DOMParser
public DOMParser(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool) Constructs a DOM parser using the specified symbol table and grammar pool.
-
-
Method Details
-
parse
Parses the input source specified by the given system identifier.This method is equivalent to the following:
parse(new InputSource(systemId));- Parameters:
systemId- The system identifier (URI).- Throws:
SAXException- Throws exception on SAX error.IOException- Throws exception on i/o error.
-
parse
parse- Parameters:
inputSource-- Throws:
SAXExceptionIOException
-
setEntityResolver
Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.- Parameters:
resolver- The new entity resolver. Passing a null value will uninstall the currently installed resolver.
-
getEntityResolver
Return the current entity resolver.- Returns:
- The current entity resolver, or null if none has been registered.
- See Also:
-
setErrorHandler
Allow an application to register an error event handler.If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
- Parameters:
errorHandler- The error handler.- Throws:
NullPointerException- If the handler argument is null.- See Also:
-
getErrorHandler
Return the current error handler.- Returns:
- The current error handler, or null if none has been registered.
- See Also:
-
setFeature
public void setFeature(String featureId, boolean state) throws SAXNotRecognizedException, SAXNotSupportedException Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.- Parameters:
featureId- The unique identifier (URI) of the feature.state- The requested state of the feature (true or false).- Throws:
SAXNotRecognizedException- If the requested feature is not known.SAXNotSupportedException- If the requested feature is known, but the requested state is not supported.
-
getFeature
public boolean getFeature(String featureId) throws SAXNotRecognizedException, SAXNotSupportedException Query the state of a feature. Query the current state of any feature in a SAX2 parser. The parser might not recognize the feature.- Parameters:
featureId- The unique identifier (URI) of the feature being set.- Returns:
- The current state of the feature.
- Throws:
SAXNotRecognizedException- If the requested feature is not known.SAXNotSupportedException- If the requested feature is known but not supported.
-
setProperty
public void setProperty(String propertyId, Object value) throws SAXNotRecognizedException, SAXNotSupportedException Set the value of any property in a SAX2 parser. The parser might not recognize the property, and if it does recognize it, it might not support the requested value.- Parameters:
propertyId- The unique identifier (URI) of the property being set.value- The value to which the property is being set.- Throws:
SAXNotRecognizedException- If the requested property is not known.SAXNotSupportedException- If the requested property is known, but the requested value is not supported.
-
getProperty
public Object getProperty(String propertyId) throws SAXNotRecognizedException, SAXNotSupportedException Query the value of a property. Return the current value of a property in a SAX2 parser. The parser might not recognize the property.- Parameters:
propertyId- The unique identifier (URI) of the property being set.- Returns:
- The current value of the property.
- Throws:
SAXNotRecognizedException- If the requested property is not known.SAXNotSupportedException- If the requested property is known but not supported.
-
getXMLParserConfiguration
public org.apache.xerces.xni.parser.XMLParserConfiguration getXMLParserConfiguration()Returns this parser's XMLParserConfiguration.
-