org.safs.android.engine.processor

Class SAFSProcessor

java.lang.Object

com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

org.safs.android.engine.processor.SAFSProcessor

All Implemented Interfaces:

ProcessorInterface

Direct Known Subclasses:

DriverProcessor, EngineProcessor, TestStepProcessor

public class SAFSProcessor
extends AbstractProcessor

Author:

Carl Nagle, SAS Institute, Inc

26 APR, 2012 (LeiWang) Add 2 methods to return the embedded Solo object and Instrumentation object.
07 FEB, 2013 (LeiWang) Move initialization of DGuiClassData to method DSAFSTestRunner.beforeStart().
19 APR, 2013 (LeiWang) Add cache to store testObject by windowName and componentName.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	command_timeout
protected static java.lang.String	compname
protected static java.lang.Object	compobj
protected static java.lang.String	comprec
protected static DGuiClassData	dgcd
protected static DGuiObjectVector	dgov
protected android.app.Instrumentation	inst ints is the Instrumentation object embedded in testrunner it will be used to do the real automation work Instrumentation object is provided by Android
protected static java.lang.String	KEY_COMPOBJ KEY used in the Properties object passed between processors.
protected java.util.Collection<java.lang.String>	params params contain the parameters of the keyword to be processed
protected ResourceMessageInfo	resourceDetailMsg resourceMsg is used to contain information of NLS detail message in resource bundle
protected ResourceMessageInfo	resourceMsg resourceMsg is used to contain information of NLS message in resource bundle
protected SAFSRobot	robot
protected static int	secsWaitForComponent
protected static int	secsWaitForWindow
protected com.robotium.solo.Solo	solo solo is the Solo object embedded in testrunner it will be used to do the real automation work Solo object is provided by Robotium
static java.lang.String	TAG
protected static java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.Object>>	testObjectCache local cache for containing the test objects.
protected DSAFSTestRunner	testrunner A 2nd field of superClass testRunner cast here to type DSAFSTestRunner for convenience.
protected static java.lang.String	winname
protected static java.lang.Object	winobj
protected static java.lang.String	winrec

Fields inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

INITIAL_CACHE_SIZE, remoteCommand, testRunner

Constructor Summary

Constructors

Constructor and Description
SAFSProcessor(DSAFSTestRunner testrunner)

Method Summary

Modifier and Type	Method and Description
void	clearTestObjectCache()
protected boolean	extractComponentProperties(java.util.Properties props) Load our local component name and recognition static fields with the property string values from:
static DGuiClassData	getDgcd()
android.app.Instrumentation	getInstrumentation() The field testrunner is the Instrumentation object. The Instrumentation object can be used to do the automation directly on Android GUI object.
java.util.Collection<java.lang.String>	getParams()
static int	getSecsWaitForComponent()
static int	getSecsWaitForWindow()
com.robotium.solo.Solo	getSolo() Return the Solo object contained in testrunner Attention: Only after the method RobotiumTestRunner.launchApplication() has been called, the Solo object can be initialized. Before, the Solo object is null.
java.lang.Object	getTestObject(java.lang.String windowName, java.lang.String componentName) According to windowName and componentName, try to get the testObject from the cache.
static void	setDgcd(DGuiClassData dgcd)
protected void	setGeneralErrorWithBundleMessage(java.util.Properties props, ResourceMessageInfo message, ResourceMessageInfo detailMessage) set the isremoteresult to "true" set the remoteresultcode to a constant code Message.STATUS_REMOTERESULT_FAIL_STRING Note: This method will concatenate AbstractProcessor.remoteCommand with 'resultInfo', then with SoloMessage.RESULT_INFO_GENERAL_FAIL and set this string to remoteresultinfo set the 'resource bundle information', so that the remote-controller can log NLS message.
protected void	setGeneralSuccessWithBundleMessage(java.util.Properties props, ResourceMessageInfo message, ResourceMessageInfo detailMessage) set the isremoteresult to "true" set the remoteresultcode to a constant code Message.STATUS_REMOTERESULT_OK_STRING Note: This method will concatenate AbstractProcessor.remoteCommand with SoloMessage.RESULT_INFO_GENERAL_SUCCESS and set this string to remoteresultinfo set the 'resource bundle information', so that the remote-controller can log NLS message.
void	setParams(java.util.Collection<java.lang.String> params)
static void	setSecsWaitForComponent(int secsWaitForComponent)
static void	setSecsWaitForWindow(int secsWaitForWindow)
void	setSolo(com.robotium.solo.Solo solo) Set the Solo object to be used for processing.
java.lang.Object	setTestObject(java.lang.String windowName, java.lang.String componentName, java.lang.Object testobject) According to windowName and componentName, set the testObject to the cache.

