AbstractDOMParser (Xerces2 Java 2.11.1 API)

java.lang.Object
- org.apache.xerces.parsers.XMLParser
- - org.apache.xerces.parsers.AbstractXMLDocumentParser
  - - org.apache.xerces.parsers.AbstractDOMParser

All Implemented Interfaces:

XMLDocumentHandler, XMLDTDContentModelHandler, XMLDTDHandler

Direct Known Subclasses:

DOMParser, DOMParserImpl
```
public class AbstractDOMParser
extends AbstractXMLDocumentParser
```
This is the base class of all DOM parsers. It implements the XNI callback methods to create the DOM tree. After a successful parse of an XML document, the DOM Document object can be queried using the getDocument method. The actual pipeline is defined in parser configuration.

Version:

$Id$

Author:

Arnaud Le Hors, IBM, Andy Clark, IBM, Elena Litani, IBM

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CORE_DOCUMENT_CLASS_NAME`
`protected static String`	`CREATE_CDATA_NODES_FEATURE` Feature id: create cdata nodes.
`protected static String`	`CREATE_ENTITY_REF_NODES` Feature id: create entity ref nodes.
`protected static String`	`CURRENT_ELEMENT_NODE`
`protected static String`	`DEFAULT_DOCUMENT_CLASS_NAME` Default document class name.
`protected static String`	`DEFER_NODE_EXPANSION` Feature id: defer node expansion.
`protected static String`	`DOCUMENT_CLASS_NAME` Property id: document class name.
`protected Stack`	`fBaseURIStack` Base uri stack
`protected boolean`	`fCreateCDATANodes` Create cdata nodes.
`protected boolean`	`fCreateEntityRefNodes` Create entity reference nodes.
`protected CDATASection`	`fCurrentCDATASection`
`protected int`	`fCurrentCDATASectionIndex`
`protected EntityImpl`	`fCurrentEntityDecl`
`protected Node`	`fCurrentNode` Current node.
`protected int`	`fCurrentNodeIndex`
`protected boolean`	`fDeferNodeExpansion`
`protected DeferredDocumentImpl`	`fDeferredDocumentImpl`
`protected int`	`fDeferredEntityDecl`
`protected Document`	`fDocument` The document.
`protected String`	`fDocumentClassName` The document class name to use.
`protected CoreDocumentImpl`	`fDocumentImpl` The default Xerces document implementation, if used.
`protected int`	`fDocumentIndex`
`protected DocumentType`	`fDocumentType` The document type node.
`protected int`	`fDocumentTypeIndex`
`protected LSParserFilter`	`fDOMFilter`
`protected DOMErrorHandlerWrapper`	`fErrorHandler` DOM L3 error handler
`protected boolean`	`fFilterReject` LSParserFilter: specifies that element with given QNAME and all its children must be rejected
`protected boolean`	`fFirstChunk` True if saw the first chunk of characters
`protected boolean`	`fInCDATASection` True if inside CDATA section.
`protected boolean`	`fIncludeComments` Include Comments.
`protected boolean`	`fIncludeIgnorableWhitespace` Include ignorable whitespace.
`protected boolean`	`fInDTD` True if inside DTD.
`protected boolean`	`fInDTDExternalSubset` True if inside DTD external subset.
`protected boolean`	`fInEntityRef` LSParserFilter: true if inside entity reference
`protected StringBuffer`	`fInternalSubset` Internal subset buffer.
`protected boolean`	`fNamespaceAware`
`protected int`	`fRejectedElementDepth` LSParserFilter: tracks the element depth within a rejected subtree.
`protected Node`	`fRoot` Root element node.
`protected Stack`	`fSkippedElemStack` LSParserFilter: store depth of skipped elements
`protected boolean`	`fStorePSVI` Whether to store PSVI information in DOM tree.
`protected StringBuffer`	`fStringBuffer` Character buffer
`protected static String`	`INCLUDE_COMMENTS_FEATURE` Feature id: include comments.
`protected static String`	`INCLUDE_IGNORABLE_WHITESPACE` Feature id: include ignorable whitespace.
`protected static String`	`NAMESPACES` Feature id: namespace.
`protected static String`	`PSVI_DOCUMENT_CLASS_NAME`

Fields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
fDocumentSource, fDTDContentModelSource, fDTDSource

Fields inherited from class org.apache.xerces.parsers.XMLParser
ENTITY_RESOLVER, ERROR_HANDLER, fConfiguration

Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractDOMParser(XMLParserConfiguration config)
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractDOMParser(XMLParserConfiguration config)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abort()`
`void`	`attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)` An attribute declaration.
`void`	`characters(XMLString text, Augmentations augs)` Character content.
`void`	`comment(XMLString text, Augmentations augs)` A comment.
`protected Attr`	`createAttrNode(QName attrQName)`
`protected Element`	`createElementNode(QName element)`
`void`	`doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)` Notifies of the presence of the DOCTYPE line in the document.
`void`	`dropDocumentReferences()` Drops all references to the last DOM which was built by this parser.
`void`	`elementDecl(String name, String contentModel, Augmentations augs)` An element declaration.
`void`	`emptyElement(QName element, XMLAttributes attributes, Augmentations augs)` An empty element.
`void`	`endAttlist(Augmentations augs)` The end of an attribute list.
`void`	`endCDATA(Augmentations augs)` The end of a CDATA section.
`void`	`endConditional(Augmentations augs)` The end of a conditional section.
`void`	`endDocument(Augmentations augs)` The end of the document.
`void`	`endDTD(Augmentations augs)` The end of the DTD.
`void`	`endElement(QName element, Augmentations augs)` The end of an element.
`void`	`endExternalSubset(Augmentations augs)` The end of the DTD external subset.
`void`	`endGeneralEntity(String name, Augmentations augs)` This method notifies the end of a general entity.
`void`	`endParameterEntity(String name, Augmentations augs)` This method notifies the end of a parameter entity.
`void`	`externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)` An external entity declaration.
`Document`	`getDocument()` Returns the DOM document object.
`protected String`	`getDocumentClassName()` This method retreives the name of current document class.
`protected void`	`handleBaseURI(int node)` Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Deferred DOM.
`protected void`	`handleBaseURI(Node node)` Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Non deferred DOM.
`void`	`ignorableWhitespace(XMLString text, Augmentations augs)` Ignorable whitespace.
`void`	`ignoredCharacters(XMLString text, Augmentations augs)` Characters within an IGNORE conditional section.
`void`	`internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)` An internal entity declaration.
`void`	`notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)` A notation declaration
`void`	`processingInstruction(String target, XMLString data, Augmentations augs)` A processing instruction.
`void`	`reset()` Resets the parser state.
`protected void`	`setCharacterData(boolean sawChars)`
`protected void`	`setDocumentClassName(String documentClassName)` This method allows the programmer to decide which document factory to use when constructing the DOM tree.
`void`	`setLocale(Locale locale)` Set the locale to use for messages.
`void`	`startAttlist(String elementName, Augmentations augs)` The start of an attribute list.
`void`	`startCDATA(Augmentations augs)` The start of a CDATA section.
`void`	`startConditional(short type, Augmentations augs)` The start of a conditional section.
`void`	`startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)` The start of the document.
`void`	`startDTD(XMLLocator locator, Augmentations augs)` The start of the DTD.
`void`	`startElement(QName element, XMLAttributes attributes, Augmentations augs)` The start of an element.
`void`	`startExternalSubset(XMLResourceIdentifier identifier, Augmentations augs)` The start of the DTD external subset.
`void`	`startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)` This method notifies the start of a general entity.
`void`	`startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)` This method notifies of the start of a parameter entity.
`void`	`textDecl(String version, String encoding, Augmentations augs)` Notifies of the presence of a TextDecl line in an entity.
`void`	`unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)` An unparsed entity declaration.
`void`	`xmlDecl(String version, String encoding, String standalone, Augmentations augs)` Notifies of the presence of an XMLDecl line in the document.

Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
any, element, empty, endContentModel, endGroup, getDocumentSource, getDTDContentModelSource, getDTDSource, occurrence, pcdata, separator, setDocumentSource, setDTDContentModelSource, setDTDSource, startContentModel, startGroup

