com.screenscraper.action

Class NavigationAction

java.lang.Object

com.screenscraper.action.NavigationAction

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

ClickNavigationAction, FormNavigationAction, ListSelectionNavigationAction, TextEntryNavigationAction

public abstract class NavigationAction
extends java.lang.Object
implements java.lang.Comparable

A base class for browser navigation actions such as clicking a link or submitting a form.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLICK_NAVIGATION_ACTION
static int	FORM_NAVIGATION_ACTION Constants used to identify navigation actions in the database.
static int	LIST_SELECTION_NAVIGATION_ACTION
static org.apache.log4j.Logger	log Used for logging.
static int	TEXT_ENTRY_NAVIGATION_ACTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NavigationAction() An empty constructor needed for Castor.
protected	NavigationAction(java.lang.String name) Initializes the action with only a name.

Method Summary

Modifier and Type	Method and Description
void	addFormParameterToSet(java.lang.String name, java.lang.String value) Adds a parameter to be set on the form.
int	compareTo(java.lang.Object navigationAction) So we can be sorted.
void	delete() Deletes the navigation action from the database.
void	dumpToLog() Dumps the contents of the navigation action to the log.
abstract java.lang.String[]	getAttributes() Returns a list of possible attributes for this action
java.lang.String	getCriteria() Gets the criteria used to identify clickable elements.
java.lang.String	getFormParametersToSet() Gets a string representing parameters to set.
protected java.util.HashSet<FormParameter>	getFormParametersToSetAsSet() Gets a reference to the HashMap containing key/value pairs to be set on the form before it gets submitted.
java.lang.String	getFormParametersToSetAsSingleValue() Gets the form parameters to set as a single value.
FormParameter	getFormParameterToSet(int sequence) Gets a parameter to set by its sequence.
protected HtmlElementIdentifier	getHtmlElementIdentifier() Gets the parsed criteria object.
java.lang.String	getHtmlElementIdentifierAttribute() Gets the attribute portion of the HTML element identifier.
java.lang.String	getHtmlElementIdentifierValidSeqencesStringValue() Gets a string representing the value portion of the valid sequences.
java.lang.String	getHtmlElementIdentifierValidSequences() Gets the valid sequences of the HTML element identifier.
java.lang.String	getHtmlElementIdentifierValue() Gets the value portion of the HTML element identifier.
int	getID() Gets the database ID.
boolean	getInvokedFromScript() Indicates whether or not this is to be invoked from a script.
java.lang.String	getName() Gets the name of the action.
protected abstract NavigationActionDoer	getNavigationActionDoerForHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement) Gets a NavigationActionDoer based on a HtmlElement.
java.util.List<NavigationActionDoer>	getNavigationActionDoers(com.gargoylesoftware.htmlunit.html.HtmlPage page, ScrapingSessionState scrapingSessionState) Returns a list of NavigationActionDoer objects based on criteria held by this navigation action.
abstract int	getNavigationActionType() Gets the numeric constant that represents the type of the action.
int	getNumFormParametersToSet() Gets the number of form parameters to set.
ScrapeableFile	getScrapeableFile() Gets the scrapeable file containing this action.
int	getSequence() Gets the sequence of the navigation action.
ScrapeableFile	getTargetScrapeableFile() Gets the target scrapeable file.
java.lang.String	getTargetScrapeableFileName()
AbstractView	getView() Gets the view representing this navigation action.
void	removeFormParameterToSet(int sequence) Removes a parameter by its sequence.
void	save() Saves the object to the database.
void	setCriteria(java.lang.String criteria) Sets the criteria used to identify clickable elements.
void	setFormParametersToSet(java.lang.String formParametersToSet) Parses and sets the parameters to set as a URL-type string into the hash map in this class.
void	setFormParametersToSetAsSingleValue(java.lang.String valueToSet) Sets all form parameters to be set as a single value.
void	setFormParameterToSetName(int sequence, java.lang.String name) Sets the key portion of a parameter by its sequence.
void	setFormParameterToSetValue(int sequence, java.lang.String value) Sets the value portion of a parameter by its sequence.
protected void	setHtmlElementIdentifier(HtmlElementIdentifier htmlElementIdentifier) Sets the parsed criteria object.
void	setHtmlElementIdentifier(java.lang.String strValidSequences) Sets a string representing the value portion of the valid sequences.
void	setHtmlElementIdentifierAttribute(java.lang.String attribute) Sets the attribute portion of the form criteria.
void	setHtmlElementIdentifierValidSequences(java.lang.String sequences) Sets the valid sequences of the HTML element identifier.
void	setHtmlElementIdentifierValue(java.lang.String value) Sets the value portion of the HTML element identifier.
protected void	setID(int navigationActionID) Sets the database ID.
void	setInvokedFromScript(boolean invokedFromScript) Determines whether or not this is to be invoked from a script.
void	setName(java.lang.String name) Sets the name of the action.
void	setScrapeableFile(ScrapeableFile scrapeableFile) Sets the scrapeable file containing this action.
void	setSequence(int sequence) Sets the sequence of the navigation action.
void	setTargetScrapeableFile(ScrapeableFile targetScrapeableFile) Sets the target scrapeable file.
void	setTargetScrapeableFileName(java.lang.String targetScrapeableFileName)
void	setView(AbstractView view) Sets the view representing this navigation action.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

