org.safs.model.tools

Class AbstractDriver

java.lang.Object

org.safs.model.tools.AbstractDriver

Direct Known Subclasses:

Driver, EmbeddedHookDriverDriver

public abstract class AbstractDriver
extends java.lang.Object

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
protected static AbstractDriver	_instance Holds an instance of an AbstractDriver for non-static method access.
static java.lang.String	APPMAP_FILES_PROPERTY "testdesigner.appmap.files"
static java.lang.String	APPMAP_ORDER_PROPERTY "testdesigner.appmap.order"
(package private) static java.lang.String	BASH "!"
(package private) static java.lang.String	COMMA ","
static java.lang.String	DEFAULT_APPMAP_ORDER "AppMap.order"
(package private) static java.lang.String	HASH "#"
(package private) static java.lang.String	SEMI ";"

Constructor Summary

Constructors

Constructor and Description
AbstractDriver()

Method Summary

Modifier and Type	Method and Description
DriverInterface	iDriver()
protected abstract JSAFSDriver	jsafs() Return the possible embedded JSAFSDriver.
protected void	preloadAppMapExpressions() Turn ON Expressions, AppMapChaining, and AppMapResolve.
protected void	preloadAppMaps() Internal Use Only
protected java.lang.String	processExpression(java.lang.String expression) If "Expressions" is turned on, evaluate expression as both "math" and "DDVariable" string.
protected java.lang.String[]	processExpressions(java.lang.String... parameters) Used internally to handle the potential that passed parameters may include embedded SAFS Expressions or embedded SAFS variable references.
protected abstract InputProcessor	processor() Return the possible embedded InputProcessor.
abstract void	run() Initiates the embedded drivers and engines to start running if it is not already running.
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String parent) Run a SAFS Component Function on a top-level component (Window).
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String child, java.lang.String parent) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String child, java.lang.String parent, java.lang.String... parameters) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runComponentFunctionConverted(java.lang.String command, java.lang.String child, java.lang.String parent, java.lang.String... parameters) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runDriverCommand(java.lang.String command, java.lang.String... parameters) Run the specified DriverCommand requiring zero or more parameters.
TestRecordHelper	runDriverCommandConverted(java.lang.String command, java.lang.String... parameters) Run a SAFS Driver Command.
abstract void	shutdown() Shutdown the driver and all related resources such as hooks, engines, services and logs etc.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APPMAP_ORDER

public static final java.lang.String DEFAULT_APPMAP_ORDER

"AppMap.order"

See Also:

Constant Field Values

APPMAP_ORDER_PROPERTY

public static final java.lang.String APPMAP_ORDER_PROPERTY

"testdesigner.appmap.order"

See Also:

Constant Field Values

APPMAP_FILES_PROPERTY

public static final java.lang.String APPMAP_FILES_PROPERTY

"testdesigner.appmap.files"

See Also:

Constant Field Values

BASH

static final java.lang.String BASH

"!"

See Also:

Constant Field Values

SEMI

static final java.lang.String SEMI

";"

See Also:

Constant Field Values

HASH

static final java.lang.String HASH

"#"

See Also:

Constant Field Values

COMMA

static final java.lang.String COMMA

","

See Also:

Constant Field Values

_instance

protected static AbstractDriver _instance

Holds an instance of an AbstractDriver for non-static method access.

Constructor Detail

AbstractDriver

public AbstractDriver()

Method Detail

preloadAppMaps

protected void preloadAppMaps()

Internal Use Only

Seek an AppMap.order file in the Datapool directory.

By default the file sought is AppMap.order. However, the user can specify an alternate AppMap order file or AppMap files by using the following JVM Argument:

Examples:
• -Dtestdesigner.appmap.order=AppMap_en.order, or
• -Dtestdesigner.appmap.files=SAMPLEApp.map,SAMPLEApp_en.map, or
• -Dtestdesigner.appmap.order=AppMap_ja.order, or
• -Dtestdesigner.appmap.order=AppMap_cn.order
• etc..