Methods inherited from class org.apache.xerces.parsers.XMLParser
parse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAMESPACES
```
protected static final String NAMESPACES
```
    Feature id: namespace.
    
    See Also:
    Constant Field Values
  - CREATE_ENTITY_REF_NODES
```
protected static final String CREATE_ENTITY_REF_NODES
```
    Feature id: create entity ref nodes.
    
    See Also:
    Constant Field Values
  - INCLUDE_COMMENTS_FEATURE
```
protected static final String INCLUDE_COMMENTS_FEATURE
```
    Feature id: include comments.
    
    See Also:
    Constant Field Values
  - CREATE_CDATA_NODES_FEATURE
```
protected static final String CREATE_CDATA_NODES_FEATURE
```
    Feature id: create cdata nodes.
    
    See Also:
    Constant Field Values
  - INCLUDE_IGNORABLE_WHITESPACE
```
protected static final String INCLUDE_IGNORABLE_WHITESPACE
```
    Feature id: include ignorable whitespace.
    
    See Also:
    Constant Field Values
  - DEFER_NODE_EXPANSION
```
protected static final String DEFER_NODE_EXPANSION
```
    Feature id: defer node expansion.
    
    See Also:
    Constant Field Values
  - DOCUMENT_CLASS_NAME
```
protected static final String DOCUMENT_CLASS_NAME
```
    Property id: document class name.
    
    See Also:
    Constant Field Values
  - CURRENT_ELEMENT_NODE
