nu.validator.htmlparser.xom
Class HtmlBuilder

java.lang.Object
  nu.xom.Builder
      nu.validator.htmlparser.xom.HtmlBuilder

public class HtmlBuilder
extends nu.xom.Builder

This class implements an HTML5 parser that exposes data through the XOM interface.

By default, when using the constructor without arguments, the this parser treats XML 1.0-incompatible infosets as fatal errors. This corresponds to FATAL as the general XML violation policy. Handling all input without fatal errors and without violating the XOM API contract is possible by setting the general XML violation policy to ALTER_INFOSET. This makes the parser non-conforming but is probably the most useful setting for most applications.

The doctype is not represented in the tree.

The document mode is represented via the Mode interface on the Document node if the node implements that interface (depends on the used node factory).

The form pointer is stored if the node factory supports storing it.

This package has its own node factory class because the official XOM node factory may return multiple nodes instead of one confusing the assumptions of the DOM-oriented HTML5 parsing algorithm.

Version:

$Id: HtmlBuilder.java 153 2007-09-11 07:41:33Z hsivonen $

Author:

hsivonen

Field Summary

private EntityResolver	entityResolver
private SimpleNodeFactory	simpleNodeFactory
private Tokenizer	tokenizer
private XOMTreeBuilder	xomTreeBuilder

Constructor Summary

HtmlBuilder()
Constructor with default node factory and fatal XML violation policy.

HtmlBuilder(SimpleNodeFactory nodeFactory)
Constructor with given node factory and fatal XML violation policy.

HtmlBuilder(SimpleNodeFactory nodeFactory, XmlViolationPolicy xmlPolicy)
Constructor with given node factory and given XML violation policy.

HtmlBuilder(XmlViolationPolicy xmlPolicy)
Constructor with default node factory and given XML violation policy.

Method Summary

nu.xom.Document	build(File file) Parse from File.
nu.xom.Document	build(InputSource is) Parse from SAX InputSource.
nu.xom.Document	build(InputStream stream) Parse from InputStream.
nu.xom.Document	build(InputStream stream, String uri) Parse from InputStream.
nu.xom.Document	build(Reader stream) Parse from Reader.
nu.xom.Document	build(Reader stream, String uri) Parse from Reader.
nu.xom.Document	build(String uri) Parse from URI.
nu.xom.Document	build(String content, String uri) Parse from String.
nu.xom.Nodes	buildFragment(InputSource is, String context) Parse a fragment from SAX InputSource.
SimpleNodeFactory	getSimpleNodeFactory() Gets the node factory
void	setBogusXmlnsPolicy(XmlViolationPolicy bogusXmlnsPolicy) Sets the policy for forbidden xmlns attributes.
void	setCheckingNormalization(boolean enable) Toggles the checking of the NFC normalization of source.
void	setCommentPolicy(XmlViolationPolicy commentPolicy) Sets the policy for consecutive hyphens in comments.
void	setContentNonXmlCharPolicy(XmlViolationPolicy contentNonXmlCharPolicy) Sets the policy for non-XML characters except white space.
void	setContentSpacePolicy(XmlViolationPolicy contentSpacePolicy) Sets the policy for non-XML white space.
void	setDoctypeExpectation(DoctypeExpectation doctypeExpectation) Sets the doctype expectation.
void	setDocumentModeHandler(DocumentModeHandler documentModeHandler) Sets the document mode handler.
void	setEntityResolver(EntityResolver resolver) Sets the entity resolver for URI-only inputs.
void	setErrorHandler(ErrorHandler errorHandler)
void	setHtml4ModeCompatibleWithXhtml1Schemata(boolean html4ModeCompatibleWithXhtml1Schemata) Whether the HTML 4 mode reports boolean attributes in a way that repeats the name in the value.
void	setIgnoringComments(boolean ignoreComments) Sets whether comment nodes appear in the tree.
void	setMappingLangToXmlLang(boolean mappingLangToXmlLang)
void	setNamePolicy(XmlViolationPolicy namePolicy)
void	setScriptingEnabled(boolean scriptingEnabled) Sets whether the parser considers scripting to be enabled for noscript treatment.
void	setXmlPolicy(XmlViolationPolicy xmlPolicy) This is a catch-all convenience method for setting name, content space, content non-XML char and comment policies in one go.
private void	tokenize(InputSource is)

Methods inherited from class nu.xom.Builder

getNodeFactory

Methods inherited from class java.lang.Object

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

Field Detail

tokenizer

private final Tokenizer tokenizer

xomTreeBuilder

private final XOMTreeBuilder xomTreeBuilder

simpleNodeFactory

private final SimpleNodeFactory simpleNodeFactory

entityResolver

private EntityResolver entityResolver

Constructor Detail

HtmlBuilder

public HtmlBuilder()

Constructor with default node factory and fatal XML violation policy.

HtmlBuilder

public HtmlBuilder(SimpleNodeFactory nodeFactory)

Constructor with given node factory and fatal XML violation policy.

Parameters:

nodeFactory - the factory

HtmlBuilder

public HtmlBuilder(XmlViolationPolicy xmlPolicy)

Constructor with default node factory and given XML violation policy.

Parameters:

xmlPolicy - the policy

HtmlBuilder

public HtmlBuilder(SimpleNodeFactory nodeFactory,
                   XmlViolationPolicy xmlPolicy)

Constructor with given node factory and given XML violation policy.

Parameters:

nodeFactory - the factory

xmlPolicy - the policy

Method Detail

tokenize

