Package org.kquiet.browser.action

Class Extract

java.lang.Object

org.kquiet.browser.action.MultiPhaseAction

org.kquiet.browser.action.Extract

All Implemented Interfaces:

Composable, MultiPhased

public class Extract
extends MultiPhaseAction

Extract is a subclass of MultiPhaseAction which extract information from element by phases to avoid blocking the execution of other browser actions.

Author:

Kimberly

Constructor Summary

Constructors

Constructor	Description
Extract(org.openqa.selenium.By by, String textVariableName)	Create an action to extract information from element.
Extract(org.openqa.selenium.By by, String textVariableName, Map<String,String> attrVariableNames)	Create an action to extract information from element.
Extract(org.openqa.selenium.By by, List<org.openqa.selenium.By> frameBySequence, String textVariableName)	Create an action to extract information from element.
Extract(org.openqa.selenium.By by, List<org.openqa.selenium.By> frameBySequence, String textVariableName, Map<String,String> attrVariableNames)	Create an action to extract information from element.
Extract(org.openqa.selenium.By by, List<org.openqa.selenium.By> frameBySequence, Map<String,String> attrVariableNames)	Create an action to extract information from element.
Extract(org.openqa.selenium.By by, Map<String,String> attrVariableNames)	Create an action to extract information from element.

Method Summary

Modifier and Type	Method	Description
protected void	performMultiPhase()	Perform multiple-phased browser action.
String	toString()

Methods inherited from class org.kquiet.browser.action.MultiPhaseAction

getActionState, getComposer, getCostTime, getErrors, hasNextPhase, isDone, isFail, noNextPhase, perform, setActionState, setComposer, switchToTopForFirefox

Methods inherited from class java.lang.Object

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

Constructor Details

Extract

public Extract(org.openqa.selenium.By by,
 String textVariableName)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

textVariableName - text variable name; non-empty name means to get the visible (i.e. not hidden by CSS) text of the element(including sub-elements) as a variable of ActionComposer

Extract

public Extract(org.openqa.selenium.By by,
 List<org.openqa.selenium.By> frameBySequence,
 String textVariableName)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

frameBySequence - the sequence of the frame locating mechanism for the element resides in frame(or frame in another frame and so on)

textVariableName - text variable name; non-empty name means to get the visible (i.e. not hidden by CSS) text of the element(including sub-elements) as a variable of ActionComposer

Extract

public Extract(org.openqa.selenium.By by,
 Map<String,String> attrVariableNames)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

attrVariableNames - (attribute name, variable name) pairs to set as variables. For each pair, Extract sets the property value of the element as a variable of ActionComposer if the property exists. If property doesn't exists, Extract sets the attribute value of the element as a variable of ActionComposer. If neither exists, null-value variable is set.

Extract

public Extract(org.openqa.selenium.By by,
 List<org.openqa.selenium.By> frameBySequence,
 Map<String,String> attrVariableNames)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

frameBySequence - the sequence of the frame locating mechanism for the element resides in frame(or frame in another frame and so on)

attrVariableNames - (attribute name, variable name) pairs to set as variables. For each pair, Extract sets the property value of the element as a variable of ActionComposer if the property exists. If property doesn't exists, Extract sets the attribute value of the element as a variable of ActionComposer. If neither exists, null-value variable is set.

Extract

public Extract(org.openqa.selenium.By by,
 String textVariableName,
 Map<String,String> attrVariableNames)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

textVariableName - text variable name; non-empty name means to get the visible (i.e. not hidden by CSS) text of the element(including sub-elements) as a variable of ActionComposer

attrVariableNames - (attribute name, variable name) pairs to set as variables. For each pair, Extract sets the property value of the element as a variable of ActionComposer if the property exists. If property doesn't exists, Extract sets the attribute value of the element as a variable of ActionComposer. If neither exists, null-value variable is set.

Extract

public Extract(org.openqa.selenium.By by,
 List<org.openqa.selenium.By> frameBySequence,
 String textVariableName,
 Map<String,String> attrVariableNames)

Create an action to extract information from element.

Parameters:

by - the element locating mechanism

frameBySequence - the sequence of the frame locating mechanism for the element resides in frame(or frame in another frame and so on)

textVariableName - text variable name; non-empty name means to get the visible (i.e. not hidden by CSS) text of the element(including sub-elements) as a variable of ActionComposer

attrVariableNames - (attribute name, variable name) pairs to set as variables. For each pair, Extract sets the property value of the element as a variable of ActionComposer if the property exists. If property doesn't exists, Extract sets the attribute value of the element as a variable of ActionComposer. If neither exists, null-value variable is set.

Method Details

performMultiPhase

protected void performMultiPhase()

Description copied from class: MultiPhaseAction

Perform multiple-phased browser action. MultiPhaseAction.noNextPhase() needs to be invoked to signal that there is no more phase to execute.

Specified by:

performMultiPhase in class MultiPhaseAction

toString

public String toString()

Overrides:

toString in class MultiPhaseAction