org.safs.android.engine

Class DGuiClassData

java.lang.Object

org.safs.GuiClassData

org.safs.android.engine.DGuiClassData

public class DGuiClassData
extends GuiClassData

This class is primarily used to open and read in external data files that map class names to class types as well as mapping class types to the standard class processors.

Currently, we only really use the class name to processor mapping at this time.

• Example class mapping: android.widget.CompoundButton = CompoundButton
• Example type mapping: CompoundButton = Button

Default class to type mapping is stored in "java_objects_map.dat".
Default types to library mapping is stored in "object_types_map.dat".

Custom class to type mapping is stored in "custom_java_objects_map.dat".
Custom types to library mapping is stored in "custom_object_types_map.dat".
FEB 07, 2013 (Lei Wang) Modify to let it be a subclass of org.safs.GuiClassData.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALT_NAME_TYPES
static java.lang.String[]	CONTAINER_TYPES
static java.lang.String	CUSTOM_JAVA_OBJECTS_MAP
static java.lang.String	CUSTOM_OBJECT_TYPES_MAP
static java.lang.String	DEFAULT_ANDROID_CLASS_TYPE default type: "View"
static java.lang.String	DEFAULT_ANDROID_OBJECT_TYPE default library name: "View"
static java.lang.String	DEFAULT_JAVA_OBJECTS_MAP
static java.lang.String	DEFAULT_OBJECT_TYPES_MAP
static java.lang.String[]	POPUP_MENU_CLASSES
(package private) DSAFSTestRunner	testrunner Used to get at Android objects via Solo or OS Widgets and Views
static java.lang.String[]	TOOLTIP_CONTAINER_TYPES

Fields inherited from class org.safs.GuiClassData

classassigns, classesmap, classtypesmap, DEFAULT_CLASS_TYPE, DEFAULT_OBJECT_TYPE, DEFAULT_TYPE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DGuiClassData(DSAFSTestRunner testrunner)

Method Summary

Modifier and Type	Method and Description
protected void	debug(java.lang.String message)
static java.lang.String	getGenericObjectType(java.lang.String classType) Returns the case-sensitive, generic object type for the given classType.
java.lang.String	getMappedClassType(java.lang.String classname, java.lang.Object theObject) Retrieves the class processor key we have stored for the provided class name (if any).
java.lang.String	getMappedClassType(java.lang.String classname, java.lang.Object theObject, boolean recursive, boolean allowGeneric) Retrieves the class Type we have stored for the provided class name (if any).
java.lang.String	getObjectClassType(java.lang.Object theObject) Return a type for an object.
static boolean	isAltNameType(java.lang.String type)
static boolean	isContainerType(java.lang.String mappedClassType)
static boolean	isPopupMenuClass(java.lang.String classname)
static boolean	isToolTipContainerType(java.lang.String mappedClassType)
void	loadMappingFile()
void	setSAFSTestRunner(DSAFSTestRunner _testrunner) Must be set prior to calling debug or any of the static "get" functions.

Methods inherited from class org.safs.GuiClassData

classmap, classtypeContainsClassType, deduceOneClassType, getResourceURL, getTypesAsArray, getUniversalResourceURL, isAssignableFrom, isMatched, isMatchedType, typesmap

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JAVA_OBJECTS_MAP

public static final java.lang.String DEFAULT_JAVA_OBJECTS_MAP

See Also:

Constant Field Values

DEFAULT_OBJECT_TYPES_MAP

public static final java.lang.String DEFAULT_OBJECT_TYPES_MAP

See Also:

Constant Field Values

CUSTOM_JAVA_OBJECTS_MAP

public static final java.lang.String CUSTOM_JAVA_OBJECTS_MAP

See Also:

Constant Field Values

CUSTOM_OBJECT_TYPES_MAP

public static final java.lang.String CUSTOM_OBJECT_TYPES_MAP

See Also:

Constant Field Values

DEFAULT_ANDROID_CLASS_TYPE