Methods inherited from class com.jayway.android.robotium.remotecontrol.client.processor.AbstractProcessor

convertToKey, convertToKeys, convertToKeys, debug, getCachedItem, getStackTrace, makeUniqueCacheKey, processMessage, processProperties, putCachedItem, removeCachedItem, resetExternalModeCache, setGeneralError, setGeneralError, setGeneralErrorWithSpecialInfo, setGeneralErrorWithSpecialInfo, setGeneralSuccess, setGeneralSuccess, setGeneralSuccessWithSpecialInfo, setGeneralWarningWithSpecialInfo, setRemoteCommand, stringIsMatched

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static java.lang.String TAG

testrunner

protected DSAFSTestRunner testrunner

A 2nd field of superClass testRunner cast here to type DSAFSTestRunner for convenience.

robot

protected SAFSRobot robot

KEY_COMPOBJ

protected static final java.lang.String KEY_COMPOBJ

KEY used in the Properties object passed between processors. If this KEY exists in the Properties object then chained processors know the first processor has already completed the component search and it does NOT need to be done again.

See Also:

Constant Field Values

testObjectCache

protected static java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.Object>> testObjectCache

local cache for containing the test objects. This cache contains pairs as > Note: Don't manipulate it directly like testObjectCache.get(key) etc.
Use the cache-manipulation-methods defined in AbstractProcessor

See Also:

AbstractProcessor.getCachedItem(Hashtable, Object), AbstractProcessor.removeCachedItem(Hashtable, Object), AbstractProcessor.putCachedItem(Hashtable, Object, Object)

secsWaitForWindow

protected static int secsWaitForWindow

secsWaitForComponent

protected static int secsWaitForComponent

command_timeout

protected static int command_timeout

winobj

protected static java.lang.Object winobj

compobj

protected static java.lang.Object compobj

winname

protected static java.lang.String winname

compname

protected static java.lang.String compname

winrec

protected static java.lang.String winrec

comprec

protected static java.lang.String comprec

dgov

protected static DGuiObjectVector dgov

dgcd

protected static DGuiClassData dgcd

solo

protected com.robotium.solo.Solo solo

solo is the Solo object embedded in testrunner it will be used to do the real automation work Solo object is provided by Robotium

inst

protected android.app.Instrumentation inst

ints is the Instrumentation object embedded in testrunner it will be used to do the real automation work Instrumentation object is provided by Android

params

protected java.util.Collection<java.lang.String> params

params contain the parameters of the keyword to be processed

resourceMsg

protected ResourceMessageInfo resourceMsg

resourceMsg is used to contain information of NLS message in resource bundle

See Also:

#setGeneralErrorWithBundleMessage(java.util.Properties, ResourceMessageInfo, ResourceMessageInfo)}
, #setGeneralSuccessWithBundleMessage(java.util.Properties, ResourceMessageInfo, ResourceMessageInfo)}


resourceDetailMsg

protected ResourceMessageInfo resourceDetailMsg

resourceMsg is used to contain information of NLS detail message in resource bundle

See Also:

#setGeneralErrorWithBundleMessage(java.util.Properties, ResourceMessageInfo, ResourceMessageInfo)}
, #setGeneralSuccessWithBundleMessage(java.util.Properties, ResourceMessageInfo, ResourceMessageInfo)}


Constructor Detail

SAFSProcessor

public SAFSProcessor(DSAFSTestRunner testrunner)

Method Detail

getTestObject

public java.lang.Object getTestObject(java.lang.String windowName,
                                      java.lang.String componentName)

According to windowName and componentName, try to get the testObject
from the cache. null will be return if no testObject can be found.

setTestObject

