org.safs.android

Class CFComponentFunctions

java.lang.Object

org.safs.Processor

org.safs.ComponentFunction

org.safs.android.CFComponentFunctions

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

CFCheckBoxFunctions, CFComboBoxFunctions, CFDatePickerFunctions, CFEditTextFunctions, CFListViewFunctions, CFProgressBarFunctions, CFScrollBarFunctions, CFTabControlFunctions, CFTimePickerFunctions, CFViewFunctions

public class CFComponentFunctions
extends ComponentFunction

Superclass of all Droid ComponentFunction processors.

Author:

Carl Nagle

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.ComponentFunction

ComponentFunction.Window

Field Summary

Fields

Modifier and Type	Field and Description
protected SAFSRemoteControl	control
protected DTestRecordHelper	droiddata simple class cast of existing testRecordData
protected java.util.Properties	props
protected STAFHelper	staf
protected boolean	useExplicitTimeout

Fields inherited from class org.safs.ComponentFunction

action, ALTCLICK, ALTLEFTDRAG, altText, ASSIGNPROPERTYVARIABLE, CAPTUREOBJECTDATATOFILE, CAPTUREPROPERTIESTOFILE, CAPTUREPROPERTYTOFILE, CLEARAPPMAPCACHE, CLICK, CLOSEWINDOW, compName, COMPONENTCLICK, CTRLALTLEFTDRAG, CTRLCLICK, CTRLLEFTDRAG, CTRLRIGHTCLICK, CTRLSHIFTLEFTDRAG, DOUBLECLICK, GETGUIIMAGE, GETTEXTFROMGUI, GUIDOESEXIST, GUIDOESNOTEXIST, HOVERMOUSE, HSCROLLTO, INPUTCHARACTERS, INPUTKEYS, ISPROPERTYEXIST, iterator, LEFTDRAG, LOCATESCREENIMAGE, mapname, MAXIMIZE, MINIMIZE, MOUSECLICK, OBJECT_DATA, PARAM_FILTER, PARAM_UUID, PROPERTY_DOT_itemText, PROPERTY_innerHTML, PROPERTY_innerText, PROPERTY_Items, PROPERTY_text, PROPERTY_textContent, RELATIVE_TO_PARENT, RELATIVE_TO_SCREEN, RESTORE, RIGHTCLICK, RIGHTDRAG, SAVETEXTFROMGUI, SELECTMENUITEM, SELECTMENUITEMCONTAINS, SENDEVENT, SETPOSITION, SETPROPERTYVALUE, SHIFTCLICK, SHIFTLEFTDRAG, TEST_DATA_SUFFIX, utils, VERIFYARRAYPROPERTYTOFILE, VERIFYBINARYFILETOFILE, VERIFYCLIPBOARDTOFILE, VERIFYFILETOFILE, VERIFYGUIIMAGETOFILE, VERIFYMENUITEM, VERIFYMENUITEMCONTAINS, VERIFYOBJECTDATATOFILE, VERIFYPROPERTY, VERIFYPROPERTYCONTAINS, VERIFYPROPERTYTOFILE, VERIFYTEXTFILETOFILE, VERIFYVALUECONTAINS, VERIFYVALUEEQUALS, VERIFYVALUES, VERIFYVALUESIGNORECASE, VSCROLLTO, WAITFORGUI, windowName

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
CFComponentFunctions()

Method Summary

Modifier and Type	Method and Description
protected CFComponentFunctions	getProcessorInstance(java.lang.String target)
protected void	logResourceMessageFailure() Log a FAILED_MESSAGE using whatever ResourceMessageInfo data is returned in droiddata.
protected void	processCommand() All action props should have already been completed during setTestRecordData(org.safs.TestRecordHelper) and DTestStepProcessor.interpretFields()
protected void	processProperties(int param_timeout) process the completed remote control action properties.
protected boolean	processResourceMessageInfoResults(int msgType)
protected void	processResults(RemoteResults results) called internally by processProperties(int) AFTER the remote execution has completed.
protected void	setSuccessResourceMessageInfo(ResourceMessageInfo detailMessage) Set generic success message to TestRecordData After calling this method, we need to call processResourceMessageInfoResults(int) to write message to Log.
void	setTestRecordData(TestRecordHelper data) Transfers all DTestRecordHelper data into the receiving Processor.

Methods inherited from class org.safs.ComponentFunction