public static final java.lang.String DEFAULT_ANDROID_CLASS_TYPE

default type: "View"

See Also:

Constant Field Values

DEFAULT_ANDROID_OBJECT_TYPE

public static final java.lang.String DEFAULT_ANDROID_OBJECT_TYPE

default library name: "View"

See Also:

Constant Field Values

testrunner

DSAFSTestRunner testrunner

Used to get at Android objects via Solo or OS Widgets and Views

CONTAINER_TYPES

public static final java.lang.String[] CONTAINER_TYPES

ALT_NAME_TYPES

public static final java.lang.String[] ALT_NAME_TYPES

TOOLTIP_CONTAINER_TYPES

public static final java.lang.String[] TOOLTIP_CONTAINER_TYPES

POPUP_MENU_CLASSES

public static final java.lang.String[] POPUP_MENU_CLASSES

Constructor Detail

DGuiClassData

public DGuiClassData(DSAFSTestRunner testrunner)

Method Detail

setSAFSTestRunner

public void setSAFSTestRunner(DSAFSTestRunner _testrunner)

Must be set prior to calling debug or any of the static "get" functions. Currently this is set by the DSAFSTestRunner itself during initialization.

Parameters:

_testrunner -

debug

protected void debug(java.lang.String message)

loadMappingFile

public void loadMappingFile()

getMappedClassType

public java.lang.String getMappedClassType(java.lang.String classname,
                                           java.lang.Object theObject)

Retrieves the class processor key we have stored for the provided class name (if any). We will cycle through all possible superclasses (except Object) looking for a match to a superclass.

Overrides:

getMappedClassType in class GuiClassData

Parameters:

classname - the actual classname sought as a known class type.

obj - the object we are going to evaluate for "type"

Returns:

the mapped class type(s) for the provided class name (i.e. android.widget.CheckBox). null if no mapped type is found. This can be a comma-separated list of possible class type matches.

See Also:

getMappedClassType(String, Object, boolean, boolean)

getMappedClassType

public java.lang.String getMappedClassType(java.lang.String classname,
                                           java.lang.Object theObject,
                                           boolean recursive,
                                           boolean allowGeneric)

Retrieves the class Type we have stored for the provided class name (if any). We will cycle through all possible superclasses (except Object) looking for a match to a superclass if recursive is true.

Tool-dependent subclasses will most likely have to subclass this class and provide similar mechanisms for evaluating the class hierarchy.

Overrides:

getMappedClassType in class GuiClassData

Parameters:

classname - the actual classname sought as a known class type.

obj - the object we are going to evaluate for "type"

recursive - true to look for superclass Type matches. false for only a direct class=type match.

allowGeneric - true to allow Type=Generic if no match is found for the provided classname. false -- no Generic Type will be returned if the classname does not map.

Returns:

the class Type (i.e. JavaPanel) for the provided class name (i.e. javax.swing.JPanel). null if no mapped type is found. The classtype may be returned as a comma-separated list of all types supported for the class.

getGenericObjectType

public static java.lang.String getGenericObjectType(java.lang.String classType)

Returns the case-sensitive, generic object type for the given classType. For Android engine, use this method. Do NOT use GuiClassData.getGenericObjectType(String)

getObjectClassType

public java.lang.String getObjectClassType(java.lang.Object theObject)

Return a type for an object. The type is defined in file DEFAULT_JAVA_OBJECTS_MAP.dat For one class, sometimes it can be mapped to multiple types, a string separated by . This method will return one of them.

Returns:

String, The Type of this object.

See Also:

getMappedClassType(String, Object), GuiClassData.deduceOneClassType(String, String)

isContainerType

public static boolean isContainerType(java.lang.String mappedClassType)

isPopupMenuClass

public static boolean isPopupMenuClass(java.lang.String classname)

isToolTipContainerType

public static boolean isToolTipContainerType(java.lang.String mappedClassType)

isAltNameType

public static boolean isAltNameType(java.lang.String type)