Package org.safs

Interface Summary
DDGUtilsInterface
Purpose:static DDG utilities, concept taken from SQABasic version
SAFSVersion version of the SAFS package
 

Class Summary
ApplicationMap The Application Map (App Map) provides storage for Objects referencing the Application being tested.
CFDefaultComponent
Purpose: CFDefaultComponent, process a default generic component
Lifetime: instantiated by TestStepProcessor
ComponentFunction
Purpose: abstract ComponentFunction, enforces that the 'process' method be implemented
COMPONENT FUNCTIONS (so far...): CFButton CFCheckBox check Example: T,Frame,rememberPasswordCheckBox,check uncheck Example: TF,Frame,rememberPasswordCheckBox,uncheck CFComboBox selectIndex 1st param: index into the combobox of the item to select Example: T,Frame,nameComboComboBox,selectIndex,2 select/selectTextItem/selectUnverified/selectUnverifiedTextItem 1st param: name of the item to select Example: T,Frame,nameComboComboBox,select,Karen Farrell setTextValue (not sure if this one actually works, does guiObj.setProperty("text", val);) 1st param: name of the item to select Example: T,Frame,nameComboComboBox,selectPartialMatch,Sammy The Fish showlist/hidelist - shows or hides the list Example: T,Frame,nameComboComboBox,showlist CFComponent (Available to nearly all components) click/rightClick Example: T,Frame,radioButtonARadioButton,click closeWindow/restore/minimize/maximize Example: T,Frame,radioButtonARadioButton,restore verifyProperty - verify that a property exists and exactly matches specified value 1st param: property name 2nd param: property value to verify against Example: TW,PlaceOrder,totalPriceLabel,VerifyProperty,text,$19.99 verifyPropertyContains - verify that a property exists and contains specified value 1st param: property name 2nd param: property value to look for containment (substring of actual) Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,text,19 verifyValue - verify that a value exactly matches specified value 1st param: property name 2nd param: property value to verify against Example: TW,PlaceOrder,totalPriceLabel,VerifyValue,$19.99,^variable verifyValueContains - verify that a value contains specified value 1st param: property name 2nd param: property value to look for containment (substring of actual) Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,^variable,$19 clearAppMapCache - clear the cache of testobjects, normally not needed.
DatabaseCommandsHelper
Purpose: DatabaseCommandsHelper, used by DCDriverCommands.
DatabaseUtils
Purpose: Utilities to find a database connection using java.sql.DriverManager; can also getValues.
DCDriverDatabaseCommands
Purpose: DCDriverDatabaseCommands, process a database driver commands
Lifetime: instantiated by DCDriverCommand im
DCDriverFileCommands DCDriverFileCommands, process a file driver commands instantiated by DCDriverCommand
DCDriverFlowCommands
Purpose: DCDriverFlowCommands, process driver flow commands
Lifetime: instantiated by DCDriverCommand im
DCDriverMiscCommands
Purpose: DCDriverMiscCommands, process a miscellaneous driver commands, like pause
Lifetime: instantiated by DCDriverCommand
DCDriverStringCommands Process a string driver commands.
DCDriverTimerCommands Process a timer commands.
DCGUIUtilities Concrete subclass of DDGUIUtilities that provides no real implementation for the handling of GUI components.
DCJavaHook  
DCTestRecordHelper Concrete subclass of TestRecordHelper that provides no additional functionality.
DDGUIUtilities Here we provide the basis for handling Application Maps through the SAFSMAPS service in STAF.
DefaultDDGUtils
Purpose:DDG utilities, concept taken from SQABasic version
Domains  
DriverCommand
Purpose: abstract DriverCommand, enforces that the 'process' method be implemented
DriverCommandProcessor
Purpose: DriverCommandProcessor
Lifetime: instantiated by ProcessRequest
EngineCommandProcessor EngineCommandProcessor for Record Type: 'E' Instantiated by ProcessRequest.
GetText
Purpose: GetText, get text from a resource bundle
Lifetime: must be instantiated before it can be used
GuiChildIterator  
GuiClassData This class is primarily used to open and read in external data files that map class names to supported class types as well as mapping class types to the library supporting the mapped class type.
GuiObjectRecognition Used internally.
Manages and manipulates object recognition string information.
GuiObjectVector This class is intended to maintain critical component recognition information for each level of the application GUI hierarchy represented in a standard component recognition string.
IndependantLog Use reflection for org.safs.Log to do the Log work.
JavaConstant  
JavaHook Generic Java Hook for tool-independent SAFS Engines.
JavaSocketsHook A class to extend the standard JavaHook allowing the integration/control of a "remote" engine controlled via TCP Sockets where STAF is NOT available.
JavaSocketsUtils Constants and utilities used by a JavaSocketsHook and a remote SocketProtocol client.
Log SAFS Debug Log
MatchData This class is used to fill the matches Vector with match data.
PCTree PCTree, used by various testing tool's ProcessContainer, is used to produce consistent recognition strings across all tools.
Processor Abstract Processor, enforces that the 'process' and 'isSupportedRecordType' methods be implemented.
ProcessRequest
Purpose: ProcessRequest does a request when intantiated with a TestRecordData; it acts like a factory which first grabs the request (recordType), then routes it by instantiating the appropriate processor
Lifetime: instantiated by a hook script or some kind of controller.
RobotJHook Description : RobotJ Hook Script *** This class needs to be eliminated with RRobotJHook subclassing 'JavaHook' ***
SAFSStringTokenizer
All Implemented Interfaces: Enumeration
SingletonSTAFHelper
Purpose: a wrapper class for the STAFHandle, includes some common functionality used many places associated with the SAFSVARS and SAFSMAPS; This is the Singleton version.
SocketTestRecordHelper  
STAFHelper
Purpose: a wrapper class for the STAFHandle, includes some common functionality used many places associated with the SAFSVARS and SAFSMAPS
STAFRequester A superclass for objects that will need a reference to a STAFHandle for STAF requests.
StatusCodes
Purpose: holds the status codes (static final int fields)
StringMBTokenizer
All Implemented Interfaces: Enumeration
StringUtils
Purpose: string utilities
TestRecordData
Purpose:TestRecordData: holds key data used by a driver, like step driver.
TestRecordHelper
Purpose:TestRecordHelper: helper class which can populate data in TestRecordData It can be populated from a STAF Variables pool.
TestStepProcessor
Purpose: TestStepProcessor
Lifetime: instantiated by ProcessRequest
Tree
Purpose: generic tree object
 

Exception Summary
SAFSBreakpointException  
SAFSException
Purpose: our user defined application exception used with this package.
SAFSNullPointerException A simple extension stub for Application Object problems
SAFSObjectNotFoundException A simple extension stub for Application Object problems
SAFSObjectRecognitionException A simple extension stub for Application Object problems
SAFSParamException  
SAFSProcessorInitializationException Flags the ommission of proper initialization of a ProcessRequester.
SAFSRegExException A simple extension stub for Application Object problems
SAFSRegExNotFoundException Flags the ommission of support for Regular Expressions needed by StringUtils and other classes.
SAFSRuntimeException
Purpose: our user defined application exception used with this package.
SAFSSTAFRegistrationException A simple extension stub for STAF Registration problems