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.
please refer to xpath syntax.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RS.XPATH.ARIA Defines arrays of search-conditions (according to ARIA Roles) to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static class	RS.XPATH.HTML Defines arrays of search-conditions for HTML Controls to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static class	RS.XPATH.SAP Defines arrays of search-conditions for SAPUI5 controls to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_ELEMENTS_PREFIX // represents the path to all elements on the page, it should be appended with real tag name or search-condition, for example "//input" will represent all input tags on the page.
static java.lang.String	AND and
static java.lang.String[]	BUTTON Contains items from RS.XPATH.HTML.BUTTON, RS.XPATH.ARIA.BUTTON and RS.XPATH.SAP.BUTTON An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	CHECKBOX Contains items from RS.XPATH.HTML.CHECKBOX, RS.XPATH.ARIA.CHECKBOX and RS.XPATH.SAP.CHECKBOX An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching checkbox. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	COLOR Contains items from RS.XPATH.HTML.COLOR An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching color picker. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	COMBOBOX Contains items from RS.XPATH.HTML.COMBOBOX, RS.XPATH.ARIA.COMBOBOX and RS.XPATH.SAP.COMBOBOX An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching combobox. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	DATETIME Contains items from RS.XPATH.HTML.DATETIME An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching date-time input box. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String	DESCENDANTS_PREFIX .// represents the path to children, grand-children etc.
static java.lang.String[]	EDITBOX Contains items from RS.XPATH.HTML.EDITBOX, RS.XPATH.ARIA.EDITBOX and RS.XPATH.SAP.EDITBOX An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String	END ]
static java.lang.String[]	FILE Contains items from RS.XPATH.HTML.FILE An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching file picker. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	IMAGE Contains items from RS.XPATH.HTML.IMAGE, RS.XPATH.ARIA.IMAGE and RS.XPATH.SAP.IMAGE An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching image. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	LIST Contains items from RS.XPATH.HTML.LIST, RS.XPATH.ARIA.LISTBOX, RS.XPATH.ARIA.LIST and RS.XPATH.SAP.LIST An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching list. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
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 used inside one XPATH as logical or, such as input[@type='email' or @type='number']
static java.lang.String	PARENT .. represents the parent
static java.lang.String[]	RADIO Contains items from RS.XPATH.HTML.RADIO, RS.XPATH.ARIA.RADIO and RS.XPATH.SAP.RADIO An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching radio button. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String[]	RANGE Contains items from RS.XPATH.HTML.RANGE and RS.XPATH.SAP.RANGE An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching range. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String	REGEX_OR | used between multiple XPATH as logical or, such as //book/title | //book/price
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[]	TABLE Contains items from RS.XPATH.HTML.TABLE, RS.XPATH.ARIA.TABLE and RS.XPATH.SAP.TABLE An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching table. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
static java.lang.String	TAG_ANY * represents any tag name
static java.lang.String	TAG_DIV DIV tag name
static java.lang.String[]	TREE Contains items from RS.XPATH.ARIA.TREE and RS.XPATH.SAP.TREE An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching tree. It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])
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	allDescendants(java.lang.String[] targets) According to the search conditions, return the xpath to get all matched elements.
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	fromAttribute(java.lang.String tag, java.lang.String attribute, java.lang.String value, boolean partial, boolean relative) Create an xpath by tag's name and (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	fromText(java.lang.String tag, java.lang.String text, boolean partial, boolean relative) Create an xpath by tag's name and text for searching webelement within direct and indirect children.
static java.lang.String	html() return '/html'
static boolean	isRootHtml(org.openqa.selenium.SearchContext sc)
static boolean	matched(org.openqa.selenium.WebElement element, java.lang.String type) Test if the element's type can match what is expected.
static java.lang.String	MATCHING_TAG_START(java.lang.String tag)
static java.lang.String	ofType(java.lang.String type)
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 has already been quoted, we simply return it. 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)
static java.lang.String	relativeDescendants(java.lang.String[] targets) According to the search conditions, return the xpath to get the relative (to current node) elements.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_ANY

public static final java.lang.String TAG_ANY

* represents any tag name

See Also:

Constant Field Values

TAG_DIV

public static final java.lang.String TAG_DIV

DIV tag name

See Also:

Constant Field Values

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 used inside one XPATH as logical or, such as input[@type='email' or @type='number']

See Also:

Constant Field Values

REGEX_OR

public static final java.lang.String REGEX_OR

| used between multiple XPATH as logical or, such as //book/title | //book/price

See Also:

Constant Field Values

PARENT

public static final java.lang.String PARENT

.. represents the parent

See Also:

Constant Field Values

DESCENDANTS_PREFIX

public static final java.lang.String DESCENDANTS_PREFIX

.// represents the path to children, grand-children etc. relative to current element, it should be appended with real tag name or search-condition, for example ".//input" will represent all input tags as children, grand-children of current tree node on the page.

See Also:

EDITBOX, BUTTON, COMBOBOX, CHECKBOX, COLOR, DATETIME, FILE, RADIO, RANGE, IMAGE, LIST, TREE, TABLE, relativeDescendants(String[]), Constant Field Values

ALL_ELEMENTS_PREFIX

public static final java.lang.String ALL_ELEMENTS_PREFIX

// represents the path to all elements on the page, it should be appended with real tag name or search-condition, for example "//input" will represent all input tags on the page.

See Also:

EDITBOX, BUTTON, COMBOBOX, CHECKBOX, COLOR, DATETIME, FILE, RADIO, RANGE, IMAGE, LIST, TREE, TABLE, allDescendants(String[]), Constant Field Values

EDITBOX

public static final java.lang.String[] EDITBOX

Contains items from RS.XPATH.HTML.EDITBOX, RS.XPATH.ARIA.EDITBOX and RS.XPATH.SAP.EDITBOX
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

BUTTON

public static final java.lang.String[] BUTTON

Contains items from RS.XPATH.HTML.BUTTON, RS.XPATH.ARIA.BUTTON and RS.XPATH.SAP.BUTTON
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

COMBOBOX

public static final java.lang.String[] COMBOBOX

Contains items from RS.XPATH.HTML.COMBOBOX, RS.XPATH.ARIA.COMBOBOX and RS.XPATH.SAP.COMBOBOX
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching combobox.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

CHECKBOX

public static final java.lang.String[] CHECKBOX

Contains items from RS.XPATH.HTML.CHECKBOX, RS.XPATH.ARIA.CHECKBOX and RS.XPATH.SAP.CHECKBOX
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching checkbox.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

COLOR

public static final java.lang.String[] COLOR

Contains items from RS.XPATH.HTML.COLOR
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching color picker.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

DATETIME

public static final java.lang.String[] DATETIME

Contains items from RS.XPATH.HTML.DATETIME
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching date-time input box.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

FILE

public static final java.lang.String[] FILE

Contains items from RS.XPATH.HTML.FILE
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching file picker.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

RADIO

public static final java.lang.String[] RADIO

Contains items from RS.XPATH.HTML.RADIO, RS.XPATH.ARIA.RADIO and RS.XPATH.SAP.RADIO
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching radio button.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

RANGE

public static final java.lang.String[] RANGE

Contains items from RS.XPATH.HTML.RANGE and RS.XPATH.SAP.RANGE
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching range.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

IMAGE

public static final java.lang.String[] IMAGE

Contains items from RS.XPATH.HTML.IMAGE, RS.XPATH.ARIA.IMAGE and RS.XPATH.SAP.IMAGE
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching image.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

LIST

public static final java.lang.String[] LIST

Contains items from RS.XPATH.HTML.LIST, RS.XPATH.ARIA.LISTBOX, RS.XPATH.ARIA.LIST and RS.XPATH.SAP.LIST
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching list.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

TREE

public static final java.lang.String[] TREE

Contains items from RS.XPATH.ARIA.TREE and RS.XPATH.SAP.TREE
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching tree.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

TABLE

public static final java.lang.String[] TABLE

Contains items from RS.XPATH.HTML.TABLE, RS.XPATH.ARIA.TABLE and RS.XPATH.SAP.TABLE
An array of search-conditions to be appended to DESCENDANTS_PREFIX or ALL_ELEMENTS_PREFIX to form a valid XPATH for searching table.
It serves as parameter of relativeDescendants(String[]) or allDescendants(String[])

Constructor Detail

XPATH

public XPATH()

Method Detail

html

public static final java.lang.String html()

return '/html'

MATCHING_TAG_START

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

Parameters:

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

Returns:

"//<TAG>["

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.

fromText

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

Create an xpath by tag's name and text for searching webelement within direct and indirect children.

Parameters:

tag - String, the name of the tag to find.

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.

fromAttribute

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

Create an xpath by tag's name and (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 has already been quoted, we simply return it.
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)

relativeDescendants

public static java.lang.String relativeDescendants(java.lang.String[] targets)

According to the search conditions, return the xpath to get the relative (to current node) elements.

Parameters:

targets - String[], the search conditions

Returns:

String, the xpath to get the relative (to current node) elements.

allDescendants

public static java.lang.String allDescendants(java.lang.String[] targets)

According to the search conditions, return the xpath to get all matched elements.

Parameters:

targets - String[], the search conditions

Returns:

String, the xpath to get all matched elements.

ofType

public static java.lang.String ofType(java.lang.String type)

Parameters:

type - String, represents the WebElement's type, such as "ComboBox", "Button" etc.

Returns:

String, represents the XPATH according to which to find the WebElement. For example XPATH.relativeDescendants(XPATH.COMBOBOX) is used to find the ComboBox elements.

matched

public static boolean matched(org.openqa.selenium.WebElement element,
                              java.lang.String type)

Test if the element's type can match what is expected.

Parameters:

element - WebElement, the element to check.

type - String, the expected type, such as EditBox, RadioButton, ComboBox etc.

Returns:

boolean true if the web-element matches the expected type.