FORM_NAVIGATION_ACTION

public static final int FORM_NAVIGATION_ACTION

Constants used to identify navigation actions in the database.

See Also:

Constant Field Values

TEXT_ENTRY_NAVIGATION_ACTION

public static final int TEXT_ENTRY_NAVIGATION_ACTION

See Also:

Constant Field Values

CLICK_NAVIGATION_ACTION

public static final int CLICK_NAVIGATION_ACTION

See Also:

Constant Field Values

LIST_SELECTION_NAVIGATION_ACTION

public static final int LIST_SELECTION_NAVIGATION_ACTION

See Also:

Constant Field Values

Constructor Detail

NavigationAction

protected NavigationAction()

An empty constructor needed for Castor.

NavigationAction

protected NavigationAction(java.lang.String name)

Initializes the action with only a name.

Parameters:

name - The name of the action.

Method Detail

getAttributes

public abstract java.lang.String[] getAttributes()

Returns a list of possible attributes for this action

Returns:

the attributes

getName

public java.lang.String getName()

Gets the name of the action.

Returns:

The name.

setName

public void setName(java.lang.String name)

Sets the name of the action.

Parameters:

name - The name.

getID

public int getID()

Gets the database ID.

Returns:

The ID of the record.

setID

protected void setID(int navigationActionID)

Sets the database ID.

Parameters:

navigationActionID - The ID of the record.

getInvokedFromScript

public boolean getInvokedFromScript()

Indicates whether or not this is to be invoked from a script.

Returns:

A boolean.

setInvokedFromScript

public void setInvokedFromScript(boolean invokedFromScript)

Determines whether or not this is to be invoked from a script.

Parameters:

invokedFromScript - A boolean.

getSequence

public int getSequence()

Gets the sequence of the navigation action.

Returns:

The sequence.

setSequence

public void setSequence(int sequence)

Sets the sequence of the navigation action.

Parameters:

sequence - The sequence.

getScrapeableFile

public ScrapeableFile getScrapeableFile()

Gets the scrapeable file containing this action.

Returns:

The ScrapeableFile.

setScrapeableFile

public void setScrapeableFile(ScrapeableFile scrapeableFile)

Sets the scrapeable file containing this action.

Parameters:

scrapeableFile - The ScrapeableFile.

getTargetScrapeableFile

public ScrapeableFile getTargetScrapeableFile()

Gets the target scrapeable file.

Returns:

A ScrapeableFile.

setTargetScrapeableFile

public void setTargetScrapeableFile(ScrapeableFile targetScrapeableFile)

Sets the target scrapeable file.

Parameters:

targetScrapeableFile - A ScrapeableFile.

getTargetScrapeableFileName

public java.lang.String getTargetScrapeableFileName()

setTargetScrapeableFileName

public void setTargetScrapeableFileName(java.lang.String targetScrapeableFileName)

getCriteria

public java.lang.String getCriteria()

Gets the criteria used to identify clickable elements.

Returns:

The criteria.

setCriteria

public void setCriteria(java.lang.String criteria)

Sets the criteria used to identify clickable elements.

Parameters:

criteria - The criteria.

compareTo

public int compareTo(java.lang.Object navigationAction)

So we can be sorted.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

navigationAction - The NavigationAction we're comparing to.

Returns:

The usual stuff.

getView

public AbstractView getView()

Gets the view representing this navigation action. This probably isn't the best design, but it makes re-sequencing the panels a heck of a lot easier.

Returns:

The view.

setView

public void setView(AbstractView view)

Sets the view representing this navigation action. This probably isn't the best design, but it makes re-sequencing the panels a heck of a lot easier.

Parameters:

view - The view.

delete

public void delete()

Deletes the navigation action from the database.

getHtmlElementIdentifier

protected HtmlElementIdentifier getHtmlElementIdentifier()

Gets the parsed criteria object.

Returns:

An HtmlElementIdentifier.

setHtmlElementIdentifier

protected void setHtmlElementIdentifier(HtmlElementIdentifier htmlElementIdentifier)

Sets the parsed criteria object.

Parameters:

htmlElementIdentifier - An HtmlElementIdentifier.

getHtmlElementIdentifierAttribute

