Package nu.validator.htmlparser.dom

Class HtmlDocumentBuilder

  • public class HtmlDocumentBuilder
extends javax.xml.parsers.DocumentBuilder
    This class implements an HTML5 parser that exposes data through the DOM interface.

    By default, when using the constructor without arguments, the this parser coerces XML 1.0-incompatible infosets into XML 1.0-compatible infosets. This corresponds to ALTER_INFOSET as the general XML violation policy. To make the parser support non-conforming HTML fully per the HTML 5 spec while on the other hand potentially violating the SAX2 API contract, set the general XML violation policy to ALLOW. This does not work with a standard DOM implementation. It is possible to treat XML 1.0 infoset violations as fatal by setting the general XML violation policy to FATAL.

    The doctype is not represented in the tree.

    The document mode is represented as user data DocumentMode object with the key nu.validator.document-mode on the document node.

    The form pointer is also stored as user data with the key nu.validator.form-pointer.

    Version:
    $Id$

    • Field Detail

      • driver

        private Driver driver
        The tokenizer.

      • treeBuilder

        private final DOMTreeBuilder treeBuilder
        The tree builder.

      • implementation

        private final org.w3c.dom.DOMImplementation implementation
        The DOM impl.

      • entityResolver

        private org.xml.sax.EntityResolver entityResolver
        The entity resolver.

      • errorHandler

        private org.xml.sax.ErrorHandler errorHandler

      • checkingNormalization

        private boolean checkingNormalization

      • scriptingEnabled

        private boolean scriptingEnabled

      • characterHandlers

        private final java.util.List<CharacterHandler> characterHandlers

      • html4ModeCompatibleWithXhtml1Schemata

        private boolean html4ModeCompatibleWithXhtml1Schemata

      • mappingLangToXmlLang

        private boolean mappingLangToXmlLang

      • reportingDoctype

        private boolean reportingDoctype

      • treeBuilderErrorHandler

        private org.xml.sax.ErrorHandler treeBuilderErrorHandler

    • Constructor Detail

      • HtmlDocumentBuilder

        public HtmlDocumentBuilder​(org.w3c.dom.DOMImplementation implementation,
                           XmlViolationPolicy xmlPolicy)
        Instantiates the document builder with a specific DOM implementation and XML violation policy.
        Parameters:
        implementation - the DOM implementation
        xmlPolicy - the policy

      • HtmlDocumentBuilder

        public HtmlDocumentBuilder​(org.w3c.dom.DOMImplementation implementation)
        Instantiates the document builder with a specific DOM implementation and the infoset-altering XML violation policy.
        Parameters:
        implementation - the DOM implementation

      • HtmlDocumentBuilder

        public HtmlDocumentBuilder()
        Instantiates the document builder with the JAXP DOM implementation and the infoset-altering XML violation policy.

      • HtmlDocumentBuilder

        public HtmlDocumentBuilder​(XmlViolationPolicy xmlPolicy)
        Instantiates the document builder with the JAXP DOM implementation and a specific XML violation policy.
        Parameters:
        xmlPolicy - the policy

    • Method Detail

      • jaxpDOMImplementation

        private static org.w3c.dom.DOMImplementation jaxpDOMImplementation()
        Returns the JAXP DOM implementation.
        Returns:
        the JAXP DOM implementation

      • newTokenizer

        private Tokenizer newTokenizer​(TokenHandler handler,
                               boolean newAttributesEachTime)

      • lazyInit

        private void lazyInit()
        This class wraps different tree builders depending on configuration. This method does the work of hiding this from the user of the class.

      • tokenize

        private void tokenize​(org.xml.sax.InputSource is)
               throws org.xml.sax.SAXException,
                      java.io.IOException,
                      java.net.MalformedURLException
        Tokenizes the input source.
        Parameters:
        is - the source
        Throws:
        org.xml.sax.SAXException - if stuff goes wrong
        java.io.IOException - if IO goes wrong
        java.net.MalformedURLException - if the system ID is malformed and the entity resolver is null

      • getDOMImplementation

        public org.w3c.dom.DOMImplementation getDOMImplementation()
        Returns the DOM implementation
        Specified by:
        getDOMImplementation in class javax.xml.parsers.DocumentBuilder
        Returns:
        the DOM implementation
        See Also:
        DocumentBuilder.getDOMImplementation()

      • isNamespaceAware

        public boolean isNamespaceAware()
        Returns true.
        Specified by:
        isNamespaceAware in class javax.xml.parsers.DocumentBuilder
        Returns:
        true
        See Also:
        DocumentBuilder.isNamespaceAware()

      • isValidating

        public boolean isValidating()
        Returns false
        Specified by:
        isValidating in class javax.xml.parsers.DocumentBuilder
        Returns:
        false
        See Also:
        DocumentBuilder.isValidating()

      • newDocument

        public org.w3c.dom.Document newDocument()
        For API compatibility.
        Specified by:
        newDocument in class javax.xml.parsers.DocumentBuilder
        See Also:
        DocumentBuilder.newDocument()

      • parse

        public org.w3c.dom.Document parse​(org.xml.sax.InputSource is)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
        Parses a document from a SAX InputSource.
        Specified by:
        parse in class javax.xml.parsers.DocumentBuilder
        Parameters:
        is - the source
        Returns:
        the doc
        Throws:
        org.xml.sax.SAXException - if stuff goes wrong
        java.io.IOException - if IO goes wrong
        See Also:
        DocumentBuilder.parse(org.xml.sax.InputSource)

      • parseFragment

        public org.w3c.dom.DocumentFragment parseFragment​(org.xml.sax.InputSource is,
                                                  java.lang.String context)
                                           throws java.io.IOException,
                                                  org.xml.sax.SAXException
        Parses a document fragment from a SAX InputSource.
        Parameters:
        is - the source
        context - the context element name
        Returns:
        the doc
        Throws:
        org.xml.sax.SAXException - if stuff goes wrong
        java.io.IOException - if IO goes wrong

      • setEntityResolver

        public void setEntityResolver​(org.xml.sax.EntityResolver resolver)
        Sets the entity resolver for URI-only inputs.
        Specified by:
        setEntityResolver in class javax.xml.parsers.DocumentBuilder
        Parameters:
        resolver - the resolver
        See Also:
        DocumentBuilder.setEntityResolver(org.xml.sax.EntityResolver)

      • setErrorHandler

        public void setErrorHandler​(org.xml.sax.ErrorHandler errorHandler)
        Sets the error handler.
        Specified by:
        setErrorHandler in class javax.xml.parsers.DocumentBuilder
        Parameters:
        errorHandler - the handler
        See Also:
        DocumentBuilder.setErrorHandler(org.xml.sax.ErrorHandler)

      • setTransitionHander

        public void setTransitionHander​(TransitionHandler handler)

      • isCheckingNormalization

        public boolean isCheckingNormalization()
        Indicates whether NFC normalization of source is being checked.
        Returns:
        true if NFC normalization of source is being checked.
        See Also:
        nu.validator.htmlparser.impl.Tokenizer#isCheckingNormalization()

      • setCheckingNormalization

        public void setCheckingNormalization​(boolean enable)
        Toggles the checking of the NFC normalization of source.
        Parameters:
        enable - true to check normalization
        See Also:
        nu.validator.htmlparser.impl.Tokenizer#setCheckingNormalization(boolean)

      • isScriptingEnabled

        public boolean isScriptingEnabled()
        Whether the parser considers scripting to be enabled for noscript treatment.
        Returns:
        true if enabled
        See Also:
        TreeBuilder.isScriptingEnabled()

      • setScriptingEnabled

        public void setScriptingEnabled​(boolean scriptingEnabled)
        Sets whether the parser considers scripting to be enabled for noscript treatment.
        Parameters:
        scriptingEnabled - true to enable
        See Also:
        TreeBuilder.setScriptingEnabled(boolean)

      • getDoctypeExpectation

        public DoctypeExpectation getDoctypeExpectation()
        Returns the doctype expectation.
        Returns:
        the doctypeExpectation

      • getDocumentModeHandler

        public DocumentModeHandler getDocumentModeHandler()
        Returns the document mode handler.
        Returns:
        the documentModeHandler

      • getStreamabilityViolationPolicy

        public XmlViolationPolicy getStreamabilityViolationPolicy()
        Returns the streamabilityViolationPolicy.
        Returns:
        the streamabilityViolationPolicy

      • setStreamabilityViolationPolicy

        public void setStreamabilityViolationPolicy​(XmlViolationPolicy streamabilityViolationPolicy)
        Sets the streamabilityViolationPolicy.
        Parameters:
        streamabilityViolationPolicy - the streamabilityViolationPolicy to set

      • setHtml4ModeCompatibleWithXhtml1Schemata

        public void setHtml4ModeCompatibleWithXhtml1Schemata​(boolean html4ModeCompatibleWithXhtml1Schemata)
        Whether the HTML 4 mode reports boolean attributes in a way that repeats the name in the value.
        Parameters:
        html4ModeCompatibleWithXhtml1Schemata -

      • getDocumentLocator

        public org.xml.sax.Locator getDocumentLocator()
        Returns the Locator during parse.
        Returns:
        the Locator

      • isHtml4ModeCompatibleWithXhtml1Schemata

        public boolean isHtml4ModeCompatibleWithXhtml1Schemata()
        Whether the HTML 4 mode reports boolean attributes in a way that repeats the name in the value.
        Returns:
        the html4ModeCompatibleWithXhtml1Schemata

      • setMappingLangToXmlLang

        public void setMappingLangToXmlLang​(boolean mappingLangToXmlLang)
        Whether lang is mapped to xml:lang.
        Parameters:
        mappingLangToXmlLang -
        See Also:
        Tokenizer.setMappingLangToXmlLang(boolean)

      • isMappingLangToXmlLang

        public boolean isMappingLangToXmlLang()
        Whether lang is mapped to xml:lang.
        Returns:
        the mappingLangToXmlLang

      • getXmlnsPolicy

        public XmlViolationPolicy getXmlnsPolicy()
        Returns the xmlnsPolicy.
        Returns:
        the xmlnsPolicy

      • getCommentPolicy

        public XmlViolationPolicy getCommentPolicy()
        Returns the commentPolicy.
        Returns:
        the commentPolicy

      • getContentNonXmlCharPolicy

        public XmlViolationPolicy getContentNonXmlCharPolicy()
        Returns the contentNonXmlCharPolicy.
        Returns:
        the contentNonXmlCharPolicy

      • getContentSpacePolicy

        public XmlViolationPolicy getContentSpacePolicy()
        Returns the contentSpacePolicy.
        Returns:
        the contentSpacePolicy

      • isReportingDoctype

        public boolean isReportingDoctype()
        Returns the reportingDoctype.
        Returns:
        the reportingDoctype

      • setHeuristics

        public void setHeuristics​(Heuristics heuristics)
        Sets the encoding sniffing heuristics.
        Parameters:
        heuristics - the heuristics to set
        See Also:
        nu.validator.htmlparser.impl.Tokenizer#setHeuristics(nu.validator.htmlparser.common.Heuristics)

      • getHeuristics

        public Heuristics getHeuristics()

      • setXmlPolicy

        public void setXmlPolicy​(XmlViolationPolicy xmlPolicy)
        This is a catch-all convenience method for setting name, xmlns, content space, content non-XML char and comment policies in one go. This does not affect the streamability policy or doctype reporting.
        Parameters:
        xmlPolicy -

      • getNamePolicy

        public XmlViolationPolicy getNamePolicy()
        The policy for non-NCName element and attribute names.
        Returns:
        the namePolicy

      • setBogusXmlnsPolicy

        public void setBogusXmlnsPolicy​(XmlViolationPolicy bogusXmlnsPolicy)
        Deprecated.
        Does nothing.

      • getBogusXmlnsPolicy

        public XmlViolationPolicy getBogusXmlnsPolicy()
        Deprecated.
        Returns XmlViolationPolicy.ALTER_INFOSET.
        Returns:
        XmlViolationPolicy.ALTER_INFOSET

      • addCharacterHandler

        public void addCharacterHandler​(CharacterHandler characterHandler)

      • setIgnoringComments

        public void setIgnoringComments​(boolean ignoreComments)
        Sets whether comment nodes appear in the tree.
        Parameters:
        ignoreComments - true to ignore comments
        See Also:
        TreeBuilder.setIgnoringComments(boolean)