org.htmlparser

类 Parser

java.lang.Object

org.htmlparser.Parser

所有已实现的接口:

java.io.Serializable, ConnectionMonitor

public class Parser
extends java.lang.Object
implements java.io.Serializable, ConnectionMonitor

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static ParserFeedback	DEVNULL A quiet message sink.
static ParserFeedback	STDOUT A verbose message sink.
static java.lang.String	VERSION_DATE The date of the version ("Jun 10, 2006").
static double	VERSION_NUMBER The floating point version number (1.6).
static java.lang.String	VERSION_STRING The display version ("1.6 (Release Build Jun 10, 2006)").
static java.lang.String	VERSION_TYPE The type of version ("Release Build").

构造器概要

构造器

构造器和说明
Parser() Zero argument constructor.
Parser(Lexer lexer) Construct a parser using the provided lexer.
Parser(Lexer lexer, ParserFeedback fb) Construct a parser using the provided lexer and feedback object.
Parser(java.lang.String resource) Creates a Parser object with the location of the resource (URL or file).
Parser(java.lang.String resource, ParserFeedback feedback) Creates a Parser object with the location of the resource (URL or file) You would typically create a DefaultHTMLParserFeedback object and pass it in.
Parser(java.net.URLConnection connection) Construct a parser using the provided URLConnection.
Parser(java.net.URLConnection connection, ParserFeedback fb) Constructor for custom HTTP access.

方法概要

限定符和类型	方法和说明
static Parser	createParser(java.lang.String html, java.lang.String charset) Creates the parser on an input string.
NodeIterator	elements()
NodeList	extractAllNodesThatMatch(NodeFilter filter) Extract all nodes matching the given filter.
java.net.URLConnection	getConnection() Return the current connection.
static ConnectionManager	getConnectionManager() Get the connection manager all Parsers use.
java.lang.String	getEncoding() Get the encoding for the page this parser is reading from.
ParserFeedback	getFeedback() Returns the current feedback object.
Lexer	getLexer() Returns the lexer associated with the parser.
NodeFactory	getNodeFactory() Get the current node factory.
java.lang.String	getURL() Return the current URL being parsed.
static java.lang.String	getVersion() Return the version string of this parser.
static double	getVersionNumber() Return the version number of this parser.
static void	main(java.lang.String[] args) The main program, which can be executed from the command line.
NodeList	parse(NodeFilter filter)
void	postConnect(java.net.HttpURLConnection connection) Called just after calling connect.
void	preConnect(java.net.HttpURLConnection connection) Called just prior to calling connect.
void	reset() Reset the parser to start from the beginning again.
void	setConnection(java.net.URLConnection connection) Set the connection for this parser.
static void	setConnectionManager(ConnectionManager manager) Set the connection manager all Parsers use.
void	setEncoding(java.lang.String encoding) Set the encoding for the page this parser is reading from.
void	setFeedback(ParserFeedback fb) Sets the feedback object used in scanning.
void	setInputHTML(java.lang.String inputHTML) Initializes the parser with the given input HTML String.
void	setLexer(Lexer lexer) Set the lexer for this parser.
void	setNodeFactory(NodeFactory factory) Set the current node factory.
void	setResource(java.lang.String resource) Set the html, a url, or a file.
void	setURL(java.lang.String url) Set the URL for this parser.
void	visitAllNodesWith(NodeVisitor visitor) Apply the given visitor to the current page.

从类继承的方法 java.lang.Object

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

字段详细资料

VERSION_NUMBER

public static final double VERSION_NUMBER

The floating point version number (1.6).

另请参阅:

常量字段值

VERSION_TYPE

public static final java.lang.String VERSION_TYPE

The type of version ("Release Build").

另请参阅:

常量字段值

VERSION_DATE

public static final java.lang.String VERSION_DATE

The date of the version ("Jun 10, 2006").

另请参阅:

常量字段值

VERSION_STRING

public static final java.lang.String VERSION_STRING

The display version ("1.6 (Release Build Jun 10, 2006)").

另请参阅:

常量字段值

DEVNULL

public static final ParserFeedback DEVNULL

A quiet message sink. Use this for no feedback.

STDOUT

public static final ParserFeedback STDOUT

A verbose message sink. Use this for output on System.out.

构造器详细资料

Parser

public Parser()

Zero argument constructor. The parser is in a safe but useless state parsing an empty string. Set the lexer or connection using setLexer(org.htmlparser.lexer.Lexer) or setConnection(java.net.URLConnection).

另请参阅:

setLexer(Lexer), setConnection(URLConnection)

Parser

public Parser(Lexer lexer,
              ParserFeedback fb)

Construct a parser using the provided lexer and feedback object. This would be used to create a parser for special cases where the normal creation of a lexer on a URLConnection needs to be customized.

参数:

lexer - The lexer to draw characters from.

fb - The object to use when information, warning and error messages are produced. If null no feedback is provided.

Parser

public Parser(java.net.URLConnection connection,
              ParserFeedback fb)
       throws ParserException

