org.safs.selenium.webdriver.lib

Class RS.XPATH

java.lang.Object

org.safs.selenium.webdriver.lib.RS.XPATH

Enclosing class:

RS

public abstract static class RS.XPATH
extends java.lang.Object

This class contains methods returning an xpath.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AND and
static java.lang.String	END ]
static java.lang.String	MATCHING_ALL_START //*[, it is used as beginning to construct an xpath for searching elements under ENTIRE document.
static java.lang.String	MATCHING_DIV_START //DIV[, it is used as beginning to construct an xpath for searching DIV elements under ENTIRE document.
static java.lang.String	OR or
static java.lang.String	RELATIVE_MATCHING_ALL_START .//*[, it is used as beginning to construct an xpath for searching elements under current WebElement.
static java.lang.String	RELATIVE_MATCHING_DIV_START .//DIV[, it is used as beginning to construct an xpath for searching DIV elements under current WebElement.
static java.lang.String	TRUE_CONDITION (1=1), an always true condition to concatenate other conditions to create an XPAH for searching.

Constructor Summary

Constructors

Constructor and Description
XPATH()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	condition(java.lang.String attribute, java.lang.String value, boolean partialMatch)
static java.lang.String	conditionContains(java.lang.String attribute, java.lang.String value)
static java.lang.String	conditionForText(java.lang.String text, boolean partialMatch)
static java.lang.String	fromAttribute(java.lang.String attribute, java.lang.String value, boolean partial, boolean relative) Create an xpath by (attribute, value) for searching webelement within direct and indirect children.
static java.lang.String	fromText(java.lang.String text, boolean partial, boolean relative) Create an xpath by text for searching webelement within direct and indirect children.
static java.lang.String	html() return '/html'
static boolean	isRootHtml(org.openqa.selenium.SearchContext sc)
protected static java.lang.String	quote(java.lang.String text) Add single quote around the text (such as 'text'), and it will be used in XPATH for searching a web element in DOM. If the text (such as Tom's) contains single quote, we cannot simply quote the text with single quote, which will cause the error; instead we will use the function concat() to connect each part of the text, such as concat('Tom', "'", 's').
static java.lang.String	RELATIVE_MATCHING_TAG_START(java.lang.String tag)

Methods inherited from class java.lang.Object

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

Field Detail

MATCHING_ALL_START

public static final java.lang.String MATCHING_ALL_START

//*[, it is used as beginning to construct an xpath for searching elements under ENTIRE document.

See Also:

Constant Field Values

RELATIVE_MATCHING_ALL_START

public static final java.lang.String RELATIVE_MATCHING_ALL_START

.//*[, it is used as beginning to construct an xpath for searching elements under current WebElement.

See Also:

Constant Field Values

MATCHING_DIV_START

public static final java.lang.String MATCHING_DIV_START

//DIV[, it is used as beginning to construct an xpath for searching DIV elements under ENTIRE document.

See Also:

Constant Field Values

RELATIVE_MATCHING_DIV_START

public static final java.lang.String RELATIVE_MATCHING_DIV_START

.//DIV[, it is used as beginning to construct an xpath for searching DIV elements under current WebElement.

See Also:

Constant Field Values

TRUE_CONDITION

public static final java.lang.String TRUE_CONDITION

(1=1), an always true condition to concatenate other conditions to create an XPAH for searching.

See Also:

Constant Field Values

END

public static final java.lang.String END

]

See Also:

Constant Field Values

AND

public static final java.lang.String AND

and

See Also:

Constant Field Values

OR

public static final java.lang.String OR

or

See Also:

Constant Field Values

Constructor Detail

XPATH

public XPATH()

Method Detail

html

public static final java.lang.String html()

return '/html'

RELATIVE_MATCHING_TAG_START

public static java.lang.String RELATIVE_MATCHING_TAG_START(java.lang.String tag)

Parameters:

tag - Ex: span, table, ul, etc..

Returns:

".//<TAG>["

fromText

public static java.lang.String fromText(java.lang.String text,
                                        boolean partial,
                                        boolean relative)

Create an xpath by text for searching webelement within direct and indirect children.

Parameters:

text - String, the text of a webelement. can be regex if XPATH2.0

partial - boolean, if the parameter text is part of the webelement's content

relative - boolean, if true then searching elements under current WebElement; false then searching elements under ENTIRE document.

Returns:

String, the xpath for webdriver to search a webelement.

fromAttribute

public static java.lang.String fromAttribute(java.lang.String attribute,
                                             java.lang.String value,
                                             boolean partial,
                                             boolean relative)

Create an xpath by (attribute, value) for searching webelement within direct and indirect children.

Parameters:

attribute - String, the attribute name

value - String, the attribute's value, can be regex if XPATH2.0.

partial - boolean, if the parameter value is part of the webelement's attribute

relative - boolean, if true then searching elements under current WebElement; false then searching elements under ENTIRE document.

Returns:

String, the xpath for webdriver to search a webelement.

condition

public static java.lang.String condition(java.lang.String attribute,
                                         java.lang.String value,
                                         boolean partialMatch)

Parameters:

attribute - String, the attribute name

value - String, the expected value of the attribute

partialMatch - boolean, if the attribute value will be matched partially (considered as a substring)

Returns:

String, the xpath condition for searching

See Also:

#getCondition(String, boolean)

conditionContains

public static java.lang.String conditionContains(java.lang.String attribute,
                                                 java.lang.String value)

Parameters:

attribute - String, the attribute name ending with "contains"

value - String, the expected substring value of the attribute

Returns:

String, the xpath condition for searching

See Also:

#getCondition(String, boolean)

conditionForText

public static java.lang.String conditionForText(java.lang.String text,
                                                boolean partialMatch)

Parameters:

text - String, the text value

partialMatch - boolean, if the text's value will be matched partially (considered as a substring)

Returns:

String, the xpath condition for searching

quote

protected static java.lang.String quote(java.lang.String text)

Add single quote around the text (such as 'text'), and it will be used in XPATH for searching a web element in DOM.
If the text (such as Tom's) contains single quote, we cannot simply quote the text with single quote, which will cause the error;
instead we will use the function concat() to connect each part of the text, such as concat('Tom', "'", 's').

Parameters:

text - String, the text of the web element.

Returns:

String, the quoted text; or a string combined by function concat().

isRootHtml

public static boolean isRootHtml(org.openqa.selenium.SearchContext sc)