```
protected static final String CURRENT_ELEMENT_NODE
```
    See Also:
    Constant Field Values
  - DEFAULT_DOCUMENT_CLASS_NAME
```
protected static final String DEFAULT_DOCUMENT_CLASS_NAME
```
    Default document class name.
    
    See Also:
    Constant Field Values
  - CORE_DOCUMENT_CLASS_NAME
```
protected static final String CORE_DOCUMENT_CLASS_NAME
```
    See Also:
    Constant Field Values
  - PSVI_DOCUMENT_CLASS_NAME
```
protected static final String PSVI_DOCUMENT_CLASS_NAME
```
    See Also:
    Constant Field Values
  - fErrorHandler
```
protected DOMErrorHandlerWrapper fErrorHandler
```
    DOM L3 error handler
  - fInDTD
```
protected boolean fInDTD
```
    True if inside DTD.
  - fCreateEntityRefNodes
```
protected boolean fCreateEntityRefNodes
```
    Create entity reference nodes.
  - fIncludeIgnorableWhitespace
```
protected boolean fIncludeIgnorableWhitespace
```
    Include ignorable whitespace.
  - fIncludeComments
```
protected boolean fIncludeComments
```
    Include Comments.
  - fCreateCDATANodes
```
protected boolean fCreateCDATANodes
```
    Create cdata nodes.
  - fDocument
```
protected Document fDocument
```
    The document.
  - fDocumentImpl
```
protected CoreDocumentImpl fDocumentImpl
```
    The default Xerces document implementation, if used.
  - fStorePSVI
```
protected boolean fStorePSVI
```
    Whether to store PSVI information in DOM tree.
  - fDocumentClassName
```
protected String fDocumentClassName
```
    The document class name to use.
  - fDocumentType
```
protected DocumentType fDocumentType
```
    The document type node.
  - fCurrentNode
```
protected Node fCurrentNode
```
    Current node.
  - fCurrentCDATASection
```
protected CDATASection fCurrentCDATASection
```
  - fCurrentEntityDecl
```
protected EntityImpl fCurrentEntityDecl
```
  - fDeferredEntityDecl
```
protected int fDeferredEntityDecl
```
  - fStringBuffer
```
protected final StringBuffer fStringBuffer
```
    Character buffer
  - fInternalSubset
```
protected StringBuffer fInternalSubset
```
    Internal subset buffer.
  - fDeferNodeExpansion
```
protected boolean fDeferNodeExpansion
```
  - fNamespaceAware
```
protected boolean fNamespaceAware
```
  - fDeferredDocumentImpl
```
protected DeferredDocumentImpl fDeferredDocumentImpl
```
  - fDocumentIndex
```
protected int fDocumentIndex
```
  - fDocumentTypeIndex
```
protected int fDocumentTypeIndex
```
  - fCurrentNodeIndex
```
protected int fCurrentNodeIndex
```
  - fCurrentCDATASectionIndex
```
protected int fCurrentCDATASectionIndex
```
  - fInDTDExternalSubset
```
protected boolean fInDTDExternalSubset
```
    True if inside DTD external subset.
  - fRoot
```
protected Node fRoot
```
    Root element node.
  - fInCDATASection
```
protected boolean fInCDATASection
```
    True if inside CDATA section.
  - fFirstChunk
```
protected boolean fFirstChunk
```
    True if saw the first chunk of characters
  - fFilterReject
