com.screenscraper.action

Class HtmlElementIdentifier

java.lang.Object

com.screenscraper.action.HtmlElementIdentifier

public class HtmlElementIdentifier
extends java.lang.Object

Used to identify HTML elements, given certain criteria.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	attribute The attribute of the form to examine.
static java.lang.String	ATTRIBUTE_ACTION Constants used to define various attributes of the HTML element that can be used in defining criteria.
static java.lang.String	ATTRIBUTE_HREF
static java.lang.String	ATTRIBUTE_ID
static java.lang.String	ATTRIBUTE_NAME
static java.lang.String	ATTRIBUTE_SRC
static java.lang.String	ATTRIBUTE_TEXT_ANYWHERE
static java.lang.String	ATTRIBUTE_VALUE
(package private) java.util.HashSet	hsSequences The valid sequences of the elements.
static org.apache.log4j.Logger	log Used for logging.
(package private) int	numValidElements Tracks the number of valid elements found.
(package private) java.lang.String	strValidSequences A string representation of the valid sequences.
(package private) java.lang.String	value The value to look for in the attribute.

Constructor Summary

Constructors

Constructor and Description
HtmlElementIdentifier(java.lang.String criteria) Initializes the object by parsing the criteria string and populating itself.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute() Gets the attribute of the anchor to examine.
java.lang.String	getValidSeqencesString() Gets a string representing the valid sequences.
java.lang.String	getValue() Gets the value to look for in the attribute.
boolean	htmlElementMeetsCriteria(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement, ScrapingSessionState scrapingSessionState) Indicates whether or not the HtmlForm meets the criteria.
void	resetNumValidElements() Resets the number of valid found elements.
void	setAttribute(java.lang.String attribute) Sets the attribute of the anchor to examine.
void	setValidSeqencesString(java.lang.String strValidSequences) Sets a string representing the valid sequences.
void	setValue(java.lang.String value) Sets the value to look for in the attribute.
java.lang.String	toString() Gets the identifier criteria as a single string.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

attribute

java.lang.String attribute

The attribute of the form to examine.

value

java.lang.String value

The value to look for in the attribute.

hsSequences

java.util.HashSet hsSequences

The valid sequences of the elements.

strValidSequences

java.lang.String strValidSequences

A string representation of the valid sequences.

numValidElements

int numValidElements

Tracks the number of valid elements found.

ATTRIBUTE_ACTION

public static final java.lang.String ATTRIBUTE_ACTION

Constants used to define various attributes of the HTML element that can be used in defining criteria.

See Also:

Constant Field Values

ATTRIBUTE_HREF

public static final java.lang.String ATTRIBUTE_HREF

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final java.lang.String ATTRIBUTE_ID

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final java.lang.String ATTRIBUTE_SRC

See Also:

Constant Field Values

ATTRIBUTE_TEXT_ANYWHERE

public static final java.lang.String ATTRIBUTE_TEXT_ANYWHERE

See Also:

Constant Field Values

ATTRIBUTE_VALUE

public static final java.lang.String ATTRIBUTE_VALUE

See Also:

Constant Field Values

Constructor Detail

HtmlElementIdentifier

public HtmlElementIdentifier(java.lang.String criteria)

Initializes the object by parsing the criteria string and populating itself.

Parameters:

criteria - A string representing the criteria.

Method Detail

getAttribute

public java.lang.String getAttribute()

Gets the attribute of the anchor to examine.

Returns:

The attribute as a string.

setAttribute

public void setAttribute(java.lang.String attribute)

Sets the attribute of the anchor to examine.

Parameters:

attribute - The attribute as a string.

getValue

public java.lang.String getValue()

Gets the value to look for in the attribute.

Returns:

The value as a string.

setValue

public void setValue(java.lang.String value)

Sets the value to look for in the attribute.

Parameters:

value - The value as a string.

toString

public java.lang.String toString()

Gets the identifier criteria as a single string.

Overrides:

toString in class java.lang.Object

Returns:

The string.

setValidSeqencesString

public void setValidSeqencesString(java.lang.String strValidSequences)

Sets a string representing the valid sequences.

Parameters:

strValidSequences - The string of sequences.

getValidSeqencesString

public java.lang.String getValidSeqencesString()

Gets a string representing the valid sequences.

Returns:

The string of sequences.

resetNumValidElements

public void resetNumValidElements()

Resets the number of valid found elements.

htmlElementMeetsCriteria

public boolean htmlElementMeetsCriteria(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement,
                                        ScrapingSessionState scrapingSessionState)

Indicates whether or not the HtmlForm meets the criteria.

Parameters:

htmlElement - An HtmlForm.

scrapingSessionState - Resolves variables.

Returns:

A boolean.