public java.lang.String getHtmlElementIdentifierAttribute()

Gets the attribute portion of the HTML element identifier.

Returns:

The attribute.

setHtmlElementIdentifierAttribute

public void setHtmlElementIdentifierAttribute(java.lang.String attribute)

Sets the attribute portion of the form criteria.

Parameters:

attribute - The attribute.

getHtmlElementIdentifierValue

public java.lang.String getHtmlElementIdentifierValue()

Gets the value portion of the HTML element identifier.

Returns:

The value.

setHtmlElementIdentifierValue

public void setHtmlElementIdentifierValue(java.lang.String value)

Sets the value portion of the HTML element identifier.

Parameters:

value - The value.

getHtmlElementIdentifierValidSequences

public java.lang.String getHtmlElementIdentifierValidSequences()

Gets the valid sequences of the HTML element identifier.

Returns:

A string representing the sequences.

setHtmlElementIdentifierValidSequences

public void setHtmlElementIdentifierValidSequences(java.lang.String sequences)

Sets the valid sequences of the HTML element identifier.

Parameters:

sequences - The sequences.

getHtmlElementIdentifierValidSeqencesStringValue

public java.lang.String getHtmlElementIdentifierValidSeqencesStringValue()

Gets a string representing the value portion of the valid sequences.

Returns:

The string of sequences.

setHtmlElementIdentifier

public void setHtmlElementIdentifier(java.lang.String strValidSequences)

Sets a string representing the value portion of the valid sequences.

Parameters:

strValidSequences - The valud portion of the string of sequences.

getNavigationActionDoers

public java.util.List<NavigationActionDoer> getNavigationActionDoers(com.gargoylesoftware.htmlunit.html.HtmlPage page,
                                                                     ScrapingSessionState scrapingSessionState)

Returns a list of NavigationActionDoer objects based on criteria held by this navigation action.

Parameters:

page - An HtmlPage containing the elements to find.

scrapingSessionState - Used to resolve variables.

Returns:

A List of NavigationActionDoer objects.

getFormParametersToSetAsSet

protected java.util.HashSet<FormParameter> getFormParametersToSetAsSet()

Gets a reference to the HashMap containing key/value pairs to be set on the form before it gets submitted.

Returns:

A HashMap of FormParameter objects.

getFormParameterToSet

public FormParameter getFormParameterToSet(int sequence)

Gets a parameter to set by its sequence.

Parameters:

sequence - The sequence.

Returns:

A FormParameter containing the resulting key/value pair, if the sequence is found.

getFormParametersToSetAsSingleValue

public java.lang.String getFormParametersToSetAsSingleValue()

Gets the form parameters to set as a single value.

Returns:

The parameters as a single value.

setFormParameterToSetName

public void setFormParameterToSetName(int sequence,
                                      java.lang.String name)

Sets the key portion of a parameter by its sequence.

Parameters:

sequence - The sequence.

name - The name.

setFormParameterToSetValue

public void setFormParameterToSetValue(int sequence,
                                       java.lang.String value)

Sets the value portion of a parameter by its sequence.

Parameters:

sequence - The sequence.

value - The value.

setFormParametersToSetAsSingleValue

public void setFormParametersToSetAsSingleValue(java.lang.String valueToSet)

Sets all form parameters to be set as a single value.

Parameters:

valueToSet - The value to set.

removeFormParameterToSet

public void removeFormParameterToSet(int sequence)

Removes a parameter by its sequence.

Parameters:

sequence - The sequence.

getNumFormParametersToSet

public int getNumFormParametersToSet()

Gets the number of form parameters to set.

Returns:

The number.

addFormParameterToSet

public void addFormParameterToSet(java.lang.String name,
                                  java.lang.String value)

Adds a parameter to be set on the form.

Parameters:

name - The name portion.

value - The value portion.

setFormParametersToSet

public void setFormParametersToSet(java.lang.String formParametersToSet)

Parses and sets the parameters to set as a URL-type string into the hash map in this class.

Parameters:

formParametersToSet - A URL-type string of key/value pairs.

getFormParametersToSet

public java.lang.String getFormParametersToSet()

Gets a string representing parameters to set.

Returns:

A URL GET parameters-type string.

getNavigationActionDoerForHtmlElement

protected abstract NavigationActionDoer getNavigationActionDoerForHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement)

Gets a NavigationActionDoer based on a HtmlElement.

Parameters:

htmlElement - The HtmlElement.

Returns:

A NavigationActionDoer.

getNavigationActionType

public abstract int getNavigationActionType()

Gets the numeric constant that represents the type of the action.

Returns:

One of the constants defined in this class.

save

public void save()

Saves the object to the database.

dumpToLog

public void dumpToLog()

Dumps the contents of the navigation action to the log.