```
protected boolean fFilterReject
```
    LSParserFilter: specifies that element with given QNAME and all its children must be rejected
  - fBaseURIStack
```
protected final Stack fBaseURIStack
```
    Base uri stack
  - fRejectedElementDepth
```
protected int fRejectedElementDepth
```
    LSParserFilter: tracks the element depth within a rejected subtree.
  - fSkippedElemStack
```
protected Stack fSkippedElemStack
```
    LSParserFilter: store depth of skipped elements
  - fInEntityRef
```
protected boolean fInEntityRef
```
    LSParserFilter: true if inside entity reference
  - fDOMFilter
```
protected LSParserFilter fDOMFilter
```
- Constructor Detail
  - AbstractDOMParser
```
protected AbstractDOMParser(XMLParserConfiguration config)
```
    Default constructor.
- Method Detail
  - getDocumentClassName
```
protected String getDocumentClassName()
```
    This method retreives the name of current document class.
  - setDocumentClassName
```
protected void setDocumentClassName(String documentClassName)
```
    This method allows the programmer to decide which document factory to use when constructing the DOM tree. However, doing so will lose the functionality of the default factory. Also, a document class other than the default will lose the ability to defer node expansion on the DOM tree produced.
    
    Parameters:
    documentClassName - The fully qualified class name of the document factory to use when constructing the DOM tree.
    See Also:
    getDocumentClassName(), DEFAULT_DOCUMENT_CLASS_NAME
  - getDocument
```
public Document getDocument()
```
    Returns the DOM document object.
  - dropDocumentReferences
```
public final void dropDocumentReferences()
```
    Drops all references to the last DOM which was built by this parser.
  - reset
```
public void reset()
           throws XNIException
```
    Resets the parser state.
    
    Overrides:
    
    reset in class AbstractXMLDocumentParser
    
    Throws:
    
    SAXException - Thrown on initialization error.
    
    XNIException
  - setLocale
```
public void setLocale(Locale locale)
```
    Set the locale to use for messages.
    
    Parameters:
    locale - The locale object to use for localization of messages.
  - startGeneralEntity
```
public void startGeneralEntity(String name,
                      XMLResourceIdentifier identifier,
                      String encoding,
                      Augmentations augs)
                        throws XNIException
```
    This method notifies the start of a general entity.
    Note: This method is not called for entity references appearing as part of attribute values.
    
    Specified by:
    
    startGeneralEntity in interface XMLDocumentHandler
    
    Overrides:
    
    startGeneralEntity in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the general entity.
    identifier - The resource identifier.
    encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - textDecl
```
public void textDecl(String version,
            String encoding,
            Augmentations augs)
              throws XNIException
```
    Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.
    Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.
    Note: This method is not called for entity references appearing as part of attribute values.
    
    Specified by:
    
    textDecl in interface XMLDocumentHandler
    
    Specified by:
    
    textDecl in interface XMLDTDHandler
    
    Overrides:
    
    textDecl in class AbstractXMLDocumentParser
    
    Parameters:
    version - The XML version, or null if not specified.
    encoding - The IANA encoding name of the entity.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - comment
```
public void comment(XMLString text,
           Augmentations augs)
             throws XNIException
```
    A comment.
    
    Specified by:
    
    comment in interface XMLDocumentHandler
    
    Specified by:
    
    comment in interface XMLDTDHandler
    
    Overrides:
    
    comment in class AbstractXMLDocumentParser
    
    Parameters:
    text - The text in the comment.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by application to signal an error.
  - processingInstruction
```
public void processingInstruction(String target,
                         XMLString data,
                         Augmentations augs)
                           throws XNIException
```
    A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.
    Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.
    
    Specified by:
    
    processingInstruction in interface XMLDocumentHandler
    
    Specified by:
    
    processingInstruction in interface XMLDTDHandler
    
    Overrides:
    
    processingInstruction in class AbstractXMLDocumentParser
    
    Parameters:
    target - The target.
    data - The data or null if none specified.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startDocument
```
public void startDocument(XMLLocator locator,
                 String encoding,
                 NamespaceContext namespaceContext,
                 Augmentations augs)
                   throws XNIException
```
    The start of the document.
    
    Specified by:
    
    startDocument in interface XMLDocumentHandler
    
    Overrides:
    
    startDocument in class AbstractXMLDocumentParser
    
    Parameters:
    locator - The system identifier of the entity if the entity is external, null otherwise.
    encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
    namespaceContext - The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - xmlDecl
