de.innovationgate.wga.server.api

Class Html

java.lang.Object

de.innovationgate.wga.server.api.Html

public class Html
extends Object

Collects functionalties to load and parse HTML documents. The HTML parser NekoHTML is used for parsing HTML documents as a DOM tree. It is tolerant against most "common errors" done on HTML documents and may parse a wide range of HTML structures. Note: NekoHTML converts all HTML tags name to uppercase even if they were specified as lowercase in the source code. This is important when querying the DOM via XPath.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Document	load(org.apache.commons.httpclient.HttpClient client, String url) Loads a HTML page from a URL and parses it as DOM document
org.dom4j.Document	load(String url) Loads a HTML page from a URL and parses it as DOM document The HTML parser NekoHTML is responsible for parsing the HTML document as a DOM tree.
org.dom4j.Document	parse(String html) Parses HTML text and returns it as DOM document object.
org.dom4j.Document	parseFragment(String html) Parses HTML text and returns it as DOM document object.

Methods inherited from class java.lang.Object

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

Method Detail

load

public org.dom4j.Document load(String url)
                        throws UnsupportedEncodingException,
                               de.innovationgate.webgate.api.WGException,
                               IOException,
                               org.apache.commons.httpclient.HttpException,
                               SAXException

Loads a HTML page from a URL and parses it as DOM document The HTML parser NekoHTML is responsible for parsing the HTML document as a DOM tree. It is tolerant against most "common errors" done on HTML documents and may parse a wide range of HTML structures.

Parameters:

url - The URL to load the HTML document from

Returns:

A DOM document

Throws:

UnsupportedEncodingException

de.innovationgate.webgate.api.WGAPIException

IOException

org.apache.commons.httpclient.HttpException

SAXException

de.innovationgate.webgate.api.WGException

load

public org.dom4j.Document load(org.apache.commons.httpclient.HttpClient client,
                               String url)
                        throws UnsupportedEncodingException,
                               de.innovationgate.webgate.api.WGException,
                               IOException,
                               org.apache.commons.httpclient.HttpException,
                               SAXException

Loads a HTML page from a URL and parses it as DOM document

Parameters:

client - HTTP client object to load the resource on the URL, used to specify various settings regarding this operation. If no client object is passed a default one is used.

url - The URL to load the HTML document from

Returns:

A DOM document

Throws:

UnsupportedEncodingException

de.innovationgate.webgate.api.WGAPIException

IOException

org.apache.commons.httpclient.HttpException

SAXException

de.innovationgate.webgate.api.WGException

parse

public org.dom4j.Document parse(String html)
                         throws de.innovationgate.webgate.api.WGException,
                                SAXException,
                                IOException

Parses HTML text and returns it as DOM document object. The returned document represents a whole HTML document. Omitted elements are automatically added. The HTML parser NekoHTML is responsible for parsing the HTML document as a DOM tree. It is tolerant against most "common errors" done on HTML documents and may parse a wide range of HTML structures. Note: NekoHTML converts all HTML tags name to uppercase even if they were specified as lowercase in the source code. This is important when querying the DOM via XPath.

Parameters:

html -

Returns:

The DOM document of the parsed HTML

Throws:

SAXException

IOException

de.innovationgate.webgate.api.WGException

parseFragment

public org.dom4j.Document parseFragment(String html)
                                 throws de.innovationgate.webgate.api.WGException,
                                        SAXException,
                                        IOException

Parses HTML text and returns it as DOM document object. The returned document represents only the parsed fragment. The HTML parser NekoHTML is responsible for parsing the HTML document as a DOM tree. It is tolerant against most "common errors" done on HTML documents and may parse a wide range of HTML structures. Note: NekoHTML converts all HTML tags name to uppercase even if they were specified as lowercase in the source code. This is important when querying the DOM via XPath.

Parameters:

html -

Returns:

The DOM document of the parsed HTML

Throws:

SAXException

IOException

de.innovationgate.webgate.api.WGException