WebBot (Student Library Documentation)

java.lang.Object
- student.web.WebBot

Direct Known Subclasses:

TurboWebBot
```
public class WebBot
extends Object
```
This class represents a robot that knows how to walk through a web page and identify headings and links. It will automatically transform "messy" real-world html into conforming XHTML as it visits pages, so all tag matching and other support should presume XHTML conventions.

Version:

$Revision: 1.5 $, $Date: 2010/02/23 17:06:36 $

Author:

Stephen Edwards, Last changed by $Author: stedwar2 $

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`WebBot.Page` Represents a web page that can be visited by this bot.
`protected static class`	`WebBot.PageLocation` Represents a bot location on a specific web page.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ALL_LINKS` Internal constant used to specify the set of links to get from a page.
`protected static String`	`HTML_NODE_PREFIX` Internal constant used as search + namespace prefix for xpath nodes.
`protected static int`	`OTHER_PAGE_LINKS` Internal constant used to specify the set of links to get from a page.
`protected static int`	`OTHER_SITE_LINKS` Internal constant used to specify the set of links to get from a page.
`protected PrintWriterWithHistory`	`out` The current output channel.
`protected Stack<WebBot.PageLocation>`	`pages` The stack of pages in the current history trail, where the top of the stack is the current page.
`protected Pattern`	`targetPhrase` The target phrase to search for.
`protected PrintWriter`	`trueChannel` The current output channel.

Constructor Summary

Constructors
Constructor and Description

WebBot()
Creates a new WebBot that is not yet viewing any web page.

WebBot(String url)
Creates a new WebBot for a given URL.

Constructors
Constructor and Description
`WebBot()` Creates a new WebBot that is not yet viewing any web page.
`WebBot(String url)` Creates a new WebBot for a given URL.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addXpathNamespace(String name, String url)` Bind a symbolic name to an XML namespace URL so that the symbolic name can be used as a namespace prefix on identifiers in XPATH expressions.
`void`	`advanceToNextHeading()` Advance the robot forward in the current document until it is looking at (or standing on) the next HTML heading element it can find.
`void`	`advanceToNextLink()` Advance the robot forward in the current document until it is looking at (or standing on) the next HTML anchor containing an href attribute that it can find.
`protected WebBot.Page`	`cachedPageFor(URL url)` Retrieve the cached page for the given URL.
`void`	`echoCurrentElementText()` Echo the text of the current HTML element (heading, link, etc.) to the robot's default output channel.
`void`	`echoPageTitle()` Echo the current web page title to the robot's default output channel.
`HtmlElement`	`getCurrentElement()` Get the HTML element of interest that the robot is currently standing on.
`String`	`getCurrentElementText()` Get the text of the current HTML element on this web page--i.e., the title of a heading or the text associated with a link.
`int`	`getHeadingLevel()` Get the heading level (1-6) of the current heading on this web page.
`List<HtmlHeadingElement>`	`getHeadings()` Get an iterator over all headings in the current document.
`List<HtmlHeadingElement>`	`getHeadingsToLevel(int level)` Get an iterator over all headings in the current document with a level less than or equal to the value specified.
`List<URI>`	`getLinks()` Get an iterator over all links in the current document.
`List<URI>`	`getLinksOffServer()` Get an iterator over all links in the current document that refer to pages on other servers.
`List<URI>`	`getLinksToOtherPages()` Get an iterator over all links in the current document that refer to other web pages.
`URI`	`getLinkURI()` Get the URI of the current link on this web page.
`PrintWriterWithHistory`	`getOutputChannel()` Get the output channel where this bot is sending its output.
`protected String`	`getPageContent()` Get the current web page's entire content as a string.
`String`	`getPageTitle()` Get the title the current web page.
`URL`	`getPageURL()` Get the URL for the current web page.
`boolean`	`hasPreviousPage()` Check to see if this bot previously visited a different page that it can now return to.
`boolean`	`hasVisitedPage(URI uri)` Check whether this robot has visited this page before.
`boolean`	`hasVisitedPage(URL url)` Check whether this robot has visited this page before.
`protected boolean`	`isHeading(HtmlElement element)` Determine whether a given HTML element is a heading tag.
`protected boolean`	`isLink(HtmlElement element)` Determine whether a given HTML element is an anchor tag with an HREF attribute.
`boolean`	`isLookingAtEndOfPage()` Has the robot advanced through all the contents (headings and links) on the current page? Will also return true if `isViewingWebPage()` returns false.
`boolean`	`isLookingAtHeading()` Is the robot looking at (or standing on) an HTML heading element on the current page?
`boolean`	`isLookingAtLink()` Is the robot looking at (or standing on) an HTML anchor containing an href attribute (that is, a link to another web page) on the current page?
`boolean`	`isViewingWebPage()` Is the robot currently viewing a real web page with readable contents? Normally, this would be true, but may be false if the bot has not been given a web page to start on, or if it has been given a malformed or nonexistent URL address, or even if the server for the targeted page is not available.
`void`	`jumpToLinkedPage()` Causes the bot to temporarily leave the current page and hop over to the page at the end of the current link.
`protected void`	`jumpToNormalizedURI(URI uri)` The worker method for the various flavors of `jumpToPage(URI)`.
`protected void`	`jumpToNormalizedURL(File file)` The worker method for the various flavors of `jumpToPage(URL)`.
`protected void`	`jumpToNormalizedURL(URL url)` The worker method for the various flavors of `jumpToPage(URL)`.
`void`	`jumpToPage(String url)` Causes the bot to temporarily leave the current page and hop over to the page specified by the URL (as a string).
`void`	`jumpToPage(URI uri)` Causes the bot to temporarily leave the current page and hop over to the page specified by the URL.
`void`	`jumpToPage(URL url)` Causes the bot to temporarily leave the current page and hop over to the page specified by the URL.
`protected void`	`jumpToPage(WebBot.Page page)` Adds this page to the history stack, enforcing required stack size limit.
`void`	`jumpToThisHTML(String html)` Causes the bot to temporarily leave the current page and hop over to a specific HTML string provided as a parameter.
`protected int`	`levelOf(HtmlElement element)` Convert an HTML element representing a heading tag into its corresponding level number.
`boolean`	`linkGoesToAnotherPage()` Check whether the URL of the current link on this web page refers to a different page, or just another location within the current page.
`boolean`	`linkGoesToAnotherServer()` Check whether the URL of the current link on this web page refers to a page on a separate server, or simply another location on the same server.
`protected File`	`makeFileAbsolute(File file)` This is needed to get around issues with relative file names when the current working directory is unknown or when running on a server.
`protected URL`	`normalizeURL(URL url)` Normalize a URL.
`int`	`numberOfPreviousPages()` How deep is the stack of previous pages that this robot can return to? Each time the robot jumps to a new page, it remembers its previous page so you can `returnToPreviousPage()`.
`PrintWriterWithHistory`	`out()` Get the output channel where this bot is sending its output.
`boolean`	`outputIsHtml()` Check whether this robot's output should be treated as plain text, or as HTML markup.
`protected void`	`releaseCachedResources()` Performs cleanup once this bot has completed all its tasks.
`URI`	`resolveURIFromPage(String uri)` Get a fully-resolved URI from a (possibly relative) string URI, such as the value of an anchor's href or an img's src attribute.
`void`	`returnToPreviousPage()` Causes the bot to leave the current page and return to the page it was previously visiting, at the location where it left off.
`void`	`returnToStartOfPage()` Moves the robot back to the start of the current page.
`void`	`run()` Execute this robot's built-in sequence of steps.
`void`	`setOutputChannel(PrintWriter output)` Tell this bot where to send its output.
`void`	`setOutputIsHtml(boolean value)` Set whether this robot's output should be treated as plain text, or as HTML markup.
`String`	`toString()` Get a printable summary of this robot.
`protected URL`	`urlForString(String url)` Convert a string to a URL.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - pages
```
protected Stack<WebBot.PageLocation> pages
```
    The stack of pages in the current history trail, where the top of the stack is the current page.
  - trueChannel