```
public void xmlDecl(String version,
           String encoding,
           String standalone,
           Augmentations augs)
             throws XNIException
```
    Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
    
    Specified by:
    
    xmlDecl in interface XMLDocumentHandler
    
    Overrides:
    
    xmlDecl in class AbstractXMLDocumentParser
    
    Parameters:
    version - The XML version.
    encoding - The IANA encoding name of the document, or null if not specified.
    standalone - The standalone value, or null if not specified.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - doctypeDecl
```
public void doctypeDecl(String rootElement,
               String publicId,
               String systemId,
               Augmentations augs)
                 throws XNIException
```
    Notifies of the presence of the DOCTYPE line in the document.
    
    Specified by:
    
    doctypeDecl in interface XMLDocumentHandler
    
    Overrides:
    
    doctypeDecl in class AbstractXMLDocumentParser
    
    Parameters:
    rootElement - The name of the root element.
    publicId - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
    systemId - The system identifier if an external DTD, null otherwise.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startElement
```
public void startElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException
```
    The start of an element. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods.
    
    Specified by:
    
    startElement in interface XMLDocumentHandler
    
    Overrides:
    
    startElement in class AbstractXMLDocumentParser
    
    Parameters:
    element - The name of the element.
    attributes - The element attributes.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - emptyElement
```
public void emptyElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException
```
    An empty element.
    
    Specified by:
    
    emptyElement in interface XMLDocumentHandler
    
    Overrides:
    
    emptyElement in class AbstractXMLDocumentParser
    
    Parameters:
    element - The name of the element.
    attributes - The element attributes.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - characters
```
public void characters(XMLString text,
              Augmentations augs)
                throws XNIException
```
    Character content.
    
    Specified by:
    
    characters in interface XMLDocumentHandler
    
    Overrides:
    
    characters in class AbstractXMLDocumentParser
    
    Parameters:
    text - The content.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - ignorableWhitespace
```
public void ignorableWhitespace(XMLString text,
                       Augmentations augs)
                         throws XNIException
```
    Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.
    
    Specified by:
    
    ignorableWhitespace in interface XMLDocumentHandler
    
    Overrides:
    
    ignorableWhitespace in class AbstractXMLDocumentParser
    
    Parameters:
    text - The ignorable whitespace.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endElement
```
public void endElement(QName element,
              Augmentations augs)
                throws XNIException
```
    The end of an element.
    
    Specified by:
    
    endElement in interface XMLDocumentHandler
    
    Overrides:
    
    endElement in class AbstractXMLDocumentParser
    
    Parameters:
    element - The name of the element.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startCDATA
```
public void startCDATA(Augmentations augs)
                throws XNIException
```
    The start of a CDATA section.
    
    Specified by:
    
    startCDATA in interface XMLDocumentHandler
    
    Overrides:
    
    startCDATA in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endCDATA
```
public void endCDATA(Augmentations augs)
              throws XNIException
```
    The end of a CDATA section.
    
    Specified by:
    
    endCDATA in interface XMLDocumentHandler
    
    Overrides:
    
    endCDATA in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endDocument
```
public void endDocument(Augmentations augs)
                 throws XNIException
```
    The end of the document.
    
    Specified by:
    
    endDocument in interface XMLDocumentHandler
    
    Overrides:
    
    endDocument in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endGeneralEntity
```
public void endGeneralEntity(String name,
                    Augmentations augs)
                      throws XNIException
```
    This method notifies the end of a general entity.
    Note: This method is not called for entity references appearing as part of attribute values.
    
    Specified by:
    
    endGeneralEntity in interface XMLDocumentHandler
    
    Overrides:
    
    endGeneralEntity in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the entity.
    augs - Additional information that may include infoset augmentations
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - handleBaseURI
```
protected final void handleBaseURI(Node node)
```
    Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Non deferred DOM.
    
    Parameters:
    node -
  - handleBaseURI
```
protected final void handleBaseURI(int node)
```
    Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Deferred DOM.
    
    Parameters:
    node -
  - startDTD
```
public void startDTD(XMLLocator locator,
            Augmentations augs)
              throws XNIException
```
    The start of the DTD.
    
    Specified by:
    
    startDTD in interface XMLDTDHandler
    
    Overrides:
    
    startDTD in class AbstractXMLDocumentParser
    
    Parameters:
    locator - The document locator, or null if the document location cannot be reported during the parsing of the document DTD. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier of the DTD.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endDTD
