org.safs.selenium.webdriver.lib.model

Class TextMatchingCriterion

java.lang.Object

org.safs.selenium.webdriver.lib.model.TextMatchingCriterion

public class TextMatchingCriterion
extends java.lang.Object

This class contains text informations for searching an item in a list, tree, menu etc.

1. The text/path to match
2. If the match is partial of full, which means if the text is substring of the item's text in the list, tree etc.
3. The expected matched index or expected matched indices.
   "expected matched index" is a single int value and it means the Nth matched node/path is wanted
   "expected matched indices" is an array of int value and it means the Nth matched node of each level in the path
   If matchIndexHierarchically() return true, then it contains an array; otherwise it just contains a single int value.
   

History:

Jun 26, 2014 (Lei Wang) Initial release.
Oct 29, 2014 (Lei Wang) Add constructor with only one int value, to match only the index. Overload method matchText(): to match text at certain level for hierarchical structure.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_TRY_ALL_MATCHED_ITEMS '-1000', normally a matchIndex should be given to verify if a text is selected. matchIndex allows to match item N in a list containing duplicate entries. when this value is provided as matchIndex, then verification will be ok if one of matched items is verified.
static int	INVALID_INDEX '-1' an invalid index value.

Constructor Summary

Constructors

Constructor and Description
TextMatchingCriterion(int expectedMatchedIndex)
TextMatchingCriterion(java.lang.String text, boolean partialMatch, int expectedMatchedIndex) constructor of TextMatchingCriterion.
TextMatchingCriterion(java.lang.String path, boolean partialMatch, int[] expectedMatchedIndices) constructor of TextMatchingCriterion.
TextMatchingCriterion(java.lang.String path, boolean partialMatch, java.lang.String indexPathStr) constructor of TextMatchingCriterion.
TextMatchingCriterion(java.lang.String path, boolean partialMatch, java.lang.String indexPathStr, java.lang.String separator) constructor of TextMatchingCriterion.

Method Summary

Modifier and Type	Method and Description
int	getExpectedMatchedIndex() return 0-based index
int[]	getExpectedMatchedIndices() return 0-based indices array
java.lang.String	getSeparator()
java.lang.String	getText() The text/path string to match
boolean	isHierarchical() Test if the criterion is hierarchical or not.
boolean	isPartialMatch() If the match of text is partial or full
boolean	matchIndexHierarchically() Test if the expected-index should be matched level by level. Be careful, even if isHierarchical() is true, but this method may return false.
boolean	matchText(java.lang.String actualText) Test if the actualText matches with the getText(). Used for non-hierarchical structure, such as List, ComboBox etc.
boolean	matchText(java.lang.String actualText, int level) Test if the actualText matches with the value of array pathArray at index. Used for hierarchical structure, such as Tree, Menu etc.
void	setExpectedMatchedIndex(int expectedMatchedIndex)
protected void	setText(java.lang.String text)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_INDEX

public static final int INVALID_INDEX

'-1' an invalid index value.

See Also:

Constant Field Values

INDEX_TRY_ALL_MATCHED_ITEMS

public static final int INDEX_TRY_ALL_MATCHED_ITEMS

'-1000', normally a matchIndex should be given to verify if a text is selected.
matchIndex allows to match item N in a list containing duplicate entries.
when this value is provided as matchIndex, then verification will be ok if one
of matched items is verified.

See Also:

#verifyItemSelection(String, boolean, int, boolean), Constant Field Values

Constructor Detail

TextMatchingCriterion

public TextMatchingCriterion(int expectedMatchedIndex)

TextMatchingCriterion

public TextMatchingCriterion(java.lang.String text,
                             boolean partialMatch,
                             int expectedMatchedIndex)

constructor of TextMatchingCriterion.

Parameters:

text - String, the text to match

partialMatch - boolean, if the text is substring of fullstring

expectedMatchedIndex - int, the times to match, 0-based that is to match item N in a list/tab/tree containing duplicate entries

TextMatchingCriterion

public TextMatchingCriterion(java.lang.String path,
                             boolean partialMatch,
                             int[] expectedMatchedIndices)

constructor of TextMatchingCriterion.

Parameters:

path - String, the path to match

partialMatch - boolean, if the text is substring of fullstring

expectedMatchedIndex - int[], the times to match of each level, 0-based

TextMatchingCriterion

public TextMatchingCriterion(java.lang.String path,
                             boolean partialMatch,
                             java.lang.String indexPathStr)

constructor of TextMatchingCriterion.

Parameters:

path - String, the path to match

partialMatch - boolean, if the text is substring of fullstring

indexPathStr - String, a separated string containing indices, 1-based, for example 3->2->4

TextMatchingCriterion

public TextMatchingCriterion(java.lang.String path,
                             boolean partialMatch,
                             java.lang.String indexPathStr,
                             java.lang.String separator)

constructor of TextMatchingCriterion.

Parameters:

path - String, the path to match

partialMatch - boolean, if the text is substring of fullstring

indexPathStr - String, a separated string containing indices, 1-based, for example 3->2->4

separator - String, the separator to separate index in indexPathStr

Method Detail

getSeparator

public java.lang.String getSeparator()

setText

protected void setText(java.lang.String text)

matchIndexHierarchically

public boolean matchIndexHierarchically()

Test if the expected-index should be matched level by level.
Be careful, even if isHierarchical() is true, but this method may return false. In that situation,
which means that we want to match the path as a whole part.

Returns:

boolean if the item should be matched level by level.

See Also:

isHierarchical()

isHierarchical

public boolean isHierarchical()

Test if the criterion is hierarchical or not.

Returns:

boolean, true if the criterion is hierarchical

getExpectedMatchedIndices

public int[] getExpectedMatchedIndices()

return 0-based indices array

getExpectedMatchedIndex

public int getExpectedMatchedIndex()

return 0-based index

setExpectedMatchedIndex

public void setExpectedMatchedIndex(int expectedMatchedIndex)

getText

public java.lang.String getText()

The text/path string to match

isPartialMatch

public boolean isPartialMatch()

If the match of text is partial or full

matchText

public boolean matchText(java.lang.String actualText)

Test if the actualText matches with the getText().
Used for non-hierarchical structure, such as List, ComboBox etc.

Parameters:

actualText - String, the actual text of the item

matchText

public boolean matchText(java.lang.String actualText,
                         int level)

Test if the actualText matches with the value of array pathArray at index.
Used for hierarchical structure, such as Tree, Menu etc.

Parameters:

actualText - String, the actual text of the item

level - int, the level in the path, 0-based

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object