net.sourceforge.htmlunit.xerces.parsers

Class AbstractDOMParser

java.lang.Object

net.sourceforge.htmlunit.xerces.parsers.XMLParser

net.sourceforge.htmlunit.xerces.parsers.AbstractXMLDocumentParser

net.sourceforge.htmlunit.xerces.parsers.AbstractDOMParser

All Implemented Interfaces:

XMLDocumentHandler

Direct Known Subclasses:

DOMParser

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.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
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 Stack<String>	fBaseURIStack Base uri stack
protected boolean	fCreateCDATANodes Create cdata nodes.
protected boolean	fCreateEntityRefNodes Create entity reference nodes.
protected CDATASection	fCurrentCDATASection
protected EntityImpl	fCurrentEntityDecl
protected Node	fCurrentNode Current node.
protected Document	fDocument The document.
protected Class<? extends DocumentImpl>	fDocumentClass The document class to use.
protected CoreDocumentImpl	fDocumentImpl The default Xerces document implementation, if used.
protected DocumentType	fDocumentType The document type node.
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	fNamespaceAware
protected int	fRejectedElementDepth LSParserFilter: tracks the element depth within a rejected subtree.
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.

Fields inherited from class net.sourceforge.htmlunit.xerces.parsers.AbstractXMLDocumentParser

fDocumentSource

Fields inherited from class net.sourceforge.htmlunit.xerces.parsers.XMLParser

ERROR_HANDLER, fConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDOMParser(XMLParserConfiguration config, Class<? extends DocumentImpl> documentClass)

Method Summary

Modifier and Type	Method and Description
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	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element.
void	endCDATA(Augmentations augs) The end of a CDATA section.
void	endDocument(Augmentations augs) The end of the document.
void	endElement(QName element, Augmentations augs) The end of an element.
void	endGeneralEntity(String name, Augmentations augs) This method notifies the end of a general entity.
Document	getDocument()
ErrorHandler	getErrorHandler() Return the current error handler.
boolean	getFeature(String featureId) Query the state of a feature.
XMLParserConfiguration	getXMLParserConfiguration()
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	parse(InputSource inputSource) Parse.
void	parse(String systemId) Parses the input source specified by the given system identifier.
void	processingInstruction(String target, XMLString data, Augmentations augs) A processing instruction.
void	reset() Resets the parser state.
protected void	setCharacterData(boolean sawChars)
protected void	setDocumentClass(Class<? extends DocumentImpl> documentClass) This method allows the programmer to decide which document factory to use when constructing the DOM tree.
void	setErrorHandler(ErrorHandler errorHandler) Allow an application to register an error event handler.
void	setFeature(String featureId, boolean state) Set the state of any feature in a SAX2 parser.
void	setProperty(String propertyId, Object value) Set the value of any property in a SAX2 parser.
void	startCDATA(Augmentations augs) The start of a CDATA section.
void	startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element.
void	startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) This method notifies the start of a general entity.
void	textDecl(String version, String encoding, Augmentations augs) Notifies of the presence of a TextDecl line in an entity.
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 net.sourceforge.htmlunit.xerces.parsers.AbstractXMLDocumentParser

getDocumentSource, setDocumentSource

Methods inherited from class net.sourceforge.htmlunit.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

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.

fDocumentClass

protected Class<? extends DocumentImpl> fDocumentClass

The document class to use.

fDocumentType

protected DocumentType fDocumentType

The document type node.

fCurrentNode

protected Node fCurrentNode

Current node.

fCurrentCDATASection

protected CDATASection fCurrentCDATASection

fCurrentEntityDecl

protected EntityImpl fCurrentEntityDecl

fStringBuffer

protected final StringBuffer fStringBuffer

Character buffer

fNamespaceAware

protected boolean fNamespaceAware

fInCDATASection

protected boolean fInCDATASection

True if inside CDATA section.

fFirstChunk

protected boolean fFirstChunk

True if saw the first chunk of characters

fFilterReject

protected final boolean fFilterReject

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

See Also:

Constant Field Values

fBaseURIStack

protected final Stack<String> fBaseURIStack

Base uri stack

fRejectedElementDepth

protected int fRejectedElementDepth

LSParserFilter: tracks the element depth within a rejected subtree.

Constructor Detail

AbstractDOMParser

protected AbstractDOMParser(XMLParserConfiguration config,
                            Class<? extends DocumentImpl> documentClass)

Method Detail

setDocumentClass

protected void setDocumentClass(Class<? extends DocumentImpl> documentClass)

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:

documentClass - The document factory to use when constructing the DOM tree.

getDocument

public Document getDocument()

Returns:

the DOM document object.

reset

public void reset()
           throws XNIException

Resets the parser state.

Overrides:

reset in class AbstractXMLDocumentParser

Throws:

XNIException - Thrown on initialization error.

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

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

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

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 - the node

createElementNode

protected Element createElementNode(QName element)

createAttrNode

protected Attr createAttrNode(QName attrQName)

setCharacterData

protected void setCharacterData(boolean sawChars)

parse

public void parse(String systemId)
           throws SAXException,
                  IOException

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

public void parse(InputSource inputSource)
           throws SAXException,
                  IOException

Parse.

Parameters:

inputSource - the input source

Throws:

SAXException - on error

IOException - on error

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

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()

getErrorHandler

public ErrorHandler getErrorHandler()

Return the current error handler.

Returns:

The current error handler, or null if none has been registered.

See Also:

setErrorHandler(org.xml.sax.ErrorHandler)

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.

getXMLParserConfiguration

public XMLParserConfiguration getXMLParserConfiguration()

Returns:

this parser's XMLParserConfiguration.