net.sourceforge.htmlunit.cyberneko.parsers

Class DOMFragmentParser

java.lang.Object

net.sourceforge.htmlunit.cyberneko.parsers.DOMFragmentParser

All Implemented Interfaces:

XMLDocumentHandler

public class DOMFragmentParser
extends Object
implements XMLDocumentHandler

A DOM parser for HTML fragments.

Author:

Andy Clark

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DOCUMENT_FRAGMENT Document fragment balancing only.
protected static String	ERROR_HANDLER Property identifier: error handler.
protected Node	fCurrentNode Current node.
protected Document	fDocument Document.
protected DocumentFragment	fDocumentFragment DOM document fragment.
protected XMLDocumentSource	fDocumentSource Document source.
protected boolean	fInCDATASection True if within a CDATA section.
protected XMLParserConfiguration	fParserConfiguration Parser configuration.
protected static String[]	RECOGNIZED_FEATURES Recognized features.
protected static String[]	RECOGNIZED_PROPERTIES Recognized properties.

Constructor Summary

Constructors

Constructor and Description
DOMFragmentParser() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	characters(XMLString text, Augmentations augs) Character content.
void	comment(XMLString text, Augmentations augs) A comment.
void	doctypeDecl(String root, String pubid, String sysid, Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.
void	emptyElement(QName element, XMLAttributes attrs, Augmentations augs) An empty element.
void	endCDATA(Augmentations augs) End CDATA section.
void	endDocument(Augmentations augs) End document.
void	endElement(QName element, Augmentations augs) End element.
void	endGeneralEntity(String name, Augmentations augs) End general entity.
XMLDocumentSource	getDocumentSource() Returns the document source.
ErrorHandler	getErrorHandler() Return the current error handler.
boolean	getFeature(String featureId) Query the state of a feature.
void	ignorableWhitespace(XMLString text, Augmentations augs) Ignorable whitespace.
void	parse(InputSource source, DocumentFragment fragment) Parses a document fragment
void	parse(String systemId, DocumentFragment fragment) Parses a document fragment
void	processingInstruction(String target, XMLString data, Augmentations augs) A processing instruction.
void	setDocumentSource(XMLDocumentSource source) Sets the document source.
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) Start CDATA section.
void	startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext, Augmentations augs) The start of the document.
void	startElement(QName element, XMLAttributes attrs, Augmentations augs) The start of an element.
void	startGeneralEntity(String name, XMLResourceIdentifier id, String encoding, Augmentations augs) Start general entity.
void	textDecl(String version, String encoding, Augmentations augs) Text 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENT_FRAGMENT

protected static final String DOCUMENT_FRAGMENT

Document fragment balancing only.

See Also:

Constant Field Values

RECOGNIZED_FEATURES

protected static final String[] RECOGNIZED_FEATURES

Recognized features.

ERROR_HANDLER

protected static final String ERROR_HANDLER

Property identifier: error handler.

See Also:

Constant Field Values

RECOGNIZED_PROPERTIES

protected static final String[] RECOGNIZED_PROPERTIES

Recognized properties.

fParserConfiguration

protected final XMLParserConfiguration fParserConfiguration

Parser configuration.

fDocumentSource

protected XMLDocumentSource fDocumentSource

Document source.

fDocumentFragment

protected DocumentFragment fDocumentFragment

DOM document fragment.

fDocument

protected Document fDocument

Document.

fCurrentNode

protected Node fCurrentNode

Current node.

fInCDATASection

protected boolean fInCDATASection

True if within a CDATA section.

Constructor Detail

DOMFragmentParser

public DOMFragmentParser()

Default constructor.

Method Detail

parse

public void parse(String systemId,
                  DocumentFragment fragment)
           throws SAXException,
                  IOException

Parses a document fragment

Parameters:

systemId - systemId

fragment - fragment

Throws:

SAXException - in case of sax error

IOException - in case of io problems

parse

public void parse(InputSource source,
                  DocumentFragment fragment)
           throws SAXException,
                  IOException

Parses a document fragment

Parameters:

source - input source

fragment - fragment

Throws:

SAXException - in case of sax error

IOException - in case of io problems

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.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)

Sets the document source.

Specified by:

setDocumentSource in interface XMLDocumentHandler

Parameters:

source - the new source

getDocumentSource

public XMLDocumentSource getDocumentSource()

Returns the document source.

Specified by:

getDocumentSource in interface XMLDocumentHandler

Returns:

the document source.

startDocument

public void startDocument(XMLLocator locator,
                          String encoding,
                          NamespaceContext nscontext,
                          Augmentations augs)
                   throws XNIException

Description copied from interface: XMLDocumentHandler

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

Parameters:

locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.

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

nscontext - 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

Description copied from interface: XMLDocumentHandler

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

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 root,
                        String pubid,
                        String sysid,
                        Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

Notifies of the presence of the DOCTYPE line in the document.

Specified by:

doctypeDecl in interface XMLDocumentHandler

Parameters:

root - The name of the root element.

pubid - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.

sysid - 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.

processingInstruction

public void processingInstruction(String target,
                                  XMLString data,
                                  Augmentations augs)
                           throws XNIException

Description copied from interface: XMLDocumentHandler

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

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.

comment

public void comment(XMLString text,
                    Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

A comment.

Specified by:

comment in interface XMLDocumentHandler

Parameters:

text - The text in the comment.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by application to signal an error.

startElement

public void startElement(QName element,
                         XMLAttributes attrs,
                         Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attrs - 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 attrs,
                         Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attrs - 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

Description copied from interface: XMLDocumentHandler

Character content.

Specified by:

characters in interface XMLDocumentHandler

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.

Specified by:

ignorableWhitespace in interface XMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(String name,
                               XMLResourceIdentifier id,
                               String encoding,
                               Augmentations augs)
                        throws XNIException

Start general entity.

Specified by:

startGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the general entity.

id - 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

Text declaration.

Specified by:

textDecl in interface XMLDocumentHandler

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.

endGeneralEntity

public void endGeneralEntity(String name,
                             Augmentations augs)
                      throws XNIException

End general entity.

Specified by:

endGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the entity.

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

Start CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

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

End CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Parameters:

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

End element.

Specified by:

endElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

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

End document.

Specified by:

endDocument in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.