org.apache.xerces.parsers

Class AbstractDOMParser

Implemented Interfaces:
org.apache.xerces.xni.XMLDocumentHandler, org.apache.xerces.xni.XMLDTDContentModelHandler, org.apache.xerces.xni.XMLDTDHandler
Known Direct 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: AbstractDOMParser.java,v 1.116 2005/05/09 19:46:17 ankitp Exp $
Authors:
Arnaud Le Hors, IBM
Andy Clark, IBM
Elena Litani, IBM

Field Summary

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 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
static RuntimeException
abort
If the user stops the process, this exception will be thrown.
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 LSParserFilter
fDOMFilter
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 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
fInDTD
True if inside DTD.
protected boolean
fInDTDExternalSubset
True if inside DTD external subset.
protected boolean
fInEntityRef
LSParserFilter: true if inside entity reference
protected boolean
fIncludeComments
Include Comments.
protected boolean
fIncludeIgnorableWhitespace
Include ignorable whitespace.
protected StringBuffer
fInternalSubset
Internal subset buffer.
protected boolean
fNamespaceAware
protected org.apache.xerces.xni.QName
fRejectedElement
LSParserFilter: the QNAME of rejected element
protected org.apache.xerces.xni.QName
fRoot
Root element name
protected Stack
fSkippedElemStack
LSParserFilter: store qnames of skipped elements
protected boolean
fStorePSVI
Whether to store PSVI information in DOM tree.
protected StringBuffer
fStringBuffer
Character buffer

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

fDTDContentModelSource, fDTDSource, fDocumentSource, fInDTD

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

ENTITY_RESOLVER, ERROR_HANDLER, fConfiguration

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

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

CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Constructor Summary

AbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Default constructor.

Method Summary