```
protected PrintWriter trueChannel
```
    The current output channel.
  - out
```
protected PrintWriterWithHistory out
```
    The current output channel.
  - targetPhrase
```
protected Pattern targetPhrase
```
    The target phrase to search for.
  - ALL_LINKS
```
protected static final int ALL_LINKS
```
    Internal constant used to specify the set of links to get from a page.
    
    See Also:
    
    Constant Field Values
  - OTHER_PAGE_LINKS
```
protected static final int OTHER_PAGE_LINKS
```
    Internal constant used to specify the set of links to get from a page.
    
    See Also:
    
    Constant Field Values
  - OTHER_SITE_LINKS
```
protected static final int OTHER_SITE_LINKS
```
    Internal constant used to specify the set of links to get from a page.
    
    See Also:
    
    Constant Field Values
  - HTML_NODE_PREFIX
```
protected static final String HTML_NODE_PREFIX
```
    Internal constant used as search + namespace prefix for xpath nodes. Its value is "//html:".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WebBot
```
public WebBot()
```
    Creates a new WebBot that is not yet viewing any web page.
  - WebBot
```
public WebBot(String url)
```
    Creates a new WebBot for a given URL.
    
    Parameters:
    
    url - The web page where the robot will start.
- Method Detail
  - isViewingWebPage
