com.crawljax.core.configuration

Class CrawlElement

java.lang.Object

com.crawljax.core.configuration.CrawlElement

public final class CrawlElement
extends Object

Represents the HTML elements which should be crawled. It represents all the HTML elements in the DOM that match the specified tag name. 1) NOTE: In general CrawlElement is not designed to be instantiated directly. CrawlElement should be used as follows:

CrawljaxConfiguration crawler = new CrawljaxConfiguration(); crawler.click("a"); crawler.click("div").withAttribute("class", "clickable"); crawler.dontClick("a").withText("id", "logout"); crawler.dontClick("a").underXpath("//DIV[@id='header']");

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CrawlElement(Eventable.EventType eventType, String tagName) To create a CrawlElement representing an HTML element MyLink the tag name would be "a".

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addInputFieldIds(List<String> ids)
protected String	escapeApostrophes(String text) Returns a string to resolve apostrophe issue in xpath
protected com.google.common.collect.ImmutableList<Condition>	getConditions()
EventableCondition	getEventableCondition()
Eventable.EventType	getEventType()
String	getId()
protected com.google.common.collect.ImmutableList<String>	getInputFieldIds()
String	getTagName()
String	getWithXpathExpression()
protected void	setConditions(Condition... conditions) Sets the conditions.
String	toString()
CrawlElement	underXPath(String xpathExpression) Restrict CrawlElement to include only HTML elements which are under HTML element X which identified by the xpath expression xpathExpression When xpathExpression returns no HTML elements this Crawltag is not considred under element X.
CrawlElement	when(Condition... conditions) Crawljax will crawl the HTML elements while crawling if and only if all the specified conditions are satisfied.
CrawlElement	withAttribute(String attributeName, String value) Restrict CrawlElement to include only HTML elements with the specified attribute.
CrawlElement	withText(String text) Restrict crawlTag to include only HTML elements which have the specified text For example 1) Foo 2) Bar 3) Example 3a withText("Foo") will include element 1 withText("Example %") will include elements3 Text can support wild-card characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrawlElement

protected CrawlElement(Eventable.EventType eventType,
            String tagName)

To create a CrawlElement representing an HTML element MyLink the tag name would be "a".

Parameters:

eventType - the event type for this crawl element.

Method Detail

when

public CrawlElement when(Condition... conditions)

Crawljax will crawl the HTML elements while crawling if and only if all the specified conditions are satisfied. IMPORTANT: only works with click()!!! For example: when(onContactPageCondition) will only click the HTML element if it is on the contact page

Parameters:

conditions - the condition to be met.

Returns:

this

withAttribute

public CrawlElement withAttribute(String attributeName,
                         String value)

Restrict CrawlElement to include only HTML elements with the specified attribute. For example

...

..

withAtttribute("class", "foo") Would restrict this CrawlElement to only include the div with class="foo"... AttributeName and value strings can support wild-card characters. Use % in to represent a wild-card string. e.g (% is the regex .*) When withAttribute() is called multiple times the CrawlElement will match only those HTML elements that have all the specified attributes.

Parameters:

attributeName - the name of the attribute

value - the value of the attribute

Returns:

this CrawlElement

underXPath

public CrawlElement underXPath(String xpathExpression)

Restrict CrawlElement to include only HTML elements which are under HTML element X which identified by the xpath expression xpathExpression When xpathExpression returns no HTML elements this Crawltag is not considred under element X. Element X is included when it matches the other restrictions of this CrawlElement For example:

.. //DIV[@id='foo'] includes the div, span and a elements //SPAN[@id='foo'] includes the span and a elements //DIV[@class='link'] will not include any elements IMPORTANT: In the xpath expression write elements in uppercase and attributes in lowercase

Parameters:

xpathExpression - the xpath expression where the element should under

Returns:

This CrawlElement

withText

public CrawlElement withText(String text)

Restrict crawlTag to include only HTML elements which have the specified text For example 1) Foo 2) Bar 3) Example 3a withText("Foo") will include element 1 withText("Example %") will include elements3 Text can support wild-card characters. Use % in to represent a wild-card string. e.g (% is the regex .*)

Parameters:

text - Text that should be inside the element.

Returns:

Crawltag with text

getEventableCondition

public EventableCondition getEventableCondition()

Returns:

the EventableCondition belonging to this CrawlElement

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Returns:

the id

getTagName

public String getTagName()

Returns:

The tag name.

getWithXpathExpression

public String getWithXpathExpression()

Returns:

the withXpathExpression

setConditions

protected void setConditions(Condition... conditions)

Sets the conditions.

Parameters:

conditions - The conditions

getConditions

protected com.google.common.collect.ImmutableList<Condition> getConditions()

Returns:

the conditions

getInputFieldIds

protected com.google.common.collect.ImmutableList<String> getInputFieldIds()

Returns:

the inputFieldIds

addInputFieldIds

protected void addInputFieldIds(List<String> ids)

Parameters:

ids - Sets the list of input field ids.

getEventType

public Eventable.EventType getEventType()

Returns:

the eventType

escapeApostrophes

protected String escapeApostrophes(String text)

Returns a string to resolve apostrophe issue in xpath

Parameters:

text -

Returns:

the apostrophe resolved xpath value string