public java.lang.Object setTestObject(java.lang.String windowName,
                                      java.lang.String componentName,
                                      java.lang.Object testobject)

According to windowName and componentName, set the testObject to
the cache.

clearTestObjectCache

public void clearTestObjectCache()

getParams

public java.util.Collection<java.lang.String> getParams()

setParams

public void setParams(java.util.Collection<java.lang.String> params)

getSecsWaitForWindow

public static int getSecsWaitForWindow()

Returns:

the secsWaitForWindow

setSecsWaitForWindow

public static void setSecsWaitForWindow(int secsWaitForWindow)

Parameters:

secsWaitForWindow - the secsWaitForWindow to set (in seconds)

getSecsWaitForComponent

public static int getSecsWaitForComponent()

Returns:

the secsWaitForComponent

setSecsWaitForComponent

public static void setSecsWaitForComponent(int secsWaitForComponent)

Parameters:

secsWaitForComponent - the secsWaitForComponent to set (in seconds)

extractComponentProperties

protected boolean extractComponentProperties(java.util.Properties props)

Load our local component name and recognition static fields with the property string values from:

winname = KEY_WINNAME,
compname = KEY_COMPNAME,
winrec = KEY_WINREC,
comprec = KEY_COMPREC,
command_timeout = PARAM_TIMEOUT

Parameters:

props -

Returns:

true if all were retrievable. If any were not present (except command_timeout) then the routine will set appropriate resourceMsg values and setGeneralErrorWithBundleMessage(Properties, ResourceMessageInfo, ResourceMessageInfo) and return false.

getDgcd

public static DGuiClassData getDgcd()

setDgcd

public static void setDgcd(DGuiClassData dgcd)

getSolo

public com.robotium.solo.Solo getSolo()

Return the Solo object contained in testrunner
Attention:
Only after the method RobotiumTestRunner.launchApplication() has been
called, the Solo object can be initialized.
Before, the Solo object is null.

Returns:

Solo object or null if the Solo object is not ready.

See Also:

RobotiumTestRunner.launchApplication()

setSolo

public void setSolo(com.robotium.solo.Solo solo)

Set the Solo object to be used for processing. This is generally only set by other processors already having retrieved it.

Parameters:

solo -

getInstrumentation

public android.app.Instrumentation getInstrumentation()

The field testrunner is the Instrumentation object.
The Instrumentation object can be used to do the automation directly on Android GUI object.

Returns:

Instrumentation object.

setGeneralSuccessWithBundleMessage

protected void setGeneralSuccessWithBundleMessage(java.util.Properties props,
                                                  ResourceMessageInfo message,
                                                  ResourceMessageInfo detailMessage)

set the isremoteresult to "true"
set the remoteresultcode to a constant code Message.STATUS_REMOTERESULT_OK_STRING
Note: This method will concatenate AbstractProcessor.remoteCommand with
SoloMessage.RESULT_INFO_GENERAL_SUCCESS
and set this string to remoteresultinfo
set the 'resource bundle information', so that the remote-controller can log NLS message.

Parameters:

props - The Properties object containing the in and out parameters

message - ResourceMessageInfo, information about the resource bundle message

detailMessage - ResourceMessageInfo, information about the resource bundle detail message

See Also:

#setResourceBundleInformation(Properties, ResourceMessageInfo, ResourceMessageInfo))

setGeneralErrorWithBundleMessage

protected void setGeneralErrorWithBundleMessage(java.util.Properties props,
                                                ResourceMessageInfo message,
                                                ResourceMessageInfo detailMessage)

set the isremoteresult to "true"
set the remoteresultcode to a constant code Message.STATUS_REMOTERESULT_FAIL_STRING
Note: This method will concatenate AbstractProcessor.remoteCommand with 'resultInfo', then with
SoloMessage.RESULT_INFO_GENERAL_FAIL
and set this string to remoteresultinfo
set the 'resource bundle information', so that the remote-controller can log NLS message.

Parameters:

props - The Properties object containing the in and out parameters

message - ResourceMessageInfo, information about the resource bundle message

detailMessage - ResourceMessageInfo, information about the resource bundle detail message

See Also:

#setResourceBundleInformation(Properties, ResourceMessageInfo, ResourceMessageInfo))