Module org.htmlunit.cyberneko
Package org.htmlunit.cyberneko.xerces.parsers

Class AbstractDOMParser

java.lang.Object
org.htmlunit.cyberneko.xerces.parsers.AbstractXMLDocumentParser
org.htmlunit.cyberneko.xerces.parsers.AbstractDOMParser
All Implemented Interfaces:
XMLDocumentHandler
Direct Known Subclasses:
DOMParser
public class AbstractDOMParser extends AbstractXMLDocumentParser
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, Ronald Brill

  • Field Details

    • NAMESPACES

      protected static final String NAMESPACES
      Feature id: namespace.
      See Also:

    • INCLUDE_COMMENTS_FEATURE

      protected static final String INCLUDE_COMMENTS_FEATURE
      Feature id: include comments.
      See Also:

    • CREATE_CDATA_NODES_FEATURE

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

    • 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

    • fStringBuffer

      protected final XMLString 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.

    • fBaseURIStack

      protected final Stack<String> fBaseURIStack
      Base uri stack.

  • Constructor Details

    • AbstractDOMParser

      protected AbstractDOMParser(XMLParserConfiguration config, Class<? extends DocumentImpl> documentClass)
      Constructs an abstract DOM parser with the specified configuration and document class.
      Parameters:
      config - the parser configuration
      documentClass - the document class to use

  • Method Details

    • setDocumentClass

      protected void setDocumentClass(Class<? extends DocumentImpl> documentClass)
      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.
      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

    • 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 external, null otherwise
      encoding - the auto-detected IANA encoding name of the entity stream, or null if not auto-detected
      namespaceContext - the namespace context in effect at the start of this document
      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 specified using SYSTEM
      systemId - the system identifier if an external DTD, or 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, the startElement method is immediately 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

    • 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

    • handleBaseURI

      protected final void handleBaseURI(Node node)
      Records 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)
      Creates an element node. Subclasses can override this method to create element nodes in other ways.
      Parameters:
      element - the qualified name of the element
      Returns:
      the created element node

    • createAttrNode

      protected Attr createAttrNode(QName attrQName)
      Creates an attribute node. Subclasses can override this method to create attribute nodes in other ways.
      Parameters:
      attrQName - the qualified name of the attribute
      Returns:
      the created attribute node

    • setCharacterData

      protected void setCharacterData(boolean sawChars)
      Appends character data from the string buffer to the current node.
      Parameters:
      sawChars - true if characters were seen

    • 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));

      0* @param systemId the system identifier (URI)
      Throws:
      SAXException - thrown on SAX error
      IOException - thrown on I/O error

    • parse

      public void parse(InputSource inputSource) throws SAXException, IOException
      Parses the document using the specified SAX InputSource.
      Parameters:
      inputSource - the input source
      Throws:
      SAXException - thrown on SAX error
      IOException - thrown on I/O error

    • setErrorHandler

      public void setErrorHandler(ErrorHandler errorHandler)
      Allows 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
      See Also:

    • getErrorHandler

      public ErrorHandler getErrorHandler()
      Returns the current error handler.
      Returns:
      the current error handler, or null if none has been registered
      See Also:

    • setFeature

      public void setFeature(String featureId, boolean state) throws SAXNotRecognizedException, SAXNotSupportedException
      Sets the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if recognized, 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
      Queries the state of a feature.

      Queries 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 queried
      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
      Sets the value of any property in a SAX2 parser. The parser might not recognize the property, and if recognized, 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.
      Returns:
      the parser's configuration