org.safs.tools.drivers

Class AbstractInputProcessor

java.lang.Object

org.safs.tools.drivers.AbstractInputProcessor

All Implemented Interfaces:

DriverInterface, PathInterface

Direct Known Subclasses:

InputProcessor

public abstract class AbstractInputProcessor
extends java.lang.Object
implements DriverInterface

An abstract implementation of the DriverInterface to be subclassed by other concrete InputProcessors.

Field Summary

Fields

Modifier and Type	Field and Description
protected AutoItComponent	autoitComponentCommands This allows us to provide local support AutoIt CF test records.
protected UniqueStringCounterInfo	counterInfo
protected DriverInterface	driver The parent DriverInterface app running the test.
protected FlowControlInterface	localFlowControlInterface This allows us to provide per test table error recovery blockIDs instead of the globally applied blockID values stored in the Driver.
static boolean	PREFERRED_ENGINES_OVERRIDE Allow preferred engines to override internal process commands.
static boolean	RESOLVE_SKIPPED_RECORDS By default, SKIPPED records (S) do get processed by resolveExpressions.
protected StatusCounter	statusCounter Pass/Fail info for a single instance of an Input processor.
protected TestRecordHelper	testRecordData Stores input record information for the driver and some engines.
protected TIDComponent	tidComponentCommands This allows us to provide local support for non-GUI CF test records.
protected TIDDriverCommands	tidDriverCommands This allows us to provide per table error recovery blockIDs instead of the globally applied blockID values stored in the Driver.

Fields inherited from interface org.safs.tools.drivers.DriverInterface

DRIVER_CONTROL_POF_VAR, DRIVER_CONTROL_POW_VAR, DRIVER_CONTROL_VAR

Constructor Summary

Constructors

Constructor and Description
AbstractInputProcessor(DriverInterface driver) Constructor for AbstractInputProcessor

Method Summary

Modifier and Type	Method and Description
StatusInterface	addStatusCounts(StatusInterface incstatus)
void	clearEnginePreferences()
void	endEnginePreference(java.lang.String key)
EngineInterface	getAutoItComponentSupport() We provide AutoIt Component Function support.
java.lang.String	getBenchDir()
ConfigureInterface	getConfigureInterface()
CountersInterface	getCountersInterface()
long	getCycleLogMode()
java.lang.String	getCycleLogName()
java.lang.String	getCycleSeparator()
java.lang.String	getCycleSuffix()
java.lang.String	getDatapoolDir()
DebugInterface	getDebugInterface()
java.lang.String	getDifDir()
java.lang.String	getDriverName()
java.lang.String	getDriverRootDir()
java.util.ListIterator	getEnginePreferences()
java.util.ListIterator	getEngines()
FlowControlInterface	getFlowControlInterface(java.lang.String testlevel) We provide our own local FlowControlInterface object if per/table flow control is enabled.
InputInterface	getInputInterface()
EngineInterface	getIPDriverCommands()
java.lang.String	getLogLevel()
java.lang.String	getLogsDir()
LogsInterface	getLogsInterface()
MapsInterface	getMapsInterface()
int	getMillisBetweenRecords()
EngineInterface	getPreferredEngine(java.lang.String key)
java.lang.String	getProjectRootDir()
java.lang.String	getRootVerifyDir()
StatusInterface	getStatusInterface()
long	getStepLogMode()
java.lang.String	getStepLogName()
java.lang.String	getStepSeparator()
java.lang.String	getStepSuffix()
long	getSuiteLogMode()
java.lang.String	getSuiteLogName()
java.lang.String	getSuiteSeparator()
java.lang.String	getSuiteSuffix()
java.lang.String	getTestDir()
java.lang.String	getTestLevel()
java.lang.String	getTestName()
TestRecordData	getTestRecordData() Retrieves our stored TestRecordData.
EngineInterface	getTIDDriverCommands() We override the Driver's TIDDriverCommands object and provide our own instance since the InputProcessor instance needs to override some values the TIDDriverCommands object may query.
EngineInterface	getTIDGUIlessComponentSupport() We provide generic support for certain Component Function commands that don't actually operate on any GUI objects.
VarsInterface	getVarsInterface()
boolean	hasEnginePreferences()
void	incrementGeneralStatus(int status) Increment General (not Test) record counts.
void	incrementTestStatus(int status) Increment Test Record counts.
boolean	isExitCycle()
boolean	isExitSuite()
boolean	isExpressionsEnabled()
boolean	isPerTableFlowControl()
boolean	isPreferredEngine(EngineInterface engine)
boolean	isPreferredEngine(java.lang.String key)
long	setBenchDir(java.lang.String absolute_path)
long	setDatapoolDir(java.lang.String absolute_path)
long	setDifDir(java.lang.String absolute_path)
void	setExitCycle(boolean enabled)
void	setExitSuite(boolean enabled)
void	setExpressionsEnabled(boolean enabled)
long	setLogsDir(java.lang.String absolute_path)
void	setMillisBetweenRecords(int millisBetweenRecords)
void	setPerTableFlowControl(boolean enabled)
long	setProjectRootDir(java.lang.String absolute_path)
long	setRootVerifyDir(java.lang.String absolute_path)
long	setTestDir(java.lang.String absolute_path)
void	startEnginePreference(java.lang.String key)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.tools.drivers.DriverInterface

