org.safs.selenium.webdriver.lib.interpreter

Class WDScriptFactory

java.lang.Object

com.sebuilder.interpreter.factory.ScriptFactory

org.safs.selenium.webdriver.lib.interpreter.WDScriptFactory

public class WDScriptFactory
extends com.sebuilder.interpreter.factory.ScriptFactory

Support the creation of Scripts from both JSON and HTML Fit Tables.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDWAIT_CLASS
static java.lang.String	CSS_LOCATORTYPE
static java.lang.String	CSSSELECTOR_LOCATORTYPE
protected com.sebuilder.interpreter.factory.DataSourceFactory	dataSourceFactory
static java.lang.String	ID_LOCATORTYPE
static java.lang.String	ITEM_PARAM
static java.lang.String	LINK_LOCATORTYPE
static java.lang.String	LINKTEXT_LOCATORTYPE
static java.lang.String	LOCATOR_2_PARAM
static java.lang.String	LOCATOR_PARAM
static java.lang.String	MAP_LOCATORTYPE
static java.lang.String	NAME_LOCATORTYPE
static java.lang.String	OPTIONS_PARAM
static java.lang.String	PAUSE_CLASS
static java.lang.String	SR_TABLE_TBODY
static java.lang.String	SR_TABLE_TD
static java.lang.String	SR_TABLE_TR
static java.lang.String	SRSTEPTYPE_PACKAGE "org.safs.selenium.webdriver.lib.interpreter.selrunner.steptype"
protected com.sebuilder.interpreter.factory.StepTypeFactory	stepTypeFactory
static java.lang.String	STORE_CLASS
protected WDTestRunFactory	testRunFactory
static java.lang.String	TEXT_PARAM
static java.lang.String	VALUE_LOCATORTYPE
static java.lang.String	VARIABLE_PARAM
static java.lang.String	WAITTIME_PARAM
static java.lang.String	XPATH_LOCATORTYPE

Constructor Summary

Constructors

Constructor and Description
WDScriptFactory()

Method Summary

Modifier and Type	Method and Description
protected javax.xml.parsers.DocumentBuilder	getDocumentBuilder()
protected java.io.BufferedReader	getUTF8Reader(java.io.File sourceFile)
java.util.List<com.sebuilder.interpreter.Script>	parse(org.w3c.dom.Document d, java.io.File f, com.sebuilder.interpreter.factory.StepTypeFactory stepTypeFactory) Parse a XML/HTML Fit Table Document into a Script object.
java.util.List<com.sebuilder.interpreter.Script>	parse(java.io.File f)
java.util.List<com.sebuilder.interpreter.Script>	parse(java.io.Reader reader, java.io.File sourceFile)
java.util.List<com.sebuilder.interpreter.Script>	parse(java.lang.String script, java.io.File sourceFile)
protected void	processNativeStep(com.sebuilder.interpreter.Step step, java.lang.String[] params) This method will process sebuilder native steps' parameters to store them into step so that these parameters can be retrieved from the context (TestRunner).

Methods inherited from class com.sebuilder.interpreter.factory.ScriptFactory

create, parse, parseScript, parseSuite, setDataSourceFactory, setStepTypeFactory, setTestRunFactory

Methods inherited from class java.lang.Object

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

Field Detail

stepTypeFactory

protected com.sebuilder.interpreter.factory.StepTypeFactory stepTypeFactory

testRunFactory

protected WDTestRunFactory testRunFactory

dataSourceFactory

protected com.sebuilder.interpreter.factory.DataSourceFactory dataSourceFactory

SRSTEPTYPE_PACKAGE

public static final java.lang.String SRSTEPTYPE_PACKAGE

"org.safs.selenium.webdriver.lib.interpreter.selrunner.steptype"

See Also:

Constant Field Values

SR_TABLE_TBODY

public static final java.lang.String SR_TABLE_TBODY

See Also:

Constant Field Values

SR_TABLE_TR

public static final java.lang.String SR_TABLE_TR

See Also:

Constant Field Values

SR_TABLE_TD

public static final java.lang.String SR_TABLE_TD

See Also:

Constant Field Values

LOCATOR_PARAM

public static final java.lang.String LOCATOR_PARAM

See Also:

Constant Field Values

LOCATOR_2_PARAM

public static final java.lang.String LOCATOR_2_PARAM

See Also:

Constant Field Values

TEXT_PARAM

public static final java.lang.String TEXT_PARAM

See Also:

Constant Field Values

OPTIONS_PARAM

public static final java.lang.String OPTIONS_PARAM

See Also:

Constant Field Values

ITEM_PARAM

public static final java.lang.String ITEM_PARAM

See Also:

Constant Field Values

VARIABLE_PARAM

public static final java.lang.String VARIABLE_PARAM