If found, execute SetApplicationMap on each AppMap in the order listed in the file.

processExpressions

protected java.lang.String[] processExpressions(java.lang.String... parameters)

Used internally to handle the potential that passed parameters may include embedded SAFS Expressions or embedded SAFS variable references. This method is automatically called by the internal SAFS DriverCommands or SAFS ComponentFunctions calls and would normally not be called by the user directly.

Parameters:

parameters - String[] of optional parameters. Can be (String[])null.

Returns:

String[] after expressions have been processed, if any. Can return the input parameters array unmodified--including null.

processExpression

protected java.lang.String processExpression(java.lang.String expression)

If "Expressions" is turned on, evaluate expression as both "math" and "DDVariable" string. Otherwise this method will do nothing, just return the original expression string.

preloadAppMapExpressions

protected void preloadAppMapExpressions()

Turn ON Expressions, AppMapChaining, and AppMapResolve.

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String parent)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a top-level component (Window). The particular safs action takes no additional parameters. This method performs SAFS Expression processing on all input parameters. This method is normally called internally by other methods and classes

Parameters:

command - The ComponentFunction keyword (action) to perform

parent - The ComponentFunction parent window name to act on

Returns:

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String child,
                                             java.lang.String parent)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The particular safs action takes no additional parameters. This method performs SAFS Expression processing on all input parameters. This method is normally called internally by other methods and classes.

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String child,
                                             java.lang.String parent,
                                             java.lang.String... parameters)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The safs action may take one or more parameters. This method performs SAFS Expression processing on all input parameters. This method is normally called internally by other methods and classes.

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

parameters - String[] of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runDriverCommand

public TestRecordHelper runDriverCommand(java.lang.String command,
                                         java.lang.String... parameters)
                                  throws java.lang.Throwable

Run the specified DriverCommand requiring zero or more parameters.

Parameters:

command - -- Cannot be null and is not case-sensitive.

parameters - -- optional. Can be (String[])null.

Returns:

TestRecordHelper. Use getStatusCode() and getStatusInfo() for information on execution results.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runDriverCommandConverted

public TestRecordHelper runDriverCommandConverted(java.lang.String command,
                                                  java.lang.String... parameters)
                                           throws java.lang.Throwable

Run a SAFS Driver Command. The safs command may take one or more parameters. This method is normally called internally by overloaded methods and performs no SAFS Expression processing on the input parameters.

Parameters:

command - The DriverCommand keyword (command) to perform

parameters - String[] of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, Success, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runComponentFunctionConverted

public TestRecordHelper runComponentFunctionConverted(java.lang.String command,
                                                      java.lang.String child,
                                                      java.lang.String parent,
                                                      java.lang.String... parameters)
                                               throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The safs action may take one or more parameters. This method is typically called internally and performs no SAFS Expression processing on the input parameters.

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

parameters - String[] of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

iDriver

public DriverInterface iDriver()

Returns:

DriverInterface currently being used.
Could be a JSAFSDriver. Could be an InputProcessor.
Subclasses should override to support other DriverInterface instances not tracked in this superclass. Can be null if none are set.

See Also:

#setIDriver(DriverInterface), JSAFSDriver, InputProcessor

jsafs

protected abstract JSAFSDriver jsafs()

Return the possible embedded JSAFSDriver.

processor

protected abstract InputProcessor processor()

Return the possible embedded InputProcessor.

run

public abstract void run()
                  throws java.lang.Exception

Initiates the embedded drivers and engines to start running if it is not already running. The user should call this method to ensure the drivers/engines are initialized before using them.

Throws:

java.lang.Exception

shutdown

public abstract void shutdown()
                       throws java.lang.Exception

Shutdown the driver and all related resources such as hooks, engines, services and logs etc.

Throws:

java.lang.Exception