org.markysoft.vani.core.locating

Class BaseElementLocator<T>

java.lang.Object

org.markysoft.vani.core.locating.BaseElementLocator<T>

All Implemented Interfaces:

VaniElementLocator<T>

Direct Known Subclasses:

JQueryElementLocator, RegionElementLocator, WebElementLocator

public abstract class BaseElementLocator<T>
extends Object
implements VaniElementLocator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openqa.selenium.By	by
protected T	cachedElement
protected List<T>	cachedElementList
protected FieldTypeInfo	fieldTypeInfo
protected org.apache.commons.logging.Log	logger
protected VaniReflectionUtil	reflectionUtil
protected org.openqa.selenium.SearchContext	searchContext
protected boolean	shouldCache
protected VaniContext	vaniContext
protected WaitUtil	waitUtil

Constructor Summary

Constructors

Constructor and Description
BaseElementLocator(org.openqa.selenium.SearchContext searchContext, org.openqa.selenium.By by, boolean shouldCache, FieldTypeInfo fieldTypeInfo, VaniContext vaniContext) Creates a new element locator.

Method Summary

Modifier and Type	Method and Description
protected void	executeContentWait() This method will execute configured content waits.
abstract T	findElement() This method will look only for one match and return it.
abstract List<T>	findElements() This method will look for multiple matches and returns it as a list.
protected org.openqa.selenium.SearchContext	getRootElement()
protected org.openqa.selenium.WebDriver	getWebDriver() This method tries to find the corresponding WebDriver instance.
protected boolean	mustRelocateCachedElements() This method will check whether invalidated-flag is set on corresponding bean instance.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

searchContext

protected final org.openqa.selenium.SearchContext searchContext

shouldCache

protected final boolean shouldCache

by

protected final org.openqa.selenium.By by

cachedElement

protected T cachedElement

cachedElementList

protected List<T> cachedElementList

fieldTypeInfo

protected FieldTypeInfo fieldTypeInfo

vaniContext

protected VaniContext vaniContext

waitUtil

protected WaitUtil waitUtil

reflectionUtil

protected VaniReflectionUtil reflectionUtil

Constructor Detail

BaseElementLocator

public BaseElementLocator(org.openqa.selenium.SearchContext searchContext,
                          org.openqa.selenium.By by,
                          boolean shouldCache,
                          FieldTypeInfo fieldTypeInfo,
                          VaniContext vaniContext)

Creates a new element locator.

Parameters:

searchContext - The context to use when finding the element

by -

shouldCache -

Method Detail

findElement

public abstract T findElement()

Description copied from interface: VaniElementLocator

This method will look only for one match and return it.

Specified by:

findElement in interface VaniElementLocator<T>

Returns:

returns found match or throws an exception when no matching is available

findElements

public abstract List<T> findElements()

Description copied from interface: VaniElementLocator

This method will look for multiple matches and returns it as a list.

Specified by:

findElements in interface VaniElementLocator<T>

Returns:

returns all matches as list or empty list if no matches are available.

executeContentWait

protected void executeContentWait()

This method will execute configured content waits.

See Also:

ContentWait, AjaxWait

getRootElement

protected org.openqa.selenium.SearchContext getRootElement()

getWebDriver

protected org.openqa.selenium.WebDriver getWebDriver()

This method tries to find the corresponding WebDriver instance.

If searchContext is a WebDriver instance, it will be returned. If not it will check whether searchContext is an instance of RemoteWebElement and use RemoteWebElement.getWrappedDriver() to get it.

Returns:

returns corresponding WebDriver instance if availabel or NULL

mustRelocateCachedElements

protected boolean mustRelocateCachedElements()

This method will check whether invalidated-flag is set on corresponding bean instance.

Returns:

returns true if underlying bean instance is marked as invalidated or false if bean instance is not a RegionObject or marked as invalidated