STAFLocalServer (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
- - org.safs.jvmagent.STAFLocalServer

All Implemented Interfaces:

LocalAgent, LocalServer, ConfigurableToolsInterface, GenericToolsInterface
```
public class STAFLocalServer
extends DriverConfiguredSTAFInterfaceClass
implements LocalServer
```
Author:

Carl Nagle Provides a concrete implementation of a LocalServer using STAF communication to running SAFS engines. This is NOT limited to Java implementations of engines. JUL 28 2008 JunwuMa Added method hightLightMatchingChildObject. The engine command is already supported in RJ. See org.safs.EngineCommandProcessor NOV 7 2008 JunwuMa Modify the returning type of method highlightMatchingChildObject(), setting it to boolean. NOV 27 2008 JunwuMa Add methods getAccessibleName and getNonAccessibleName. AUG 6 2009 JunwuMa Add method enableDomains() for sending engine command 'enableDomains'. OCT 20 2009 JunwuMa Add method getMatchingChildKeysAtPoint(). OCT 27 2009 JunwuMa Add method highlightMatchingChildObjectByKey(). NOV 02 2010 LeiWang Add method getComponentRectangle(): Help to implement the "Map JPG" function of SPC. FEB 11 2011 Dharmesh4 Added method isTopLevelPopupContainer. MAY 25,2011 Dharmesh4 Added getClassIndex and getDomainName methods. MAR 16 2012 JunwuMa Add getObjectRecognitionAtScreenCoords(x, y) to call corresponding engine command.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`RTYPE` 'E'
`(package private) static java.lang.String[]`	`SEPS` Array of posibbl separators: "," "\|" ":" ";" "_" "#" "!"
`(package private) STAFProcessContainerHelper`	`trd`

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Constructor Summary

Constructors
Constructor and Description

STAFLocalServer()

Constructors
Constructor and Description
`STAFLocalServer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`clearHighlightedDialog()`
`void`	`enableDomains(java.lang.String domains)`
`java.lang.String`	`getAccessibleName(java.lang.Object object)` Retrieve the accessible name of the object if the object is named.
`java.lang.String`	`getCaption(java.lang.Object object)` Retrieve the Caption of the object if one exits.
`int`	`getChildCount(java.lang.Object parent)` Return the number of children available in the provided STAFProcessContainerResult parent.
`java.lang.Object[]`	`getChildren(java.lang.Object parent)` Return an array representing the children of the provided parent object.
`java.lang.String`	`getClassIndex(java.lang.Object object)` Retrieve the ClassIndex of the object if the object has an ClassIndex
`java.lang.String`	`getClassName(java.lang.Object object)` Return the Class name of the object.
`java.awt.Rectangle`	`getComponentRectangle(java.lang.Object winkey)`
`java.lang.String`	`getDomainName(java.lang.Object object)` Retrive the domain name of the object
`java.lang.String`	`getID(java.lang.Object object)` Retrieve the ID of the object if the object has an ID.
`int`	`getLevel(java.lang.Object object)` Return the Z-Order level of the object (generally for a top level window).
`java.lang.Object[]`	`getMatchingChildKeysAtPoint(java.lang.Object parentkey, int x, int y)`
`java.lang.Object[]`	`getMatchingChildObjects(java.lang.Object parent, java.lang.String childRec)` Engine will attempt to locate a child object matching the provided recognition string.
`java.lang.Object`	`getMatchingParentObject(java.lang.String winRec)` Engines will attempt to locate a top-level window object matching the provided recognition string.
`java.lang.Object`	`getMatchingPathObject(java.lang.Object parent, java.lang.String path)` Mechanism to retrieve a subitem/object identified by the provided Path.
`java.lang.String`	`getName(java.lang.Object object)` Retrieve the name of the object if the object is named.
`java.lang.String`	`getNonAccessibleName(java.lang.Object object)` Retrieve the name (not including accessible name) of the object if the object is named.
`java.lang.String`	`getObjectRecognitionAtScreenCoords(int x, int y)`
`java.lang.String`	`getProperty(java.lang.Object object, java.lang.String property)` Retrieve the property value of the object if the object has the property.
`java.lang.String[]`	`getPropertyNames(java.lang.Object object)` The array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields.
`java.lang.String[][]`	`getStringData(java.lang.Object object, java.lang.Object dataInfo)` Currently returns an empty 2D array.
`java.lang.String[]`	`getSuperClassNames(java.lang.Object object)` The array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields.
`java.lang.String`	`getText(java.lang.Object object)` Retrieve the displayed text value of the object if the object has a text value.
`int`	`getTopLevelCount()` Return the number of currently active Top Level Windows from all known engines.
`java.lang.Object[]`	`getTopLevelWindows()` Return an array representing the TopLevel windows from all known engines.
`long`	`getTopWindowHandle(java.lang.Object key)`
`static java.lang.String`	`getUniqueSeparator(java.lang.String afield)` Return a usable single character separator string that does NOT exist in the provided field.
`boolean`	`highlightMatchingChildObject(java.lang.String winRec, java.lang.String ChildRec)` Engine will try to locate/highlight a window object matching the provided recognition string (ChildRec) under the top-most window with R-String (winRec).
`boolean`	`highlightMatchingChildObjectByKey(java.lang.Object winkey, java.lang.Object compkey, java.lang.String rstring)` Engine will try to locate/highlight a window object by its key to the cached object It is supported by RJ.
`boolean`	`isMatchingPath(java.lang.Object theObject, java.lang.String thePath)` Currently always returns 'false'.
`boolean`	`isShowing(java.lang.Object object)` Return true if the object is showing/visible.
`boolean`	`isToolRunning()` Superclass implementation checks for a service.
`boolean`	`isTopLevelPopupContainer(java.lang.Object object)` Return true if the object is PopupWindow Container, Some Java Frames and\or JFrames can contain a JPopup in a child panel instead of an "owned" window.
`boolean`	`isValid(java.lang.Object object)` Return true if the object is still valid/finadable in the JVM.
`void`	`launchInterface(java.lang.Object configInfo)` Generic extraction of Driver, Config, and STAFHelper objects.
`TestRecordData`	`process(java.lang.Object object, TestRecordData testRecordData)` Currently returns TestRecordData unmodified.
`protected long`	`processCommand(STAFProcessContainerHelper trd, boolean allEngines)` Route the input record to available engines.
`protected java.lang.String`	`processStringMethod(java.lang.Object object, java.lang.String command)` Generic routine to execute an engine command that takes no parameters and is only to be executed by the specific EngineInterface stored in the STAFProcessContainerResult.
`void`	`reset()` Reset or clear any cached information in the underlying tool or service.
`protected long`	`routeToEngines(STAFProcessContainerHelper trd, boolean allEngines)` This command is normally only called internally by processCommand.
`protected long`	`routeToPreferredEngines(STAFProcessContainerHelper trd, boolean allEngines)` This command is normally only called internally by processCommand.
`void`	`setActiveWindow(java.lang.Object anObject)` Attempts to set anObject as the active (topmost?) Window or Component.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RTYPE
```
public static final java.lang.String RTYPE
```
    'E'
    
    See Also:
    
    Constant Field Values
  - trd
```
STAFProcessContainerHelper trd
```
  - SEPS
```
static final java.lang.String[] SEPS
```
    Array of posibbl separators: "," "|" ":" ";" "_" "#" "!"
- Constructor Detail
  - STAFLocalServer
```
public STAFLocalServer()
```
- Method Detail
  - launchInterface
```
public void launchInterface(java.lang.Object configInfo)
```
    Description copied from class: DriverConfiguredSTAFInterfaceClass
    
    Generic extraction of Driver, Config, and STAFHelper objects. Each concrete subclass must override to provide their own specific interface initialization, but they must call this routine before proceeding with their own launch activities using:
    super.launchInterface(configInfo);
    popuplates the driver, processName, config, and staf fields with valid objects. These items are properly unregistered/destroyed in the finalize() method.
    
    Specified by:
    
    launchInterface in interface ConfigurableToolsInterface
    
    Overrides:
    
    launchInterface in class DriverConfiguredSTAFInterfaceClass
    
    Parameters:
    
    configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.
    
    See Also:
    
    DriverConfiguredSTAFInterfaceClass.launchInterface(Object)
  - isToolRunning
```
public boolean isToolRunning()
```
    Superclass implementation checks for a service. We are not a service. We always return 'true'.
    
    Specified by:
    
    isToolRunning in interface GenericToolsInterface
    
    Overrides:
    
    isToolRunning in class DriverConfiguredSTAFInterfaceClass
    
    See Also:
    
    DriverConfiguredSTAFInterfaceClass.isToolRunning()
  - processStringMethod
```
protected java.lang.String processStringMethod(java.lang.Object object,
                                               java.lang.String command)
```
    Generic routine to execute an engine command that takes no parameters and is only to be executed by the specific EngineInterface stored in the STAFProcessContainerResult.
    
    Parameters:
    
    object - STAFProcessContainerResult object identifying one engine and component.
    
    command - String engine command to execute.
    
    Returns:
    
    trd.statusInfo returned from engine. May be null. DriverConstant.SAFS_NULL will be converted to a null value.
    
    See Also:
    
    DriverConstant.SAFS_NULL
  - isTopLevelPopupContainer
```
public boolean isTopLevelPopupContainer(java.lang.Object object)
```
    Return true if the object is PopupWindow Container, Some Java Frames and\or JFrames can contain a JPopup in a child panel instead of an "owned" window.
    
    Parameters:
    
    object - An object for to check PopupWindow.
    
    Returns:
    
    boolean true if PopupWindow found or false.
  - enableDomains
```
public void enableDomains(java.lang.String domains)
```
  - getTopLevelCount
```
public int getTopLevelCount()
```
    Return the number of currently active Top Level Windows from all known engines.
    
    Specified by:
    
    getTopLevelCount in interface LocalServer
  - getTopLevelWindows
```
public java.lang.Object[] getTopLevelWindows()
```
    Return an array representing the TopLevel windows from all known engines. Each engine's array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields. The first character in the String will identify the separator used between fields. The fields will be converted to a String array by this routine.
    
    Specified by:
    
    getTopLevelWindows in interface LocalServer
    
    Returns:
    
    Object[] (STAFProcessContainerResult objects)representing all active top level windows from all known engines. A zero-length Object[] array will be returned if no Top Level Windows are active.
  - setActiveWindow
```
public void setActiveWindow(java.lang.Object anObject)
```
    Attempts to set anObject as the active (topmost?) Window or Component.
    
    Specified by:
    
    setActiveWindow in interface LocalServer
    
    Parameters:
    
    anObject - STAFProcessContainerResult provided by the engine identifying the object.
  - getChildCount
```
public int getChildCount(java.lang.Object parent)
```
    Return the number of children available in the provided STAFProcessContainerResult parent.
    
    Specified by:
    
    getChildCount in interface LocalAgent
  - getChildren
```
public java.lang.Object[] getChildren(java.lang.Object parent)
```
    Return an array representing the children of the provided parent object. The array of objects returned by the engine will be stored in the trd.getStatusInfo() as a delimited array of fields. The first character in the String will identify the separator used between fields. The children will be converted to an Object[] of STAFProcessContainerResult objects by this routine.
    
    Specified by:
    
    getChildren in interface LocalAgent
    
    Parameters:
    
    parent - A STAFProcessContainerResult object from getTopLevelWindows or from a previous call to getChildren. The parent is often one of the elements of the TopLevelWindow array or somewhere lower in that same hierarchy.
    
    Returns:
    
    Object[] (STAFProcessContainerResult objects) representing all known children of the provided parent. A zero-length Object[] array will be returned if the parent has no children.
  - getCaption
```
public java.lang.String getCaption(java.lang.Object object)
```
    Retrieve the Caption of the object if one exits.
    
    Specified by:
    
    getCaption in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the caption of the object or an empty String. Null is possible.
  - getAccessibleName
```
public java.lang.String getAccessibleName(java.lang.Object object)
```
    Retrieve the accessible name of the object if the object is named.
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the name of the object.
  - getNonAccessibleName
```
public java.lang.String getNonAccessibleName(java.lang.Object object)
```
    Retrieve the name (not including accessible name) of the object if the object is named.
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the name of the object.
  - getName
```
public java.lang.String getName(java.lang.Object object)
```
    Retrieve the name of the object if the object is named.
    
    Specified by:
    
    getName in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the name of the object.
  - getID
```
public java.lang.String getID(java.lang.Object object)
```
    Retrieve the ID of the object if the object has an ID.
    
    Specified by:
    
    getID in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the ID of the object.
  - getText
```
public java.lang.String getText(java.lang.Object object)
```
    Retrieve the displayed text value of the object if the object has a text value.
    
    Specified by:
    
    getText in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the text value of the object. Since text values can theoretically legally be zero-length, a null value will be returned if no value exists for the object.
  - getPropertyNames
```
public java.lang.String[] getPropertyNames(java.lang.Object object)
```
    The array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields. The first character in the String will identify the separator used between fields. The fields will be converted to a String array by this routine. A zero-length array will be returned if the parent has no children.
    
    Specified by:
    
    getPropertyNames in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String[] the names of available properties.
  - getClassIndex
```
public java.lang.String getClassIndex(java.lang.Object object)
```
    Retrieve the ClassIndex of the object if the object has an ClassIndex
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String the ClassIndex of the object.
  - getDomainName
```
public java.lang.String getDomainName(java.lang.Object object)
```
    Retrive the domain name of the object
    
    Parameters:
    
    object - An object from getTopLevelWindows or from the a previous call to getChildren
    
    Returns:
    
    String the Domain name of the object.
  - getProperty
```
public java.lang.String getProperty(java.lang.Object object,
                                    java.lang.String property)
```
    Retrieve the property value of the object if the object has the property.
    
    Specified by:
    
    getProperty in interface LocalAgent
    
    Parameters:
    
    object - -- An object from getTopLevelWindows or from a previous call to getChildren.
    
    property - -- the case-sensitive name of the property to seek.
    
    Returns:
    
    String the text value of the object property. Since property values can theoretically legally be zero-length, a null value will be returned if no value exists for the object.
  - getClassName
```
public java.lang.String getClassName(java.lang.Object object)
```
    Return the Class name of the object. For example, we may get "javax.swing.JFrame" or the name of the subclass if it is a subclass of JFrame.
    
    Specified by:
    
    getClassName in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String Class name of the object.
  - getLevel
```
public int getLevel(java.lang.Object object)
```
    Return the Z-Order level of the object (generally for a top level window).
    
    Specified by:
    
    getLevel in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    int z-order value of the object among all objects if this can be determined. 0 normally indicates the topmost Window. 1 is normally the Window behind that, etc..
  - isShowing
```
public boolean isShowing(java.lang.Object object)
```
    Return true if the object is showing/visible.
    
    Specified by:
    
    isShowing in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    boolean true if the object is showing/visible.
  - isValid
```
public boolean isValid(java.lang.Object object)
```
    Return true if the object is still valid/finadable in the JVM.
    
    Specified by:
    
    isValid in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    boolean true if the object is still valid/findable.
  - getSuperClassNames
```
public java.lang.String[] getSuperClassNames(java.lang.Object object)
```
    The array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields. The first character in the String will identify the separator used between fields. The fields will be converted to a String array by this routine. A zero-length array will be returned if the parent has no children.
    
    Specified by:
    
    getSuperClassNames in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    Returns:
    
    String[] Class names for the superclass hierarchy.
  - getMatchingPathObject
```
public java.lang.Object getMatchingPathObject(java.lang.Object parent,
                                              java.lang.String path)
```
    Mechanism to retrieve a subitem/object identified by the provided Path. Path is hierarchical information showing parent->child relationships separated by '->'. This is often used in Menus and Trees.
    Ex:
    File->Exit
    Root->Branch->Leaf
    
    Specified by:
    
    getMatchingPathObject in interface LocalAgent
    
    Parameters:
    
    theObject--STAFProcessContainerResult - object for the object to be evaluated.
    
    thePath - information to locate another object or subitem relative to theObject. this is usually something like a menuitem or tree node where supported.
    
    Returns:
    
    Object STAFProcessContainerResult object found relative to theObject or null.
  - getMatchingChildKeysAtPoint
```
public java.lang.Object[] getMatchingChildKeysAtPoint(java.lang.Object parentkey,
                                                      int x,
                                                      int y)
```
    Parameters:
    
    parentkey, - a String as the key to the cached object in Engine.
    
    x -
    
    y -
    
    Returns:
    
    an array that holds every unique key of matching objects
  - isMatchingPath
```
public boolean isMatchingPath(java.lang.Object theObject,
                              java.lang.String thePath)
                       throws java.lang.Exception
```
    Currently always returns 'false'.
    
    Specified by:
    
    isMatchingPath in interface LocalAgent
    
    thePath - information to locate another object or subitem relative to theObject. this is usually something like a menuitem or tree node where supported.
    
    Returns:
    
    true if the child sub-object was found relative to theObject.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    LocalAgent.isMatchingPath(java.lang.Object, java.lang.String)
  - getStringData
```
public java.lang.String[][] getStringData(java.lang.Object object,
                                          java.lang.Object dataInfo)
```
    Currently returns an empty 2D array.
    
    Specified by:
    
    getStringData in interface LocalAgent
    
    Parameters:
    
    object - An object from getTopLevelWindows or from a previous call to getChildren.
    
    dataInfo - Allows us to specify what type of data we want returned. This will be specific to the types of objects from which we extract data. For example, Tables might provide "Contents" or "Headers" or other different types of data. This dataInfo is usually provided as a String value.
    
    Returns:
    
    String[][] 2D array of extracted data. 0-length arrays if no data is available or the ability to extract data is not supported.
    
    See Also:
    
    LocalAgent.getStringData(java.lang.Object, java.lang.Object)
  - process
```
public TestRecordData process(java.lang.Object object,
                              TestRecordData testRecordData)
```
    Currently returns TestRecordData unmodified.
    
    Specified by:
    
    process in interface LocalAgent
    
    testRecordData - provides all the information needed by the Agent to perform the action.
    
    Returns:
    
    TestRecordData with necessary info, especially the modified statuscode.
    
    See Also:
    
    LocalAgent.process(java.lang.Object, org.safs.TestRecordData)
  - highlightMatchingChildObject
```
public boolean highlightMatchingChildObject(java.lang.String winRec,
                                            java.lang.String ChildRec)
```
    Engine will try to locate/highlight a window object matching the provided recognition string (ChildRec) under the top-most window with R-String (winRec). if winRec equals to ChildRec, the top-most window will be highlighted. It is supported by RJ.
    
    Parameters:
    
    winRec, - the recognition string of the top-most window
    
    ChildRec, - the recognition string of the child window
  - highlightMatchingChildObjectByKey
```
public boolean highlightMatchingChildObjectByKey(java.lang.Object winkey,
                                                 java.lang.Object compkey,
                                                 java.lang.String rstring)
```
    Engine will try to locate/highlight a window object by its key to the cached object It is supported by RJ.
    
    Parameters:
    
    winkey, - the key to cached test object for window in RJ engine
    
    compkey, - the key to cached test object for component in RJ engine
    
    rstring, - the recognition string of the cached test object
  - clearHighlightedDialog
```
public boolean clearHighlightedDialog()
```
  - getComponentRectangle
```
public java.awt.Rectangle getComponentRectangle(java.lang.Object winkey)
```
    Parameters:
    
    winkey - The cached key of the component's Test Object
    
    Returns:
    
    A rectangle representing the component's screen location.
  - getTopWindowHandle
```
public long getTopWindowHandle(java.lang.Object key)
```
    Parameters:
    
    key - The key of window or component returned by engine side.
    
    Returns:
    
    The Windows native handle.
  - getMatchingParentObject
```
public java.lang.Object getMatchingParentObject(java.lang.String winRec)
```
    Engines will attempt to locate a top-level window object matching the provided recognition string. The String object will be stored in the trd.getStatusInfo().
    
    Parameters:
    
    winRec - String recognition string for Parent window object.
    
    Returns:
    
    STAFProcessContainerResult reference to the first engine and window match. This object will be null if not found.
  - getMatchingChildObjects
```
public java.lang.Object[] getMatchingChildObjects(java.lang.Object parent,
                                                  java.lang.String childRec)
```
    Engine will attempt to locate a child object matching the provided recognition string. The array of objects will be stored in the trd.getStatusInfo() as a delimited array of fields. The first character in the String will identify the separator used between fields. The fields will be converted to a String array by this routine.
    
    Parameters:
    
    parent - STAFProcessContainerResult object identifying parent window previously retrieved.
    
    childRec - String recognition string for desired child object.
    
    Returns:
    
    Object array of STAFProcessContainerResult references to the matching child object(s) found. A zero-length Object[] array will be returned if the parent has no children.
  - routeToPreferredEngines
```
protected long routeToPreferredEngines(STAFProcessContainerHelper trd,
                                       boolean allEngines)
```
    This command is normally only called internally by processCommand. Route the input record to preferred engines only in the order of preference. Normally, we forward the input record to each engine until one of the engines signals that it processed the record.
    
    See Also:
    
    #processCommand(TestRecordHelper)
  - routeToEngines
```
protected long routeToEngines(STAFProcessContainerHelper trd,
                              boolean allEngines)
```
    This command is normally only called internally by processCommand. Route the input record to all engines in the order of initialization. Normally, we forward the input record to each engine until one of the engines signals that it processed the record.
    We will NOT route to an engine where isPreferredEngine==true since preferred engines would have already been tried.
    
    See Also:
    
    #routeToPreferredEngines(TestRecordHelper), #processCommand(TestRecordHelper)
  - processCommand
```
protected long processCommand(STAFProcessContainerHelper trd,
                              boolean allEngines)
```
    Route the input record to available engines. Clears the STAFProcessContainerHelper results Vector before sending. Forward the input record to each engine until one of the engines signals that it processed the record. If allEngines is true then the record will be forwarded to all preferred engines and then all remaining engines.
    Try preferred engines first, then try any remaining engines.
    
    See Also:
    
    #routeToPreferredEngines(TestRecordHelper,boolean), #routeToEngines(TestRecordHelper,boolean)
  - getUniqueSeparator
```
public static java.lang.String getUniqueSeparator(java.lang.String afield)
```
    Return a usable single character separator string that does NOT exist in the provided field. Tries each character in SEPS array.
    
    Parameters:
    
    afield - String field to keep intact.
    
    Returns:
    
    unique String separator that does NOT exist in afield.
  - reset
```
public void reset()
```
    Description copied from interface: GenericToolsInterface
    
    Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.
    
    Specified by:
    
    reset in interface GenericToolsInterface
    
    See Also:
    
    GenericToolsInterface.reset()
  - getObjectRecognitionAtScreenCoords
```
public java.lang.String getObjectRecognitionAtScreenCoords(int x,
                                                           int y)
```

Class STAFLocalServer

Field Summary

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Constructor Summary

Method Summary

Methods inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Methods inherited from class java.lang.Object

Field Detail

RTYPE

trd

SEPS

Constructor Detail

STAFLocalServer

Method Detail

launchInterface

isToolRunning

processStringMethod

isTopLevelPopupContainer

enableDomains

getTopLevelCount

getTopLevelWindows

setActiveWindow

getChildCount

getChildren

getCaption

getAccessibleName

getNonAccessibleName

getName

getID

getText

getPropertyNames

getClassIndex

getDomainName

getProperty

getClassName

getLevel

isShowing

isValid

getSuperClassNames

getMatchingPathObject

getMatchingChildKeysAtPoint

isMatchingPath

getStringData

process

highlightMatchingChildObject

highlightMatchingChildObjectByKey

clearHighlightedDialog

getComponentRectangle

getTopWindowHandle

getMatchingParentObject

getMatchingChildObjects

routeToPreferredEngines

routeToEngines

processCommand

getUniqueSeparator

reset

getObjectRecognitionAtScreenCoords