```
public boolean isViewingWebPage()
```
    Is the robot currently viewing a real web page with readable contents? Normally, this would be true, but may be false if the bot has not been given a web page to start on, or if it has been given a malformed or nonexistent URL address, or even if the server for the targeted page is not available.
    
    Returns:
    
    True if the robot is currently viewing a real web page with readable contents
  - isLookingAtEndOfPage
```
public boolean isLookingAtEndOfPage()
```
    Has the robot advanced through all the contents (headings and links) on the current page? Will also return true if isViewingWebPage() returns false.
    
    Returns:
    
    True if the robot has advanced over all the headings and links in the current document, or false if there are more headings and/or links to visit.
  - returnToStartOfPage
```
public void returnToStartOfPage()
```
    Moves the robot back to the start of the current page. Requires the bot to be viewing a web page.
  - getPageTitle
```
public String getPageTitle()
```
    Get the title the current web page. Requires the bot to be viewing a web page.
    
    Returns:
    
    The page's title, or null if the page has no title.
  - echoPageTitle
```
public void echoPageTitle()
```
    Echo the current web page title to the robot's default output channel. Requires the bot to be viewing a web page.
  - getPageURL
```
public URL getPageURL()
```
    Get the URL for the current web page. Requires the bot to be viewing a web page.
    
    Returns:
    
    The page's URL, if it exists.
  - toString
```
public String toString()
```
    Get a printable summary of this robot.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The page's content
  - getCurrentElement
```
public HtmlElement getCurrentElement()
```
    Get the HTML element of interest that the robot is currently standing on. Requires the bot to be looking at an element on the current web page.
    
    Returns:
    
    The heading's title.
  - isLookingAtHeading
```
public boolean isLookingAtHeading()
```
    Is the robot looking at (or standing on) an HTML heading element on the current page?
    
    Returns:
    
    True if the robot is positioned at a heading, or false otherwise.
  - advanceToNextHeading
```
public void advanceToNextHeading()
```
    Advance the robot forward in the current document until it is looking at (or standing on) the next HTML heading element it can find. If there are no more headings in the document, it will end up looking at the end of the page. Requires the bot to be viewing a web page.
  - getHeadings
```
public List<HtmlHeadingElement> getHeadings()
```
    Get an iterator over all headings in the current document. This method is designed to make it easy to write foreach-style loops over page headings. Requires the bot to be viewing a web page.
    
    Returns:
    
    an iterator of HtmlHeadingElement objects describing the headings in the page.
  - getHeadingsToLevel
```
public List<HtmlHeadingElement> getHeadingsToLevel(int level)
```
    Get an iterator over all headings in the current document with a level less than or equal to the value specified. This method is designed to make it easy to write foreach-style loops over page headings. Requires the bot to be viewing a web page.
    
    Parameters:
    
    level - Only include headings at this level or above (i.e., numerically less than or equal to this number)
    
    Returns:
    
    an iterator of HtmlHeadingElement objects describing the headings in the page with levels less than or equal to the specified level.
  - echoCurrentElementText
```
public void echoCurrentElementText()
```
    Echo the text of the current HTML element (heading, link, etc.) to the robot's default output channel. Requires the bot to be viewing an existing HTML element on the current web page.
  - getCurrentElementText
```
public String getCurrentElementText()
```
    Get the text of the current HTML element on this web page--i.e., the title of a heading or the text associated with a link. Requires the bot to be looking at an element on the current web page.
    
    Returns:
    
    The text contained by this element on the web page.
  - getHeadingLevel
```
public int getHeadingLevel()
```
    Get the heading level (1-6) of the current heading on this web page. Requires the bot to be looking at a heading element on the current web page.
    
    Returns:
    
    The heading's level.
  - isLookingAtLink