See Also:

Constant Field Values

WAITTIME_PARAM

public static final java.lang.String WAITTIME_PARAM

See Also:

Constant Field Values

XPATH_LOCATORTYPE

public static final java.lang.String XPATH_LOCATORTYPE

See Also:

Constant Field Values

MAP_LOCATORTYPE

public static final java.lang.String MAP_LOCATORTYPE

See Also:

Constant Field Values

LINK_LOCATORTYPE

public static final java.lang.String LINK_LOCATORTYPE

See Also:

Constant Field Values

LINKTEXT_LOCATORTYPE

public static final java.lang.String LINKTEXT_LOCATORTYPE

See Also:

Constant Field Values

NAME_LOCATORTYPE

public static final java.lang.String NAME_LOCATORTYPE

See Also:

Constant Field Values

ID_LOCATORTYPE

public static final java.lang.String ID_LOCATORTYPE

See Also:

Constant Field Values

VALUE_LOCATORTYPE

public static final java.lang.String VALUE_LOCATORTYPE

See Also:

Constant Field Values

CSS_LOCATORTYPE

public static final java.lang.String CSS_LOCATORTYPE

See Also:

Constant Field Values

CSSSELECTOR_LOCATORTYPE

public static final java.lang.String CSSSELECTOR_LOCATORTYPE

See Also:

Constant Field Values

ANDWAIT_CLASS

public static final java.lang.String ANDWAIT_CLASS

See Also:

Constant Field Values

PAUSE_CLASS

public static final java.lang.String PAUSE_CLASS

See Also:

Constant Field Values

STORE_CLASS

public static final java.lang.String STORE_CLASS

See Also:

Constant Field Values

Constructor Detail

WDScriptFactory

public WDScriptFactory()

Method Detail

parse

public java.util.List<com.sebuilder.interpreter.Script> parse(java.lang.String script,
                                                              java.io.File sourceFile)
                                                       throws java.io.IOException

Overrides:

parse in class com.sebuilder.interpreter.factory.ScriptFactory

Parameters:

script - -- One of two possible formats:
A JSON string describing a script or suite, or an HTML Fit Table format.

sourceFile - Optionally. the file the script was loaded from.

Returns:

A Script object, ready to run.

Throws:

java.io.IOException - If anything goes wrong with interpreting the script, or with any Readers.

parse

public java.util.List<com.sebuilder.interpreter.Script> parse(org.w3c.dom.Document d,
                                                              java.io.File f,
                                                              com.sebuilder.interpreter.factory.StepTypeFactory stepTypeFactory)
                                                       throws java.io.IOException

Parse a XML/HTML Fit Table Document into a Script object.

Parameters:

d - the Document object parsed from the HTML source File.

f - the File the HTML file was sourced from.

stepTypeFactory -

Returns:

Script to run

Throws:

java.io.IOException

processNativeStep

protected void processNativeStep(com.sebuilder.interpreter.Step step,
                                 java.lang.String[] params)

This method will process sebuilder native steps' parameters to store them into step so that these parameters can be retrieved from the context (TestRunner).

Parameters:

step - Step

params - String[], the parameters

parse

public java.util.List<com.sebuilder.interpreter.Script> parse(java.io.Reader reader,
                                                              java.io.File sourceFile)
                                                       throws java.io.IOException

Overrides:

parse in class com.sebuilder.interpreter.factory.ScriptFactory

Parameters:

reader - A Reader pointing to one of 2 possible script formats:
a JSON stream describing a script or suite, or an HTML Fit Table.

sourceFile - Optionally. the file the script was loaded from.

Returns:

A list of scripts, ready to run.

Throws:

java.io.IOException - If anything goes wrong with interpreting the script, or with the Reader.

getDocumentBuilder

protected javax.xml.parsers.DocumentBuilder getDocumentBuilder()
                                                        throws javax.xml.parsers.ParserConfigurationException

Returns:

DocumentBuilder if one can successfully be created.

Throws:

javax.xml.parsers.ParserConfigurationException

getUTF8Reader

protected java.io.BufferedReader getUTF8Reader(java.io.File sourceFile)
                                        throws java.io.IOException

Parameters:

sourceFile -

Returns:

BufferedReader opened with UTF-8 encoding.

Throws:

java.io.IOException

parse

public java.util.List<com.sebuilder.interpreter.Script> parse(java.io.File f)
                                                       throws java.io.IOException

Overrides:

parse in class com.sebuilder.interpreter.factory.ScriptFactory

Parameters:

f - A File pointing to a JSON file describing a script or suite.

Returns:

A list of scripts, ready to run.

Throws:

java.io.IOException - If anything goes wrong with interpreting the JSON, or with the Reader.

org.json.JSONException - If the JSON can't be parsed.