Constructor for custom HTTP access. This would be used to create a parser for a URLConnection that needs a special setup or negotiation conditioning beyond what is available from the ConnectionManager.

参数:

connection - A fully conditioned connection. The connect() method will be called so it need not be connected yet.

fb - The object to use for message communication.

抛出:

ParserException - If the creation of the underlying Lexer cannot be performed.

Parser

public Parser(java.lang.String resource,
              ParserFeedback feedback)
       throws ParserException

Creates a Parser object with the location of the resource (URL or file) You would typically create a DefaultHTMLParserFeedback object and pass it in.

参数:

resource - Either a URL, a filename or a string of HTML. The string is considered HTML if the first non-whitespace character is a <. The use of a url or file is autodetected by first attempting to open the resource as a URL, if that fails it is assumed to be a file name. A standard HTTP GET is performed to read the content of the URL.

feedback - The HTMLParserFeedback object to use when information, warning and error messages are produced. If null no feedback is provided.

抛出:

ParserException - If the URL is invalid.

另请参阅:

Parser(URLConnection,ParserFeedback)

Parser

public Parser(java.lang.String resource)
       throws ParserException

Creates a Parser object with the location of the resource (URL or file). A DefaultHTMLParserFeedback object is used for feedback.

参数:

resource - Either HTML, a URL or a filename (autodetects).

抛出:

ParserException - If the resourceLocn argument does not resolve to a valid page or file.

另请参阅:

Parser(String,ParserFeedback)

Parser

public Parser(Lexer lexer)

Construct a parser using the provided lexer. A feedback object printing to System.out is used. This would be used to create a parser for special cases where the normal creation of a lexer on a URLConnection needs to be customized.

参数:

lexer - The lexer to draw characters from.

Parser

public Parser(java.net.URLConnection connection)
       throws ParserException

Construct a parser using the provided URLConnection. This would be used to create a parser for a URLConnection that needs a special setup or negotiation conditioning beyond what is available from the ConnectionManager. A feedback object printing to System.out is used.

参数:

connection - A fully conditioned connection. The connect() method will be called so it need not be connected yet.

抛出:

ParserException - If the creation of the underlying Lexer cannot be performed.

另请参阅:

Parser(URLConnection,ParserFeedback)

方法详细资料

getVersion

public static java.lang.String getVersion()

Return the version string of this parser.

返回:

A string of the form:

 "[floating point number] ([build-type] [build-date])"
 

getVersionNumber

public static double getVersionNumber()

Return the version number of this parser.

返回:

A floating point number, the whole number part is the major version, and the fractional part is the minor version.

getConnectionManager

public static ConnectionManager getConnectionManager()

Get the connection manager all Parsers use.

返回:

The connection manager.

另请参阅:

setConnectionManager(org.htmlparser.http.ConnectionManager)

setConnectionManager

public static void setConnectionManager(ConnectionManager manager)

Set the connection manager all Parsers use.

参数:

manager - The new connection manager.

另请参阅:

getConnectionManager()

createParser

public static Parser createParser(java.lang.String html,
                                  java.lang.String charset)

Creates the parser on an input string.

参数:

html - The string containing HTML.

charset - Optional. The character set encoding that will be reported by getEncoding(). If charset is null the default character set is used.

返回:

A parser with the html string as input.

抛出:

java.lang.IllegalArgumentException - if html is null.

setResource

public void setResource(java.lang.String resource)
                 throws ParserException

Set the html, a url, or a file.

参数:

resource - The resource to use.

抛出:

java.lang.IllegalArgumentException - if resource is null.

ParserException - if a problem occurs in connecting.

setConnection

public void setConnection(java.net.URLConnection connection)
                   throws ParserException

Set the connection for this parser. This method creates a new Lexer reading from the connection.

参数:

connection - A fully conditioned connection. The connect() method will be called so it need not be connected yet.

抛出:

ParserException - if the character set specified in the HTTP header is not supported, or an i/o exception occurs creating the lexer.

java.lang.IllegalArgumentException - if connection is null.

ParserException - if a problem occurs in connecting.

另请参阅:

setLexer(org.htmlparser.lexer.Lexer), getConnection()

getConnection

public java.net.URLConnection getConnection()

Return the current connection.

返回:

The connection either created by the parser or passed into this parser via setConnection(java.net.URLConnection).

另请参阅:

setConnection(URLConnection)

setURL

public void setURL(java.lang.String url)
            throws ParserException

Set the URL for this parser. This method creates a new Lexer reading from the given URL. Trying to set the url to null or an empty string is a no-op.

参数:

url - The new URL for the parser.

抛出:

ParserException - If the url is invalid or creation of the underlying Lexer cannot be performed.

ParserException - if a problem occurs in connecting.

另请参阅:

getURL()

getURL

public java.lang.String getURL()

Return the current URL being parsed.

返回:

The current url. This is the URL for the current page. A string passed into the constructor or set via setURL may be altered, for example, a file name may be modified to be a URL.

另请参阅:

Page.getUrl(), setURL(java.lang.String)

setEncoding

public void setEncoding(java.lang.String encoding)
                 throws ParserException

Set the encoding for the page this parser is reading from.

参数:

encoding - The new character set to use.

抛出:

ParserException - If the encoding change causes characters that have already been consumed to differ from the characters that would have been seen had the new encoding been in force.

另请参阅:

EncodingChangeException, getEncoding()

getEncoding

public java.lang.String getEncoding()

Get the encoding for the page this parser is reading from. This item is set from the HTTP header but may be overridden by meta tags in the head, so this may change after the head has been parsed.

返回:

The encoding currently in force.

另请参阅:

setEncoding(java.lang.String)

setLexer

public void setLexer(Lexer lexer)

Set the lexer for this parser. The current NodeFactory is transferred to (set on) the given lexer, since the lexer owns the node factory object. It does not adjust the feedback object.

参数:

lexer - The lexer object to use.

抛出:

java.lang.IllegalArgumentException - if lexer is null.

另请参阅:

setNodeFactory(org.htmlparser.NodeFactory), getLexer()

getLexer

public Lexer getLexer()

Returns the lexer associated with the parser.

返回:

The current lexer.

另请参阅:

setLexer(org.htmlparser.lexer.Lexer)

getNodeFactory

public NodeFactory getNodeFactory()

Get the current node factory.

返回:

The current lexer's node factory.

另请参阅:

setNodeFactory(org.htmlparser.NodeFactory)

setNodeFactory

public void setNodeFactory(NodeFactory factory)

Set the current node factory.

参数:

factory - The new node factory for the current lexer.

抛出:

java.lang.IllegalArgumentException - if factory is null.

另请参阅:

getNodeFactory()

setFeedback

public void setFeedback(ParserFeedback fb)

Sets the feedback object used in scanning.

参数:

fb - The new feedback object to use. If this is null a silent feedback object is used.

另请参阅:

getFeedback()

getFeedback

public ParserFeedback getFeedback()

Returns the current feedback object.

返回:

The feedback object currently being used.

另请参阅:

setFeedback(org.htmlparser.util.ParserFeedback)

reset

public void reset()

Reset the parser to start from the beginning again. This assumes support for a reset from the underlying Source object.

This is cheaper (in terms of time) than resetting the URL, i.e.

 parser.setURL (parser.getURL ());
 

because the page is not refetched from the internet. Note: the nodes returned on the second parse are new nodes and not the same nodes returned on the first parse. If you want the same nodes for re-use, collect them in a NodeList with parse(null) and operate on the NodeList.

elements

public NodeIterator elements()
                      throws ParserException

抛出:

ParserException

parse

public NodeList parse(NodeFilter filter)
               throws ParserException

抛出:

ParserException

visitAllNodesWith

public void visitAllNodesWith(NodeVisitor visitor)
                       throws ParserException

Apply the given visitor to the current page. The visitor is passed to the accept() method of each node in the page in a depth first traversal. The visitor beginParsing() method is called prior to processing the page and finishedParsing() is called after the processing.

参数:

visitor - The visitor to visit all nodes with.

抛出:

ParserException - If a parse error occurs while traversing the page with the visitor.

setInputHTML

public void setInputHTML(java.lang.String inputHTML)
                  throws ParserException

Initializes the parser with the given input HTML String.

参数:

inputHTML - the input HTML that is to be parsed.

抛出:

ParserException - If a error occurs in setting up the underlying Lexer.

java.lang.IllegalArgumentException - if inputHTML is null.

extractAllNodesThatMatch

public NodeList extractAllNodesThatMatch(NodeFilter filter)
                                  throws ParserException

Extract all nodes matching the given filter.

参数:

filter - The filter to be applied to the nodes.

返回:

A list of nodes matching the filter criteria, i.e. for which the filter's accept method returned true.

抛出:

ParserException - If a parse error occurs.

另请参阅:

Node.collectInto(NodeList, NodeFilter)

preConnect

public void preConnect(java.net.HttpURLConnection connection)
                throws ParserException

Called just prior to calling connect. Part of the ConnectionMonitor interface, this implementation just sends the request header to the feedback object if any.

指定者:

preConnect 在接口中 ConnectionMonitor

参数:

connection - The connection which is about to be connected.

抛出:

ParserException - Not used

另请参阅:

ConnectionMonitor.preConnect(java.net.HttpURLConnection)

postConnect

public void postConnect(java.net.HttpURLConnection connection)
                 throws ParserException

Called just after calling connect. Part of the ConnectionMonitor interface, this implementation just sends the response header to the feedback object if any.

指定者:

postConnect 在接口中 ConnectionMonitor

参数:

connection - The connection that was just connected.

抛出:

ParserException - Not used.

另请参阅:

ConnectionMonitor.postConnect(java.net.HttpURLConnection)

main

public static void main(java.lang.String[] args)

The main program, which can be executed from the command line.

参数:

args - A URL or file name to parse, and an optional tag name to be used as a filter.