```
public boolean isLookingAtLink()
```
    Is the robot looking at (or standing on) an HTML anchor containing an href attribute (that is, a link to another web page) on the current page?
    
    Returns:
    
    True if the robot is positioned at a link, or false otherwise.
  - advanceToNextLink
```
public void advanceToNextLink()
```
    Advance the robot forward in the current document until it is looking at (or standing on) the next HTML anchor containing an href attribute that it can find. If there are no more headings in the document, it will end up looking at the end of the page. Requires the bot to be viewing a web page.
  - getLinkURI
```
public URI getLinkURI()
```
    Get the URI of the current link on this web page. Requires the bot to be looking at a link (anchor) element on the current web page.
    
    Returns:
    
    The link's destination.
  - linkGoesToAnotherPage
```
public boolean linkGoesToAnotherPage()
```
    Check whether the URL of the current link on this web page refers to a different page, or just another location within the current page. Requires the bot to be looking at a link (anchor) element on the current web page.
    
    Returns:
    
    True if the link refers to a different page
  - linkGoesToAnotherServer
```
public boolean linkGoesToAnotherServer()
```
    Check whether the URL of the current link on this web page refers to a page on a separate server, or simply another location on the same server. Requires the bot to be looking at a link (anchor) element on the current web page.
    
    Returns:
    
    True if the link refers to a page located on a different server
  - getLinks
```
public List<URI> getLinks()
```
    Get an iterator over all links in the current document. This method is designed to make it easy to write foreach-style loops over links. Requires the bot to be viewing a web page.
    
    Returns:
    
    an iterator of URI objects describing the links in the page.
  - getLinksToOtherPages
```
public List<URI> getLinksToOtherPages()
```
    Get an iterator over all links in the current document that refer to other web pages. This is a subset of those returned by getLinks(), with any links to other locations within the same page filtered out. This method is designed to make it easy to write foreach-style loops over links. Requires the bot to be viewing a web page.
    
    Returns:
    
    an iterator of URI objects describing the links in the page.
  - getLinksOffServer
```
public List<URI> getLinksOffServer()
```
    Get an iterator over all links in the current document that refer to pages on other servers. This is a subset of those returned by getLinks(), with any links to pages on the same server as the current page filtered out. This method is designed to make it easy to write foreach-style loops over links. Requires the bot to be viewing a web page.
    
    Returns:
    
    an iterator of URI objects describing the links in the page.
  - jumpToLinkedPage
```
public void jumpToLinkedPage()
```
    Causes the bot to temporarily leave the current page and hop over to the page at the end of the current link. The bot will "remember" where it came from, keeping track of past pages in a stack. After working with the other page, you can use returnToPreviousPage() to come back to the point where you left off. Requires the bot to be looking at a link (anchor) element on the current web page.
  - returnToPreviousPage
```
public void returnToPreviousPage()
```
    Causes the bot to leave the current page and return to the page it was previously visiting, at the location where it left off. The previous page is the one that was most recently "remembered", or alternatively, the one on top of the stack of previous pages that have been visited. Use this method in conjunction with jumpToLinkedPage() to explore multiple pages. Requires the bot to have some previous page to return to.
  - hasPreviousPage
```
public boolean hasPreviousPage()
```
    Check to see if this bot previously visited a different page that it can now return to. Is the stack of previous pages empty or not?
    
    Returns:
    
    True if there is at least one previous page on the stack of previous visited pages, or false if there are none.
  - numberOfPreviousPages
```
public int numberOfPreviousPages()
```
    How deep is the stack of previous pages that this robot can return to? Each time the robot jumps to a new page, it remembers its previous page so you can returnToPreviousPage(). These previous pages are remembered on a stack, and this method allows you to determine how deep this stack is--that is, how many times you can repeatedly call returnToPreviousPage() successfully.
    
    Returns:
    
    The depth of the previous page stack. This result is zero if the robot is on a page, but has not yet jumped to any others, or -1 if there is no current page at all.
  - jumpToPage
```
public void jumpToPage(String url)
```
    Causes the bot to temporarily leave the current page and hop over to the page specified by the URL (as a string). The bot will "remember" where it came from, keeping track of past pages in a stack. After working with the other page, you can use returnToPreviousPage() to come back to the point where you left off.
    
    Parameters:
    
    url - The new page to jump to
  - jumpToPage