```
public void endDTD(Augmentations augs)
            throws XNIException
```
    The end of the DTD.
    
    Specified by:
    
    endDTD in interface XMLDTDHandler
    
    Overrides:
    
    endDTD in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startConditional
```
public void startConditional(short type,
                    Augmentations augs)
                      throws XNIException
```
    The start of a conditional section.
    
    Specified by:
    
    startConditional in interface XMLDTDHandler
    
    Overrides:
    
    startConditional in class AbstractXMLDocumentParser
    
    Parameters:
    type - The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
    See Also:
    XMLDTDHandler.CONDITIONAL_INCLUDE, XMLDTDHandler.CONDITIONAL_IGNORE
  - endConditional
```
public void endConditional(Augmentations augs)
                    throws XNIException
```
    The end of a conditional section.
    
    Specified by:
    
    endConditional in interface XMLDTDHandler
    
    Overrides:
    
    endConditional in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startExternalSubset
```
public void startExternalSubset(XMLResourceIdentifier identifier,
                       Augmentations augs)
                         throws XNIException
```
    The start of the DTD external subset.
    
    Specified by:
    
    startExternalSubset in interface XMLDTDHandler
    
    Overrides:
    
    startExternalSubset in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations.
    identifier - The resource identifier.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endExternalSubset
```
public void endExternalSubset(Augmentations augs)
                       throws XNIException
```
    The end of the DTD external subset.
    
    Specified by:
    
    endExternalSubset in interface XMLDTDHandler
    
    Overrides:
    
    endExternalSubset in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - internalEntityDecl
```
public void internalEntityDecl(String name,
                      XMLString text,
                      XMLString nonNormalizedText,
                      Augmentations augs)
                        throws XNIException
```
    An internal entity declaration.
    
    Specified by:
    
    internalEntityDecl in interface XMLDTDHandler
    
    Overrides:
    
    internalEntityDecl in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
    text - The value of the entity.
    nonNormalizedText - The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - externalEntityDecl
```
public void externalEntityDecl(String name,
                      XMLResourceIdentifier identifier,
                      Augmentations augs)
                        throws XNIException
```
    An external entity declaration.
    
    Specified by:
    
    externalEntityDecl in interface XMLDTDHandler
    
    Overrides:
    
    externalEntityDecl in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
    identifier - An object containing all location information pertinent to this notation.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startParameterEntity
```
public void startParameterEntity(String name,
                        XMLResourceIdentifier identifier,
                        String encoding,
                        Augmentations augs)
                          throws XNIException
```
    This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.
    
    Specified by:
    
    startParameterEntity in interface XMLDTDHandler
    
    Overrides:
    
    startParameterEntity in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the parameter entity.
    identifier - The resource identifier.
    encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal parameter entities).
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endParameterEntity
```
public void endParameterEntity(String name,
                      Augmentations augs)
                        throws XNIException
```
    This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.
    
    Specified by:
    
    endParameterEntity in interface XMLDTDHandler
    
    Overrides:
    
    endParameterEntity in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the parameter entity.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - unparsedEntityDecl
```
public void unparsedEntityDecl(String name,
                      XMLResourceIdentifier identifier,
                      String notation,
                      Augmentations augs)
                        throws XNIException
```
    An unparsed entity declaration.
    
    Specified by:
    
    unparsedEntityDecl in interface XMLDTDHandler
    
    Overrides:
    
    unparsedEntityDecl in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the entity.
    identifier - An object containing all location information pertinent to this entity.
    notation - The name of the notation.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - notationDecl
```
public void notationDecl(String name,
                XMLResourceIdentifier identifier,
                Augmentations augs)
                  throws XNIException
```
    A notation declaration
    
    Specified by:
    
    notationDecl in interface XMLDTDHandler
    
    Overrides:
    
    notationDecl in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the notation.
    identifier - An object containing all location information pertinent to this notation.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - ignoredCharacters
```
public void ignoredCharacters(XMLString text,
                     Augmentations augs)
                       throws XNIException
```
    Characters within an IGNORE conditional section.
    
    Specified by:
    
    ignoredCharacters in interface XMLDTDHandler
    
    Overrides:
    
    ignoredCharacters in class AbstractXMLDocumentParser
    
    Parameters:
    text - The ignored text.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - elementDecl
