student.web

Class WebBot.Page

java.lang.Object

student.web.WebBot.Page

Enclosing class:

WebBot

protected class WebBot.Page
extends Object

Represents a web page that can be visited by this bot. This class is not static, since it uses the output channel of the bot.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	success Was this page read and initialized successfully?
URI	uri This page's URL as a URI.
URL	url This page's URL.

Constructor Summary

Constructors

Constructor and Description
Page(File file) Create a new page by reading it from a local file.
Page(String htmlContent) Create a new page by reading it from a given HTML string.
Page(URL url) Create a new page by reading it from the web.

Method Summary

Modifier and Type	Method and Description
void	dump(PrintStream outstream) Dump this page for diagnostic purposes.
String	getContent() Get this document's entire content as a string.
Node	getDoc() Get this document's entire content as a DOM tree.
List<HtmlHeadingElement>	getHeadings(int level) Get an iterator over the headings in this document.
List<URI>	getLinks(int kind) Get an iterator over the links in this document.
int	getPatternCount() Get the number of times the WebBot.targetPhrase occurs in this page.
double	getPatternFrequency() Get the frequency of the WebBot.targetPhrase, which approximates the size of all the occurrences of the target phrase in the document divided by the document's total size.
String	getTitle() Get this document's title a string.
List<HtmlElement>	xPathFindAll(String xpathQuery)
HtmlElement	xPathFindFirst(String xpathQuery)

Methods inherited from class java.lang.Object

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

Field Detail

url

public URL url

This page's URL.

uri

public URI uri

This page's URL as a URI.

success

public boolean success

Was this page read and initialized successfully?

Constructor Detail

Page

public Page(URL url)

Create a new page by reading it from the web.

Parameters:

url - the page's URL

Page

public Page(File file)

Create a new page by reading it from a local file.

Parameters:

file - The file to read from

Page

public Page(String htmlContent)

Create a new page by reading it from a given HTML string.

Parameters:

htmlContent - The content to use for this page

Method Detail

getHeadings

public List<HtmlHeadingElement> getHeadings(int level)

Get an iterator over the headings in this document.

Parameters:

level - The level of headings to get, where 0 is all headings, and 1-6 are only the headings <= the given number

Returns:

an iterator over the requested set of headings

getLinks

public List<URI> getLinks(int kind)

Get an iterator over the links in this document.

Parameters:

kind - One of the constants ALL_LINKS, OTHER_PAGE_LINKS, or OTHER_SITE_LINKS, indicating which links to include in the iterator.

Returns:

an iterator over the requested set of links

getTitle

public String getTitle()

Get this document's title a string.

Returns:

The document title

getContent

public String getContent()

Get this document's entire content as a string.

Returns:

The document content

getDoc

public Node getDoc()

Get this document's entire content as a DOM tree.

Returns:

a DOM node

xPathFindFirst

public HtmlElement xPathFindFirst(String xpathQuery)

Parameters:

xpathQuery - An XPATH query to run against the DOM Tree

Returns:

The first HTML element in the document that matches the query.

xPathFindAll

public List<HtmlElement> xPathFindAll(String xpathQuery)

Parameters:

xpathQuery - An XPATH query to run against the DOM Tree

Returns:

A list of HTML elements that result from running the query against the document.

getPatternCount

public int getPatternCount()

Get the number of times the WebBot.targetPhrase occurs in this page.

Returns:

The number of times the WebBot.targetPhrase occurred

getPatternFrequency

public double getPatternFrequency()

Get the frequency of the WebBot.targetPhrase, which approximates the size of all the occurrences of the target phrase in the document divided by the document's total size.

Returns:

The WebBot.targetPhrase frequency

dump

public void dump(PrintStream outstream)

Dump this page for diagnostic purposes.

Parameters:

outstream - The output channel to dump on