```
public void jumpToPage(URL url)
```
    Causes the bot to temporarily leave the current page and hop over to the page specified by the URL. The bot will "remember" where it came from, keeping track of past pages in a stack. After working with the other page, you can use returnToPreviousPage() to come back to the point where you left off.
    
    Parameters:
    
    url - The new page to jump to
  - jumpToPage
```
public void jumpToPage(URI uri)
```
    Causes the bot to temporarily leave the current page and hop over to the page specified by the URL. The bot will "remember" where it came from, keeping track of past pages in a stack. After working with the other page, you can use returnToPreviousPage() to come back to the point where you left off.
    
    Parameters:
    
    uri - The new page to jump to
  - jumpToThisHTML
```
public void jumpToThisHTML(String html)
```
    Causes the bot to temporarily leave the current page and hop over to a specific HTML string provided as a parameter. Instead of reading web content from the internet, the text you pass in will be used instead. The bot will "remember" where it was before, keeping track of past pages in a stack. After working with the provided HTML content you pass in, you can use returnToPreviousPage() to come back to the point where you left off in the previous page.
    
    Parameters:
    
    html - A string containing an HTML document to treat as if it came from the web
  - resolveURIFromPage
```
public URI resolveURIFromPage(String uri)
```
    Get a fully-resolved URI from a (possibly relative) string URI, such as the value of an anchor's href or an img's src attribute. If the input parameter is a relative URI, it will be converted into an appropriate absolute URI relative to the current page's web location. Requires the bot to be viewing a web page.
    
    Parameters:
    
    uri - The URI to convert to absolute form
    
    Returns:
    
    The equivalent, fully-resolved URI, or null if there is none.
  - hasVisitedPage
```
public boolean hasVisitedPage(URI uri)
```
    Check whether this robot has visited this page before.
    
    Parameters:
    
    uri - The page to check
    
    Returns:
    
    True if this robot has previously visited (or is currently on) the given web page
  - hasVisitedPage
```
public boolean hasVisitedPage(URL url)
```
    Check whether this robot has visited this page before.
    
    Parameters:
    
    url - The page to check
    
    Returns:
    
    True if this robot has previously visited (or is currently on) the given web page
  - setOutputChannel
```
public void setOutputChannel(PrintWriter output)
```
    Tell this bot where to send its output. Whenever you tell the bot to echo content or headings, they will go to this destination. By default, output goes to the standard output channel, but you can change the destination here.
    
    Parameters:
    
    output - The output channel to send messages to
  - getOutputChannel
```
public PrintWriterWithHistory getOutputChannel()
```
    Get the output channel where this bot is sending its output.
    
    Returns:
    
    The current output channel for this bot
  - out
```
public PrintWriterWithHistory out()
```
    Get the output channel where this bot is sending its output. This is just a short convenience synonym for getOutputChannel().
    
    Returns:
    
    The current output channel for this bot
  - outputIsHtml
```
public boolean outputIsHtml()
```
    Check whether this robot's output should be treated as plain text, or as HTML markup. The default is false (treat as plain text).
    
    Returns:
    
    True if the output should be treated as HTML markup
  - setOutputIsHtml
```
public void setOutputIsHtml(boolean value)
```
    Set whether this robot's output should be treated as plain text, or as HTML markup.
    
    Parameters:
    
    value - True if the output should be treated as HTML markup, false if it should be treated as plain text
  - run
```
public void run()
```
    Execute this robot's built-in sequence of steps. The default sequence is to do nothing, but subclasses can override this method to add their own behaviors. These behaviors will be automatically run if the robot is attached to a RobotViewer.
  - getPageContent
```
protected String getPageContent()
```
    Get the current web page's entire content as a string. Requires the bot to be viewing a web page.
    
    Returns:
    
    The page's content
  - addXpathNamespace
```
protected void addXpathNamespace(String name,
                                 String url)
```
    Bind a symbolic name to an XML namespace URL so that the symbolic name can be used as a namespace prefix on identifiers in XPATH expressions. This method is for advanced users only. It is only necessary if your WebBot is manipulating content that is not HTML/XHTML, and you need to write XPATH expressions in some other XML namespace. The default namespace bindings are for the prefix "html" to be bound to the namespace http://www.w3.org/1999/xhtml. You can add as many additional namespaces as you need in order to build your own XPATH expressions.
    
    Parameters:
    
    name - The symbolic prefix to use for this namesapce
    
    url - The URL identifying this XML namespace
  - isLink