getCoreInterface, logMessage

Field Detail

RESOLVE_SKIPPED_RECORDS

public static boolean RESOLVE_SKIPPED_RECORDS

By default, SKIPPED records (S) do get processed by resolveExpressions. Set to false to bypass expression resolution for SKIPPED records.

PREFERRED_ENGINES_OVERRIDE

public static boolean PREFERRED_ENGINES_OVERRIDE

Allow preferred engines to override internal process commands. By default, some processors use internal command processors before they resort to other external engines. Setting this boolean to TRUE allows a "preferred" engine to override the implementation of an internal command.

driver

protected DriverInterface driver

The parent DriverInterface app running the test.

statusCounter

protected StatusCounter statusCounter

Pass/Fail info for a single instance of an Input processor.

counterInfo

protected UniqueStringCounterInfo counterInfo

testRecordData

protected TestRecordHelper testRecordData

Stores input record information for the driver and some engines.

localFlowControlInterface

protected FlowControlInterface localFlowControlInterface

This allows us to provide per test table error recovery blockIDs instead of the globally applied blockID values stored in the Driver.

tidDriverCommands

protected TIDDriverCommands tidDriverCommands

This allows us to provide per table error recovery blockIDs instead of the globally applied blockID values stored in the Driver.

tidComponentCommands

protected TIDComponent tidComponentCommands

This allows us to provide local support for non-GUI CF test records.

autoitComponentCommands

protected AutoItComponent autoitComponentCommands

This allows us to provide local support AutoIt CF test records.

Constructor Detail

AbstractInputProcessor

public AbstractInputProcessor(DriverInterface driver)

Constructor for AbstractInputProcessor

Method Detail

getMillisBetweenRecords

public int getMillisBetweenRecords()

Specified by:

getMillisBetweenRecords in interface DriverInterface

See Also:

DriverInterface.getMillisBetweenRecords()

setMillisBetweenRecords

public void setMillisBetweenRecords(int millisBetweenRecords)

Specified by:

setMillisBetweenRecords in interface DriverInterface

See Also:

DriverInterface.setMillisBetweenRecords(int)

isExitSuite

public boolean isExitSuite()

Specified by:

isExitSuite in interface DriverInterface

See Also:

DriverInterface.isExitSuite()

setExitSuite

public void setExitSuite(boolean enabled)

Specified by:

setExitSuite in interface DriverInterface

See Also:

DriverInterface.setExitSuite(boolean)

isExitCycle

public boolean isExitCycle()

Specified by:

isExitCycle in interface DriverInterface

See Also:

DriverInterface.isExitCycle()

setExitCycle

public void setExitCycle(boolean enabled)

Specified by:

setExitCycle in interface DriverInterface

See Also:

DriverInterface.setExitCycle(boolean)