_close, _maximize, _minimize, _restore, _setPosition, _setSize, action_ComputedStyle, action_getGuiImage, action_GetSaveTextFromGUI, action_showOnPage, action_verifyGuiImageToFile, assignPropertyVariable, captureObjectData, captureObjectDataToFile, capturePropertiesToFile, capturePropertyToFile, checkForCoord, checkForCoord, clearAppMapCache, clearCache, close, closeWindow, componentClick, componentExecutedFailureMessage, componentFailureMessage, componentProcess, componentSuccessMessage, convertCoords, convertLine, convertNum, convertWindowPosition, ConvertWindowPosition, deduceImageRect, dragTo, executeScript, exist, getAlternateParams, getComponentRectangle, getComponentRectangleOnScreen, getHelpers, getHelpersWorker, getPossibleMapItem, getProperties, getProperty, getPropertyCollection, getPropertyCollection, getPropertyObject, getRectangleImage, getStringValue, getUUIDBoolean, getWindowRectangleOnScreen, guiDoesExist, hoverMouse, hoverScreenLocation, inputKeystrokes, isPropertyExist, issueFileErrorFailure, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issuePassedSuccessUsing, issueUnknownErrorFailure, isSupportedRecordType, locateScreenImage, lookupAppMapCoordReference, lookupAppMapLineReference, lookupAppMapNumReference, lookupAppMapReference, maximize, minimize, normalizeFileEncoding, normalizePropertyCollection, performDrag, performHoverMouse, performScorll, restore, selectMenuItem, sendEvent, setIterator, setPosition, setPropertyValue, setRectVars, showComponentAsMuchPossible, updateFromTestRecordData, verifyClipboardToFile, verifyFileToFile, verifyMenuItem, verifyObjectDataToFile, verifyPropertiesToFile, verifyProperty, verifyPropertyContains, verifyPropertyToFile, verifyValueContains, verifyValues, waitForGUI, waitForObject

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, process, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

droiddata

protected DTestRecordHelper droiddata

simple class cast of existing testRecordData

props

protected java.util.Properties props

control

protected SAFSRemoteControl control

staf

protected STAFHelper staf

useExplicitTimeout

protected boolean useExplicitTimeout

Constructor Detail

CFComponentFunctions

public CFComponentFunctions()

Method Detail

setTestRecordData

public void setTestRecordData(TestRecordHelper data)

Transfers all DTestRecordHelper data into the receiving Processor. This includes droiddata, utils, staf, props, control, action, windowName, compName, and mapname.

Overrides:

setTestRecordData in class Processor

processCommand

protected void processCommand()
                       throws java.lang.IllegalThreadStateException,
                              RemoteException,
                              java.util.concurrent.TimeoutException,
                              ShutdownInvocationException

All action props should have already been completed during setTestRecordData(org.safs.TestRecordHelper) and DTestStepProcessor.interpretFields()

Sets KEY_TARGET to SAFSMessage.target_safs_comprouting in the Properties to be remotely processed.

Throws:

java.util.concurrent.TimeoutException - if the Ready, Running, or Results signals timeout.

java.lang.IllegalThreadStateException - if sockets communications failed.

ShutdownInvocationException - if sockets communication signals a shutdown has commenced.

RemoteException - if the remote client has issued an Exception.

processProperties

protected void processProperties(int param_timeout)
                          throws java.lang.IllegalThreadStateException,
                                 RemoteException,
                                 java.util.concurrent.TimeoutException,
                                 ShutdownInvocationException

process the completed remote control action properties. This method is called internally by processCommand(). After returning from remote processing the routine updates the droiddata via DUtilities.captureRemoteResultsProperties(RemoteResults, DTestRecordHelper). This routine then calls processResults(RemoteResults) if results.isRemoteResult() is true.

Throws:

java.util.concurrent.TimeoutException - if the Ready, Running, or Results signals timeout.

java.lang.IllegalThreadStateException - if sockets communications failed.

ShutdownInvocationException - if sockets communication signals a shutdown has commenced.

RemoteException - if the remote client has issued an Exception.

See Also:

DUtilities.captureRemoteResultsProperties(RemoteResults, DTestRecordHelper)

getProcessorInstance

protected CFComponentFunctions getProcessorInstance(java.lang.String target)

processResults

protected void processResults(RemoteResults results)

called internally by processProperties(int) AFTER the remote execution has completed. The routine routes to other CF Function libraries based on the KEY_TARGET returned by the remote execution.

processResourceMessageInfoResults

protected boolean processResourceMessageInfoResults(int msgType)

Parameters:

msgType - -- int message type identifier constant as defined in AbstractLogFacility.

Returns:

true if we did find and handle a ResoureMessageInfo result.

logResourceMessageFailure

protected void logResourceMessageFailure()

Log a FAILED_MESSAGE using whatever ResourceMessageInfo data is returned in droiddata. Calls processResourceMessageInfoResults(int) to attempt the logging. If there was no ResourceMessageInfo, we still log a generic failed message via Processor.issueActionFailure(String).

setSuccessResourceMessageInfo

protected void setSuccessResourceMessageInfo(ResourceMessageInfo detailMessage)

Set generic success message to TestRecordData
After calling this method, we need to call processResourceMessageInfoResults(int) to
write message to Log.

Parameters:

detailMessage - ResourceMessageInfo the detail success message to set to TestRecordData

See Also:

processResourceMessageInfoResults(int)