```
protected boolean isLink(HtmlElement element)
```
    Determine whether a given HTML element is an anchor tag with an HREF attribute.
    
    Parameters:
    
    element - The HTML element to test
    
    Returns:
    
    True if it is a link
  - isHeading
```
protected boolean isHeading(HtmlElement element)
```
    Determine whether a given HTML element is a heading tag.
    
    Parameters:
    
    element - The HTML element to test
    
    Returns:
    
    True if it is a heading (any level)
  - levelOf
```
protected int levelOf(HtmlElement element)
```
    Convert an HTML element representing a heading tag into its corresponding level number.
    
    Parameters:
    
    element - The HTML element to look up
    
    Returns:
    
    The heading's level, 1-6, or 0 if this is not a heading
  - cachedPageFor
```
protected WebBot.Page cachedPageFor(URL url)
```
    Retrieve the cached page for the given URL. This method will create the page and insert it in the cache if it does not yet exist. Assumes the URL has been normalized and is absolute.
    
    Parameters:
    
    url - The URL to look up
    
    Returns:
    
    the page object for this URL
  - releaseCachedResources
```
protected void releaseCachedResources()
```
    Performs cleanup once this bot has completed all its tasks. Users should never need to explicitly call this operation.
  - urlForString
```
protected URL urlForString(String url)
```
    Convert a string to a URL.
    
    Parameters:
    
    url - The string to convert
    
    Returns:
    
    the URL, if one exists, or null if a conversion error occurs.
  - normalizeURL
```
protected URL normalizeURL(URL url)
```
    Normalize a URL.
    
    Parameters:
    
    url - The url to normalize
    
    Returns:
    
    the normalized version of the URL
  - jumpToNormalizedURI
```
protected void jumpToNormalizedURI(URI uri)
```
    The worker method for the various flavors of jumpToPage(URI). This method assumes the given URI has been normalized.
    
    Parameters:
    
    uri - The new page to jump to
  - jumpToNormalizedURL
```
protected void jumpToNormalizedURL(URL url)
```
    The worker method for the various flavors of jumpToPage(URL). This method assumes the given URL has been normalized.
    
    Parameters:
    
    url - The new page to jump to
  - jumpToNormalizedURL
```
protected void jumpToNormalizedURL(File file)
```
    The worker method for the various flavors of jumpToPage(URL). This method assumes the given URL has been normalized.
    
    Parameters:
    
    file - The new page to jump to
  - jumpToPage
```
protected void jumpToPage(WebBot.Page page)
```
    Adds this page to the history stack, enforcing required stack size limit.
    
    Parameters:
    
    page - The new page to add to the stack
  - makeFileAbsolute
```
protected File makeFileAbsolute(File file)
```
    This is needed to get around issues with relative file names when the current working directory is unknown or when running on a server.
    
    Parameters:
    
    file - The file to turn into an absolute path
    
    Returns:
    
    An absolute version of the file, relative to the "logical" current working directory from a student perspective, which may be different than the JVM's true cwd.
    
    See Also:
    
    IOHelper.getFile(File)

Class WebBot

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pages

trueChannel

out

targetPhrase

ALL_LINKS

OTHER_PAGE_LINKS

OTHER_SITE_LINKS

HTML_NODE_PREFIX

Constructor Detail

WebBot

WebBot

Method Detail

isViewingWebPage

isLookingAtEndOfPage

returnToStartOfPage

getPageTitle

echoPageTitle

getPageURL

toString

getCurrentElement

isLookingAtHeading

advanceToNextHeading

getHeadings

getHeadingsToLevel

echoCurrentElementText

getCurrentElementText

getHeadingLevel

isLookingAtLink

advanceToNextLink

getLinkURI

linkGoesToAnotherPage

linkGoesToAnotherServer

getLinks

getLinksToOtherPages

getLinksOffServer

jumpToLinkedPage

returnToPreviousPage

hasPreviousPage

numberOfPreviousPages

jumpToPage

jumpToPage

jumpToPage

jumpToThisHTML

resolveURIFromPage

hasVisitedPage

hasVisitedPage

setOutputChannel

getOutputChannel

out

outputIsHtml

setOutputIsHtml

run

getPageContent

addXpathNamespace

isLink

isHeading

levelOf

cachedPageFor

releaseCachedResources

urlForString

normalizeURL

jumpToNormalizedURI

jumpToNormalizedURL

jumpToNormalizedURL

jumpToPage

makeFileAbsolute