setPerTableFlowControl

public void setPerTableFlowControl(boolean enabled)

Specified by:

setPerTableFlowControl in interface DriverInterface

See Also:

DriverInterface#setPerTableFlowControl()

isPerTableFlowControl

public boolean isPerTableFlowControl()

Specified by:

isPerTableFlowControl in interface DriverInterface

See Also:

DriverInterface.isPerTableFlowControl()

getConfigureInterface

public ConfigureInterface getConfigureInterface()

Specified by:

getConfigureInterface in interface DriverInterface

See Also:

DriverInterface.getConfigureInterface()

getInputInterface

public InputInterface getInputInterface()

Specified by:

getInputInterface in interface DriverInterface

See Also:

DriverInterface.getInputInterface()

getMapsInterface

public MapsInterface getMapsInterface()

Specified by:

getMapsInterface in interface DriverInterface

See Also:

DriverInterface.getMapsInterface()

getVarsInterface

public VarsInterface getVarsInterface()

Specified by:

getVarsInterface in interface DriverInterface

See Also:

DriverInterface.getVarsInterface()

getLogsInterface

public LogsInterface getLogsInterface()

Specified by:

getLogsInterface in interface DriverInterface

See Also:

DriverInterface.getLogsInterface()

getCountersInterface

public CountersInterface getCountersInterface()

Specified by:

getCountersInterface in interface DriverInterface

See Also:

DriverInterface.getCountersInterface()

getDebugInterface

public DebugInterface getDebugInterface()

Specified by:

getDebugInterface in interface DriverInterface

See Also:

DriverInterface.getDebugInterface()

getFlowControlInterface

public FlowControlInterface getFlowControlInterface(java.lang.String testlevel)

We provide our own local FlowControlInterface object if per/table flow control is enabled. Otherwise, we provide the Driver's default FlowControlInterface object.

Specified by:

getFlowControlInterface in interface DriverInterface

See Also:

DriverInterface#getFlowControlInterface()

getStatusInterface

public StatusInterface getStatusInterface()

Specified by:

getStatusInterface in interface DriverInterface

See Also:

DriverInterface.getStatusInterface()

addStatusCounts

public StatusInterface addStatusCounts(StatusInterface incstatus)

Specified by:

addStatusCounts in interface DriverInterface

See Also:

DriverInterface.addStatusCounts(StatusInterface)

getEngines

public java.util.ListIterator getEngines()

Specified by:

getEngines in interface DriverInterface

See Also:

DriverInterface.getEngines()

hasEnginePreferences

public boolean hasEnginePreferences()

Specified by:

hasEnginePreferences in interface DriverInterface

See Also:

DriverInterface.hasEnginePreferences()

getEnginePreferences

public java.util.ListIterator getEnginePreferences()

Specified by:

getEnginePreferences in interface DriverInterface

See Also:

DriverInterface.getEnginePreferences()

startEnginePreference

public void startEnginePreference(java.lang.String key)
                           throws java.lang.IllegalArgumentException

Specified by:

startEnginePreference in interface DriverInterface

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.startEnginePreference(String)

endEnginePreference

public void endEnginePreference(java.lang.String key)
                         throws java.lang.IllegalArgumentException

Specified by:

endEnginePreference in interface DriverInterface

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.endEnginePreference(String)

clearEnginePreferences

public void clearEnginePreferences()

Specified by:

clearEnginePreferences in interface DriverInterface

See Also:

DriverInterface.clearEnginePreferences()

isPreferredEngine

public boolean isPreferredEngine(java.lang.String key)
                          throws java.lang.IllegalArgumentException

Specified by:

isPreferredEngine in interface DriverInterface

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.isPreferredEngine(String)

isPreferredEngine

public boolean isPreferredEngine(EngineInterface engine)
                          throws java.lang.IllegalArgumentException

Specified by:

isPreferredEngine in interface DriverInterface

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.isPreferredEngine(String)

getPreferredEngine

public EngineInterface getPreferredEngine(java.lang.String key)
                                   throws java.lang.IllegalArgumentException

Specified by:

getPreferredEngine in interface DriverInterface

Throws:

java.lang.IllegalArgumentException

See Also:

DriverInterface.getPreferredEngine(String)

getTestRecordData

public TestRecordData getTestRecordData()

Retrieves our stored TestRecordData.

getDriverName

public java.lang.String getDriverName()

Specified by:

getDriverName in interface DriverInterface

See Also:

DriverInterface.getDriverName()

getTIDDriverCommands

public EngineInterface getTIDDriverCommands()

We override the Driver's TIDDriverCommands object and provide our own instance since the InputProcessor instance needs to override some values the TIDDriverCommands object may query. Such as retrieving local FlowControlInterface objects, etc..

Specified by:

getTIDDriverCommands in interface DriverInterface

See Also:

DriverInterface.getTIDDriverCommands()

getAutoItComponentSupport

public EngineInterface getAutoItComponentSupport()

We provide AutoIt Component Function support.

Specified by:

getAutoItComponentSupport in interface DriverInterface

See Also:

DriverInterface.getAutoItComponentSupport()

getTIDGUIlessComponentSupport

public EngineInterface getTIDGUIlessComponentSupport()

We provide generic support for certain Component Function commands that don't actually operate on any GUI objects. These are generally those CF commands that allow the record to specify "anything" "at all" for Window and Component references.

Specified by:

getTIDGUIlessComponentSupport in interface DriverInterface

See Also:

DriverInterface.getTIDGUIlessComponentSupport()

getIPDriverCommands

public EngineInterface getIPDriverCommands()

Specified by:

getIPDriverCommands in interface DriverInterface

See Also:

DriverInterface.getIPDriverCommands()

getDriverRootDir

public java.lang.String getDriverRootDir()

Specified by:

getDriverRootDir in interface DriverInterface

Specified by:

getDriverRootDir in interface PathInterface

See Also:

DriverInterface.getDriverRootDir()

getProjectRootDir

public java.lang.String getProjectRootDir()

Specified by:

getProjectRootDir in interface DriverInterface

Specified by:

getProjectRootDir in interface PathInterface

See Also:

DriverInterface.getProjectRootDir()

getDatapoolDir

public java.lang.String getDatapoolDir()

Specified by:

getDatapoolDir in interface DriverInterface

Specified by:

getDatapoolDir in interface PathInterface

See Also:

DriverInterface.getDatapoolDir()

getBenchDir

public java.lang.String getBenchDir()

Specified by:

getBenchDir in interface DriverInterface

Specified by:

getBenchDir in interface PathInterface

See Also:

DriverInterface.getBenchDir()

getDifDir

public java.lang.String getDifDir()

Specified by:

getDifDir in interface DriverInterface

Specified by:

getDifDir in interface PathInterface

See Also:

DriverInterface.getDifDir()

getLogsDir

public java.lang.String getLogsDir()

Specified by:

getLogsDir in interface DriverInterface

Specified by:

getLogsDir in interface PathInterface

See Also:

DriverInterface.getLogsDir()

getTestDir

public java.lang.String getTestDir()

Specified by:

getTestDir in interface DriverInterface

Specified by:

getTestDir in interface PathInterface

See Also:

DriverInterface.getTestDir()

getTestName

public java.lang.String getTestName()

Specified by:

getTestName in interface DriverInterface

See Also:

DriverInterface.getTestName()

getTestLevel

public java.lang.String getTestLevel()

Specified by:

getTestLevel in interface DriverInterface

See Also:

DriverInterface.getTestLevel()

getCycleSuffix

public java.lang.String getCycleSuffix()

Specified by:

getCycleSuffix in interface DriverInterface

See Also:

DriverInterface.getCycleSuffix()

getCycleSeparator

public java.lang.String getCycleSeparator()

Specified by:

getCycleSeparator in interface DriverInterface

See Also:

DriverInterface.getCycleSeparator()

getSuiteSuffix

public java.lang.String getSuiteSuffix()

Specified by:

getSuiteSuffix in interface DriverInterface

See Also:

DriverInterface.getSuiteSuffix()

getSuiteSeparator

