com.abmash.api.query

Class Query

java.lang.Object

com.abmash.api.query.Query

public class Query
extends java.lang.Object

Queries are used to find elements on the current web page. They contain Predicates which filter the elements by their visual properties. HtmlElements can be found by their location on screen and by their color. Predicates can be arbitrarily nested and combined with boolean operators. The Query can be executed by using the find() method. In case of AJAX interaction, the findWithWait() method repeatedly tries to find the elements until a timeout occurs.

Author:

alp

Constructor Summary

Constructors

Constructor and Description
Query(Browser browser, Predicate... predicates)
Query(Browser browser, Predicates predicates)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPredicates(Predicate... predicates)
void	addPredicates(Predicates predicates)
HtmlElements	find() Finds all elements that match the given predicates.
HtmlElement	findFirst() Finds all elements that match the given predicates and returns the first result.
HtmlElement	findFirstWithWait() Finds all elements that match the given predicates and returns the first result.
HtmlElements	findWithWait() Finds all elements that match the given predicates.
Browser	getBrowser()
Predicates	getPredicates()
java.lang.String	toString()
java.lang.String	toString(int intendationSpaces)
void	union(Query... queries)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Query

public Query(Browser browser,
     Predicate... predicates)

Query

public Query(Browser browser,
     Predicates predicates)

Method Detail

addPredicates

public void addPredicates(Predicates predicates)

addPredicates

public void addPredicates(Predicate... predicates)

union

public void union(Query... queries)

getBrowser

public Browser getBrowser()

getPredicates

public Predicates getPredicates()

find

public HtmlElements find()

Finds all elements that match the given predicates.

Returns:

the HtmlElements result

findFirst

public HtmlElement findFirst()

Finds all elements that match the given predicates and returns the first result.

Returns:

the HtmlElements result

findWithWait

public HtmlElements findWithWait()

Finds all elements that match the given predicates. If the result is empty, the find process is repeatedly called until at least one element is found or a timeout exception is thrown. This can be useful to wait for an element to appear after triggering an AJAX request.

Returns:

the HtmlElements result

findFirstWithWait

public HtmlElement findFirstWithWait()

Finds all elements that match the given predicates and returns the first result. If the result is empty, the find process is repeatedly called until at least one element is found or a timeout exception is thrown. This can be useful to wait for an element to appear after triggering an AJAX request.

Returns:

the HtmlElements result

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(int intendationSpaces)