```
public void elementDecl(String name,
               String contentModel,
               Augmentations augs)
                 throws XNIException
```
    An element declaration.
    
    Specified by:
    
    elementDecl in interface XMLDTDHandler
    
    Overrides:
    
    elementDecl in class AbstractXMLDocumentParser
    
    Parameters:
    name - The name of the element.
    contentModel - The element content model.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - attributeDecl
```
public void attributeDecl(String elementName,
                 String attributeName,
                 String type,
                 String[] enumeration,
                 String defaultType,
                 XMLString defaultValue,
                 XMLString nonNormalizedDefaultValue,
                 Augmentations augs)
                   throws XNIException
```
    An attribute declaration.
    
    Specified by:
    
    attributeDecl in interface XMLDTDHandler
    
    Overrides:
    
    attributeDecl in class AbstractXMLDocumentParser
    
    Parameters:
    elementName - The name of the element that this attribute is associated with.
    attributeName - The name of the attribute.
    type - The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
    enumeration - If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null.
    defaultType - The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null.
    defaultValue - The attribute default value, or null if no default value is specified.
    nonNormalizedDefaultValue - The attribute default value with no normalization performed, or null if no default value is specified.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - startAttlist
```
public void startAttlist(String elementName,
                Augmentations augs)
                  throws XNIException
```
    The start of an attribute list.
    
    Specified by:
    
    startAttlist in interface XMLDTDHandler
    
    Overrides:
    
    startAttlist in class AbstractXMLDocumentParser
    
    Parameters:
    elementName - The name of the element that this attribute list is associated with.
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - endAttlist
```
public void endAttlist(Augmentations augs)
                throws XNIException
```
    The end of an attribute list.
    
    Specified by:
    
    endAttlist in interface XMLDTDHandler
    
    Overrides:
    
    endAttlist in class AbstractXMLDocumentParser
    
    Parameters:
    augs - Additional information that may include infoset augmentations.
    
    Throws:
    
    XNIException - Thrown by handler to signal an error.
  - createElementNode
```
protected Element createElementNode(QName element)
```
  - createAttrNode
```
protected Attr createAttrNode(QName attrQName)
```
  - setCharacterData
```
protected void setCharacterData(boolean sawChars)
```
  - abort
```
public void abort()
```
    See Also:
    LSParser.abort()

Class AbstractDOMParser

Field Summary

Fields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

Fields inherited from class org.apache.xerces.parsers.XMLParser

Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler

Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler

Constructor Summary

Method Summary

Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

Methods inherited from class org.apache.xerces.parsers.XMLParser

Methods inherited from class java.lang.Object

Field Detail

NAMESPACES

CREATE_ENTITY_REF_NODES

INCLUDE_COMMENTS_FEATURE

CREATE_CDATA_NODES_FEATURE

INCLUDE_IGNORABLE_WHITESPACE

DEFER_NODE_EXPANSION

DOCUMENT_CLASS_NAME

CURRENT_ELEMENT_NODE

DEFAULT_DOCUMENT_CLASS_NAME

CORE_DOCUMENT_CLASS_NAME

PSVI_DOCUMENT_CLASS_NAME

fErrorHandler

fInDTD

fCreateEntityRefNodes

fIncludeIgnorableWhitespace

fIncludeComments

fCreateCDATANodes

fDocument

fDocumentImpl

fStorePSVI

fDocumentClassName

fDocumentType

fCurrentNode

fCurrentCDATASection

fCurrentEntityDecl

fDeferredEntityDecl

fStringBuffer

fInternalSubset

fDeferNodeExpansion

fNamespaceAware

fDeferredDocumentImpl

fDocumentIndex

fDocumentTypeIndex

fCurrentNodeIndex

fCurrentCDATASectionIndex

fInDTDExternalSubset

fRoot

fInCDATASection

fFirstChunk

fFilterReject

fBaseURIStack

fRejectedElementDepth

fSkippedElemStack

fInEntityRef

fDOMFilter

Constructor Detail

AbstractDOMParser

Method Detail

getDocumentClassName

setDocumentClassName

getDocument

dropDocumentReferences

reset

setLocale

startGeneralEntity

textDecl

comment

processingInstruction

startDocument

xmlDecl

doctypeDecl

startElement

emptyElement

characters

ignorableWhitespace

endElement

startCDATA

endCDATA