public java.lang.String getSuiteSeparator()

Specified by:

getSuiteSeparator in interface DriverInterface

See Also:

DriverInterface.getSuiteSeparator()

getStepSuffix

public java.lang.String getStepSuffix()

Specified by:

getStepSuffix in interface DriverInterface

See Also:

DriverInterface.getStepSuffix()

getStepSeparator

public java.lang.String getStepSeparator()

Specified by:

getStepSeparator in interface DriverInterface

See Also:

DriverInterface.getStepSeparator()

getLogLevel

public java.lang.String getLogLevel()

Specified by:

getLogLevel in interface DriverInterface

See Also:

DriverInterface.getLogLevel()

getCycleLogName

public java.lang.String getCycleLogName()

Specified by:

getCycleLogName in interface DriverInterface

See Also:

DriverInterface.getCycleLogName()

getCycleLogMode

public long getCycleLogMode()

Specified by:

getCycleLogMode in interface DriverInterface

See Also:

DriverInterface.getCycleLogMode()

getSuiteLogName

public java.lang.String getSuiteLogName()

Specified by:

getSuiteLogName in interface DriverInterface

See Also:

DriverInterface.getSuiteLogName()

getSuiteLogMode

public long getSuiteLogMode()

Specified by:

getSuiteLogMode in interface DriverInterface

See Also:

DriverInterface.getSuiteLogMode()

getStepLogName

public java.lang.String getStepLogName()

Specified by:

getStepLogName in interface DriverInterface

See Also:

DriverInterface.getStepLogName()

getStepLogMode

public long getStepLogMode()

Specified by:

getStepLogMode in interface DriverInterface

See Also:

DriverInterface.getStepLogMode()

isExpressionsEnabled

public boolean isExpressionsEnabled()

Specified by:

isExpressionsEnabled in interface DriverInterface

See Also:

DriverInterface.isExpressionsEnabled()

setExpressionsEnabled

public void setExpressionsEnabled(boolean enabled)

Specified by:

setExpressionsEnabled in interface DriverInterface

See Also:

DriverInterface.setExpressionsEnabled(boolean)

setProjectRootDir

public long setProjectRootDir(java.lang.String absolute_path)

Specified by:

setProjectRootDir in interface DriverInterface

See Also:

DriverInterface.setProjectRootDir(String)

setDatapoolDir

public long setDatapoolDir(java.lang.String absolute_path)

Specified by:

setDatapoolDir in interface DriverInterface

See Also:

DriverInterface.setDatapoolDir(String)

setBenchDir

public long setBenchDir(java.lang.String absolute_path)

Specified by:

setBenchDir in interface DriverInterface

See Also:

DriverInterface.setBenchDir(String)

setTestDir

public long setTestDir(java.lang.String absolute_path)

Specified by:

setTestDir in interface DriverInterface

See Also:

DriverInterface.setTestDir(String)

setDifDir

public long setDifDir(java.lang.String absolute_path)

Specified by:

setDifDir in interface DriverInterface

See Also:

DriverInterface.setDifDir(String)

setLogsDir

public long setLogsDir(java.lang.String absolute_path)

Specified by:

setLogsDir in interface DriverInterface

See Also:

DriverInterface.setLogsDir(String)

getRootVerifyDir

public java.lang.String getRootVerifyDir()

Specified by:

getRootVerifyDir in interface DriverInterface

See Also:

DriverInterface.getRootVerifyDir()

setRootVerifyDir

public long setRootVerifyDir(java.lang.String absolute_path)

Specified by:

setRootVerifyDir in interface DriverInterface

See Also:

DriverInterface.setRootVerifyDir(String)

incrementGeneralStatus

public void incrementGeneralStatus(int status)

Increment General (not Test) record counts.

Specified by:

incrementGeneralStatus in interface DriverInterface

Parameters:

status -

See Also:

StatusCodes

incrementTestStatus

public void incrementTestStatus(int status)

Increment Test Record counts.

Specified by:

incrementTestStatus in interface DriverInterface

Parameters:

status -

See Also:

StatusCodes