private void tokenize(InputSource is)
               throws nu.xom.ParsingException,
                      IOException,
                      MalformedURLException

Throws:

nu.xom.ParsingException

IOException

MalformedURLException

build

public nu.xom.Document build(InputSource is)
                      throws nu.xom.ParsingException,
                             IOException

Parse from SAX InputSource.

Parameters:

is - the InputSource

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

buildFragment

public nu.xom.Nodes buildFragment(InputSource is,
                                  String context)
                           throws IOException,
                                  nu.xom.ParsingException

Parse a fragment from SAX InputSource.

Parameters:

is - the InputSource

context - the name of the context element

Returns:

the fragment

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

build

public nu.xom.Document build(File file)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from File.

Overrides:

build in class nu.xom.Builder

Parameters:

file - the file

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.io.File)

build

public nu.xom.Document build(InputStream stream,
                             String uri)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from InputStream.

Overrides:

build in class nu.xom.Builder

Parameters:

stream - the stream

uri - the base URI

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.io.InputStream, java.lang.String)

build

public nu.xom.Document build(InputStream stream)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from InputStream.

Overrides:

build in class nu.xom.Builder

Parameters:

stream - the stream

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.io.InputStream)

build

public nu.xom.Document build(Reader stream,
                             String uri)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from Reader.

Overrides:

build in class nu.xom.Builder

Parameters:

stream - the reader

uri - the base URI

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.io.Reader, java.lang.String)

build

public nu.xom.Document build(Reader stream)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from Reader.

Overrides:

build in class nu.xom.Builder

Parameters:

stream - the reader

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.io.Reader)

build

public nu.xom.Document build(String content,
                             String uri)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from String.

Overrides:

build in class nu.xom.Builder

Parameters:

content - the HTML source as string

uri - the base URI

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.lang.String, java.lang.String)

build

public nu.xom.Document build(String uri)
                      throws nu.xom.ParsingException,
                             nu.xom.ValidityException,
                             IOException

Parse from URI.

Overrides:

build in class nu.xom.Builder

Parameters:

uri - the URI of the document

Returns:

the document

Throws:

nu.xom.ParsingException - in case of an XML violation

IOException - if IO goes wrang

nu.xom.ValidityException

See Also:

Builder.build(java.lang.String)

getSimpleNodeFactory

public SimpleNodeFactory getSimpleNodeFactory()

Gets the node factory

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Sets the entity resolver for URI-only inputs.

Parameters:

resolver - the resolver

See Also:

DocumentBuilder.setEntityResolver(org.xml.sax.EntityResolver)

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

See Also:

DocumentBuilder.setErrorHandler(org.xml.sax.ErrorHandler)

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)

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)

setCheckingNormalization

public void setCheckingNormalization(boolean enable)

Toggles the checking of the NFC normalization of source.

Parameters:

enable - true to check normalization

See Also:

Tokenizer.setCheckingNormalization(boolean)

setCommentPolicy

public void setCommentPolicy(XmlViolationPolicy commentPolicy)

Sets the policy for consecutive hyphens in comments.

Parameters:

commentPolicy - the policy

See Also:

Tokenizer.setCommentPolicy(nu.validator.htmlparser.common.XmlViolationPolicy)

setContentNonXmlCharPolicy

public void setContentNonXmlCharPolicy(XmlViolationPolicy contentNonXmlCharPolicy)

Sets the policy for non-XML characters except white space.

Parameters:

contentNonXmlCharPolicy - the policy

See Also:

Tokenizer.setContentNonXmlCharPolicy(nu.validator.htmlparser.common.XmlViolationPolicy)

setContentSpacePolicy

public void setContentSpacePolicy(XmlViolationPolicy contentSpacePolicy)

Sets the policy for non-XML white space.

Parameters:

contentSpacePolicy - the policy

See Also:

Tokenizer.setContentSpacePolicy(nu.validator.htmlparser.common.XmlViolationPolicy)

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 -

setMappingLangToXmlLang

public void setMappingLangToXmlLang(boolean mappingLangToXmlLang)

Parameters:

mappingLangToXmlLang -

See Also:

Tokenizer.setMappingLangToXmlLang(boolean)

setNamePolicy

public void setNamePolicy(XmlViolationPolicy namePolicy)

Parameters:

namePolicy -

See Also:

Tokenizer.setNamePolicy(nu.validator.htmlparser.common.XmlViolationPolicy)

setXmlPolicy

public void setXmlPolicy(XmlViolationPolicy xmlPolicy)

This is a catch-all convenience method for setting name, content space, content non-XML char and comment policies in one go.

Parameters:

xmlPolicy -

setDoctypeExpectation

public void setDoctypeExpectation(DoctypeExpectation doctypeExpectation)

Sets the doctype expectation.

Parameters:

doctypeExpectation - the doctypeExpectation to set

See Also:

TreeBuilder.setDoctypeExpectation(nu.validator.htmlparser.common.DoctypeExpectation)

setDocumentModeHandler

public void setDocumentModeHandler(DocumentModeHandler documentModeHandler)

Sets the document mode handler.

Parameters:

documentModeHandler -

See Also:

TreeBuilder.setDocumentModeHandler(nu.validator.htmlparser.common.DocumentModeHandler)

setBogusXmlnsPolicy

public void setBogusXmlnsPolicy(XmlViolationPolicy bogusXmlnsPolicy)

Sets the policy for forbidden xmlns attributes.

Parameters:

bogusXmlnsPolicy - the policy

See Also:

Tokenizer.setBogusXmlnsPolicy(nu.validator.htmlparser.common.XmlViolationPolicy)