void
abort()
void
attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, org.apache.xerces.xni.XMLString defaultValue, org.apache.xerces.xni.XMLString nonNormalizedDefaultValue, org.apache.xerces.xni.Augmentations augs)
An attribute declaration.
void
characters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Character content.
void
comment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
A comment.
protected Attr
createAttrNode(org.apache.xerces.xni.QName attrQName)
protected Element
createElementNode(org.apache.xerces.xni.QName element)
void
doctypeDecl(String rootElement, String publicId, String systemId, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
void
elementDecl(String name, String contentModel, org.apache.xerces.xni.Augmentations augs)
An element declaration.
void
emptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
An empty element.
void
endAttlist(org.apache.xerces.xni.Augmentations augs)
The end of an attribute list.
void
endCDATA(org.apache.xerces.xni.Augmentations augs)
The end of a CDATA section.
void
endConditional(org.apache.xerces.xni.Augmentations augs)
The end of a conditional section.
void
endDTD(org.apache.xerces.xni.Augmentations augs)
The end of the DTD.
void
endDocument(org.apache.xerces.xni.Augmentations augs)
The end of the document.
void
endElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs)
The end of an element.
void
endExternalSubset(org.apache.xerces.xni.Augmentations augs)
The end of the DTD external subset.
void
endGeneralEntity(String name, org.apache.xerces.xni.Augmentations augs)
This method notifies the end of a general entity.
void
endParameterEntity(String name, org.apache.xerces.xni.Augmentations augs)
This method notifies the end of a parameter entity.
void
externalEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.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(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.
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.
void
ignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Ignorable whitespace.
void
ignoredCharacters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Characters within an IGNORE conditional section.
void
internalEntityDecl(String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augs)
An internal entity declaration.
void
notationDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs)
A notation declaration
void
processingInstruction(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.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, org.apache.xerces.xni.Augmentations augs)
The start of an attribute list.
void
startCDATA(org.apache.xerces.xni.Augmentations augs)
The start of a CDATA section.
void
startConditional(short type, org.apache.xerces.xni.Augmentations augs)
The start of a conditional section.
void
startDTD(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augs)
The start of the DTD.
void
startDocument(org.apache.xerces.xni.XMLLocator locator, String encoding, org.apache.xerces.xni.NamespaceContext namespaceContext, org.apache.xerces.xni.Augmentations augs)
The start of the document.
void
startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
The start of an element.
void
startExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs)
The start of the DTD external subset.
void
startGeneralEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs)
This method notifies the start of a general entity.
void
startParameterEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs)
This method notifies of the start of a parameter entity.
void
textDecl(String version, String encoding, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
void
unparsedEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String notation, org.apache.xerces.xni.Augmentations augs)
An unparsed entity declaration.
void
xmlDecl(String version, String encoding, String standalone, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

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

any, attributeDecl, characters, comment, doctypeDecl, element, elementDecl, empty, emptyElement, endAttlist, endCDATA, endConditional, endContentModel, endDTD, endDocument, endElement, endExternalSubset, endGeneralEntity, endGroup, endParameterEntity, externalEntityDecl, getDTDContentModelSource, getDTDSource, getDocumentSource, ignorableWhitespace, ignoredCharacters, internalEntityDecl, notationDecl, occurrence, pcdata, processingInstruction, reset, separator, setDTDContentModelSource, setDTDSource, setDocumentSource, startAttlist, startCDATA, startConditional, startContentModel, startDTD, startDocument, startElement, startExternalSubset, startGeneralEntity, startGroup, startParameterEntity, textDecl, unparsedEntityDecl, xmlDecl

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

parse, reset

Field Details

CORE_DOCUMENT_CLASS_NAME

protected static final String CORE_DOCUMENT_CLASS_NAME

CREATE_CDATA_NODES_FEATURE

protected static final String CREATE_CDATA_NODES_FEATURE
Feature id: create cdata nodes.

CREATE_ENTITY_REF_NODES

protected static final String CREATE_ENTITY_REF_NODES
Feature id: create entity ref nodes.

CURRENT_ELEMENT_NODE

protected static final String CURRENT_ELEMENT_NODE

DEFAULT_DOCUMENT_CLASS_NAME

protected static final String DEFAULT_DOCUMENT_CLASS_NAME
Default document class name.

DEFER_NODE_EXPANSION

protected static final String DEFER_NODE_EXPANSION
Feature id: defer node expansion.

DOCUMENT_CLASS_NAME

protected static final String DOCUMENT_CLASS_NAME
Property id: document class name.

INCLUDE_COMMENTS_FEATURE

protected static final String INCLUDE_COMMENTS_FEATURE
Feature id: include comments.

INCLUDE_IGNORABLE_WHITESPACE

protected static final String INCLUDE_IGNORABLE_WHITESPACE
Feature id: include ignorable whitespace.

NAMESPACES

protected static final String NAMESPACES
Feature id: namespace.

PSVI_DOCUMENT_CLASS_NAME

protected static final String PSVI_DOCUMENT_CLASS_NAME

abort

public static final RuntimeException abort
If the user stops the process, this exception will be thrown.

fBaseURIStack

protected Stack fBaseURIStack
Base uri stack

fCreateCDATANodes

protected boolean fCreateCDATANodes
Create cdata nodes.

fCreateEntityRefNodes

protected boolean fCreateEntityRefNodes
Create entity reference nodes.

fCurrentCDATASection

protected CDATASection fCurrentCDATASection

fCurrentCDATASectionIndex

protected int fCurrentCDATASectionIndex

fCurrentEntityDecl

protected EntityImpl fCurrentEntityDecl

fCurrentNode

protected Node fCurrentNode
Current node.

fCurrentNodeIndex

protected int fCurrentNodeIndex

fDOMFilter

protected LSParserFilter fDOMFilter

fDeferNodeExpansion

protected boolean fDeferNodeExpansion

fDeferredDocumentImpl

protected DeferredDocumentImpl fDeferredDocumentImpl

fDeferredEntityDecl

protected int fDeferredEntityDecl

fDocument

protected Document fDocument
The document.

fDocumentClassName

protected String fDocumentClassName
The document class name to use.

fDocumentImpl

protected CoreDocumentImpl fDocumentImpl
The default Xerces document implementation, if used.

fDocumentIndex

protected int fDocumentIndex

fDocumentType

protected DocumentType fDocumentType
The document type node.

fDocumentTypeIndex

protected int fDocumentTypeIndex

fErrorHandler

protected DOMErrorHandlerWrapper fErrorHandler
DOM L3 error handler

fFilterReject

protected boolean fFilterReject
LSParserFilter: specifies that element with given QNAME and all its children must be rejected

fFirstChunk

protected boolean fFirstChunk
True if saw the first chunk of characters

fInCDATASection

protected boolean fInCDATASection
True if inside CDATA section.

fInDTD

protected boolean fInDTD
True if inside DTD.

fInDTDExternalSubset

protected boolean fInDTDExternalSubset
True if inside DTD external subset.

fInEntityRef

protected boolean fInEntityRef
LSParserFilter: true if inside entity reference

fIncludeComments

protected boolean fIncludeComments
Include Comments.

fIncludeIgnorableWhitespace

protected boolean fIncludeIgnorableWhitespace
Include ignorable whitespace.

fInternalSubset

protected StringBuffer fInternalSubset
Internal subset buffer.

fNamespaceAware

protected boolean fNamespaceAware

fRejectedElement

protected final org.apache.xerces.xni.QName fRejectedElement
LSParserFilter: the QNAME of rejected element

fRoot

protected org.apache.xerces.xni.QName fRoot
Root element name

fSkippedElemStack

protected Stack fSkippedElemStack
LSParserFilter: store qnames of skipped elements

fStorePSVI

protected boolean fStorePSVI
Whether to store PSVI information in DOM tree.

fStringBuffer

protected final StringBuffer fStringBuffer
Character buffer

Constructor Details

AbstractDOMParser

protected AbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Default constructor.

Method Details

abort

public void abort()
See Also:
org.w3c.dom.ls.LSParser.abort()

attributeDecl

public void attributeDecl(String elementName,
                          String attributeName,
                          String type,
                          String[] enumeration,
                          String defaultType,
                          org.apache.xerces.xni.XMLString defaultValue,
                          org.apache.xerces.xni.XMLString nonNormalizedDefaultValue,
                          org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An attribute declaration.
Specified by:
attributeDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
attributeDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

characters

public void characters(org.apache.xerces.xni.XMLString text,
                       org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
Character content.
Specified by:
characters in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
characters in interface AbstractXMLDocumentParser
Parameters:
text - The content.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

comment

public void comment(org.apache.xerces.xni.XMLString text,
                    org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
A comment.
Specified by:
comment in interface org.apache.xerces.xni.XMLDocumentHandler
comment in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
comment in interface AbstractXMLDocumentParser
Parameters:
text - The text in the comment.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by application to signal an error.

createAttrNode

protected Attr createAttrNode(org.apache.xerces.xni.QName attrQName)

createElementNode

protected Element createElementNode(org.apache.xerces.xni.QName element)

doctypeDecl

public void doctypeDecl(String rootElement,
                        String publicId,
                        String systemId,
                        org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
Notifies of the presence of the DOCTYPE line in the document.
Specified by:
doctypeDecl in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
doctypeDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

elementDecl

public void elementDecl(String name,
                        String contentModel,
                        org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An element declaration.
Specified by:
elementDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
elementDecl in interface AbstractXMLDocumentParser
Parameters:
name - The name of the element.
contentModel - The element content model.
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An empty element.
Specified by:
emptyElement in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
emptyElement in interface AbstractXMLDocumentParser
Parameters:
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endAttlist

public void endAttlist(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of an attribute list.
Specified by:
endAttlist in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
endAttlist in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of a CDATA section.
Specified by:
endCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
endCDATA in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endConditional

public void endConditional(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of a conditional section.
Specified by:
endConditional in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
endConditional in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endDTD

public void endDTD(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of the DTD.
Specified by:
endDTD in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
endDTD in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of the document.
Specified by:
endDocument in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
endDocument in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endElement

public void endElement(org.apache.xerces.xni.QName element,
                       org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of an element.
Specified by:
endElement in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
endElement in interface AbstractXMLDocumentParser
Parameters:
element - The name of the element.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endExternalSubset

public void endExternalSubset(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The end of the DTD external subset.
Specified by:
endExternalSubset in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
endExternalSubset in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name,
                             org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
Overrides:
endGeneralEntity in interface AbstractXMLDocumentParser
Parameters:
name - The name of the entity.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endParameterEntity

public void endParameterEntity(String name,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.
Specified by:
endParameterEntity in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
endParameterEntity in interface AbstractXMLDocumentParser
Parameters:
name - The name of the parameter entity.
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

externalEntityDecl

public void externalEntityDecl(String name,
                               org.apache.xerces.xni.XMLResourceIdentifier identifier,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An external entity declaration.
Specified by:
externalEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
externalEntityDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

getDocument

public Document getDocument()
Returns the DOM document object.

getDocumentClassName

protected String getDocumentClassName()
This method retreives the name of current document class.

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 -

ignorableWhitespace

public void ignorableWhitespace(org.apache.xerces.xni.XMLString text,
                                org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
Overrides:
ignorableWhitespace in interface AbstractXMLDocumentParser
Parameters:
text - The ignorable whitespace.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

ignoredCharacters

public void ignoredCharacters(org.apache.xerces.xni.XMLString text,
                              org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
Characters within an IGNORE conditional section.
Specified by:
ignoredCharacters in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
ignoredCharacters in interface AbstractXMLDocumentParser
Parameters:
text - The ignored text.
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

internalEntityDecl

public void internalEntityDecl(String name,
                               org.apache.xerces.xni.XMLString text,
                               org.apache.xerces.xni.XMLString nonNormalizedText,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An internal entity declaration.
Specified by:
internalEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
internalEntityDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

notationDecl

public void notationDecl(String name,
                         org.apache.xerces.xni.XMLResourceIdentifier identifier,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
A notation declaration
Specified by:
notationDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
notationDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

processingInstruction

public void processingInstruction(String target,
                                  org.apache.xerces.xni.XMLString data,
                                  org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
processingInstruction in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
processingInstruction in interface AbstractXMLDocumentParser
Parameters:
target - The target.
data - The data or null if none specified.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

reset

public void reset()
            throws org.apache.xerces.xni.XNIException
Resets the parser state.
Overrides:
reset in interface AbstractXMLDocumentParser

setCharacterData

protected void setCharacterData(boolean sawChars)

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.

setLocale

public void setLocale(Locale locale)
Set the locale to use for messages.
Parameters:
locale - The locale object to use for localization of messages.

startAttlist

public void startAttlist(String elementName,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of an attribute list.
Specified by:
startAttlist in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
startAttlist in interface AbstractXMLDocumentParser
Parameters:
elementName - The name of the element that this attribute list is associated with.
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of a CDATA section.
Specified by:
startCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
startCDATA in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startConditional

public void startConditional(short type,
                             org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of a conditional section.
Specified by:
startConditional in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
startConditional in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startDTD

public void startDTD(org.apache.xerces.xni.XMLLocator locator,
                     org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of the DTD.
Specified by:
startDTD in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
startDTD in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startDocument

public void startDocument(org.apache.xerces.xni.XMLLocator locator,
                          String encoding,
                          org.apache.xerces.xni.NamespaceContext namespaceContext,
                          org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of the document.
Specified by:
startDocument in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
startDocument in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startElement

public void startElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
Overrides:
startElement in interface AbstractXMLDocumentParser
Parameters:
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startExternalSubset

public void startExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier,
                                org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
The start of the DTD external subset.
Specified by:
startExternalSubset in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
startExternalSubset in interface AbstractXMLDocumentParser
Parameters:
augs - Additional information that may include infoset augmentations.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(String name,
                               org.apache.xerces.xni.XMLResourceIdentifier identifier,
                               String encoding,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
Overrides:
startGeneralEntity in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startParameterEntity

public void startParameterEntity(String name,
                                 org.apache.xerces.xni.XMLResourceIdentifier identifier,
                                 String encoding,
                                 org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.
Specified by:
startParameterEntity in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
startParameterEntity in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

textDecl

public void textDecl(String version,
                     String encoding,
                     org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
textDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
textDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               org.apache.xerces.xni.XMLResourceIdentifier identifier,
                               String notation,
                               org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.XNIException
An unparsed entity declaration.
Specified by:
unparsedEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
Overrides:
unparsedEntityDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(String version,
                    String encoding,
                    String standalone,
                    org.apache.xerces.xni.Augmentations augs)
            throws org.apache.xerces.xni.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 org.apache.xerces.xni.XMLDocumentHandler
Overrides:
xmlDecl in interface 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:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.