com.rational.test.ft.domain

Class DescribedObjectReference

java.lang.Object

RegisteredObject

com.rational.test.ft.domain.ProxyTestObject

com.rational.test.ft.domain.DescribedObjectReference

All Implemented Interfaces:

IDataDriven, IProxyBase

Direct Known Subclasses:

FlexDescribedObject, PdfDescribedObject

public class DescribedObjectReference
extends ProxyTestObject

DescribedObjectReference represents the reference to a DescribedObject, an known object which exists in another domain. The reference is a list of properties stored in a SpyMap. This class is derived from ProxyTestObject so that it may be returned in methods which normally return a proxy, such as getParent/getChildren.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARENT_PROCESS_WINDOW
static java.lang.String	PROCESSID
static java.lang.String	TARGETDOMAIN
static java.lang.String	TARGETSUBDOMAIN
static java.lang.String	THREADID
static java.lang.String	WINDOW
static java.lang.String	XULBrowserAddr

Fields inherited from class com.rational.test.ft.domain.ProxyTestObject

BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TIMEOUTTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle

Fields inherited from interface com.rational.test.ft.domain.IDataDriven

INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS

Constructor Summary

Constructors

Constructor and Description
DescribedObjectReference()
DescribedObjectReference(HashtableEx propertyMap)
DescribedObjectReference(HashtableEx propertyMap, java.lang.String testObjectClassname)
DescribedObjectReference(java.lang.String testObjectClassname)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRecognitionProperty(java.lang.String propertyName, java.lang.Object val, int weight) Defines an additional recognition property that this proxy can use.
boolean	equals(java.lang.Object obj) Overrides the object-level equals with an equality against the true test objects.
ProxyTestObject[]	getChildren() Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.
java.lang.String	getDescriptiveName() Returns a name that can be used to describe the associated UI object in a script.
com.rational.test.ft.object.manager.FindPropertySet	getFindProperties()
java.lang.Object	getIndexer(java.lang.String name, java.lang.Object[] indexes) Gets the value of an indexed property
IndexerInfo[]	getIndexers() Gets information about a TestObject's indexed properties
ProxyTestObject[]	getMappableChildren() Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.
ProxyTestObject	getMappableParent() Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent.
com.rational.test.ft.value.MethodInfo[]	getMethods() Returns an array containing method signatures for all methodsaccessiblee against the associated test object.
com.rational.test.ft.sys.MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Returns a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
java.util.Hashtable	getNonValueProperties() Returns the properties that are not supported because the value is a reference to another object.
java.lang.Object	getObject()
ProxyTestObject[]	getOwnedObjects() Returns an array of proxies for the objects owned by this object.
ProxyTestObject	getOwner() Returns a proxy object for the owner of this object; returns null if this object has no owner.
ProxyTestObject	getParent() Returns a proxy object for the parent of this object; returns null if this object has no parent.
java.util.Hashtable	getProperties() Returns a complete set of properties for the associated test object.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the value for a specific property defined in getProperties() or getRecognitionProperties().
HashtableEx	getPropertyMap()
SpyMap	getPropertySpyMap() Convert the property map to a SpyMap.
java.util.Hashtable	getRecognitionProperties() Returns an enumeration of properties used to identify the associated test object.
int	getRecognitionPropertyWeight(java.lang.String propertyName) Returns an indication of how useful this property is for recognition.
java.util.Hashtable	getStandardProperties() Returns a complete set of consistent properties for the associated test object.
java.util.Hashtable	getTestDataTypes() Returns a hashtable of data type descriptions of the verification point data available with the associated object.
TestDomainImplementation	getTestDomain() Returns the TestDomain that this proxy object is associated with.
java.lang.String	getTestObjectClassName() Returns a valid class name specification.
ProxyTestObject	getTopMappableParent() Returns a proxy object for the top mappable parent of this object; returns a pointer to itself if this object has no mappable parent.
ProxyTestObject	getTopParent() Returns a proxy object for the top parent of this object; returns a pointer to itself if this object has no parent.
java.lang.String	getUniqueId() Returns a string for the associated object.
boolean	hasAddedRecognitionProperties() Returns true if recognition properties have been added to this proxy from an external source through addRecognitionProperty().
boolean	isReleaseRequired()
void	processMouseEvent(IMouseActionInfo action) Updates the supplied action with an appropriate MethodSpecification to play back the action.
void	release()
void	setFindProperties(com.rational.test.ft.object.manager.FindPropertySet propSet)
void	setIndexer(java.lang.String name, java.lang.Object[] indexes, java.lang.Object val) Sets the value of an indexed property
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Sets the value for a specific property defined in getProperties() or getRecognitionProperties().
boolean	shouldBeMapped() Determines whether the object is interesting from a persistent testability sense and should therefore be added to the object map.

Methods inherited from class com.rational.test.ft.domain.ProxyTestObject

addDataDrivableCommands, baseClassMatch, canTakeVP, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommand, getDataDrivableCommands, getElementWithFocus, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getRole, getScriptCommandAnchor, getScriptCommandFlags, getTestData, getVisualClippableParent, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSID

public static final java.lang.String PROCESSID

See Also:

Constant Field Values

THREADID

public static final java.lang.String THREADID

See Also:

Constant Field Values

XULBrowserAddr

public static final java.lang.String XULBrowserAddr

See Also:

Constant Field Values

WINDOW

public static final java.lang.String WINDOW

See Also:

Constant Field Values

TARGETDOMAIN

public static final java.lang.String TARGETDOMAIN

TARGETSUBDOMAIN

public static final java.lang.String TARGETSUBDOMAIN

See Also:

Constant Field Values

PARENT_PROCESS_WINDOW

public static final java.lang.String PARENT_PROCESS_WINDOW

See Also:

Constant Field Values

Constructor Detail

DescribedObjectReference

public DescribedObjectReference()

DescribedObjectReference

public DescribedObjectReference(java.lang.String testObjectClassname)

DescribedObjectReference

public DescribedObjectReference(HashtableEx propertyMap)

DescribedObjectReference

public DescribedObjectReference(HashtableEx propertyMap,
                        java.lang.String testObjectClassname)

Method Detail

getPropertyMap

public HashtableEx getPropertyMap()

getPropertySpyMap

public SpyMap getPropertySpyMap()

Convert the property map to a SpyMap.

Returns:

SpyMap containing the described object properties.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Description copied from class: ProxyTestObject

Gets the value for a specific property defined in getProperties() or getRecognitionProperties(). If the property is not defined by either of these methods, this method throws PropertyNotFoundException.

Specified by:

getProperty in class ProxyTestObject

Parameters:

propertyName - The name of the property to fetch.

Returns:

The active value of the specified property for the associated test object.

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getRecognitionProperties(), ProxyTestObject.addRecognitionProperty(String,Object,int)

setProperty

public void setProperty(java.lang.String propertyName,
               java.lang.Object propertyValue)

Description copied from class: ProxyTestObject

Sets the value for a specific property defined in getProperties() or getRecognitionProperties(). Properties not defined by either of these methods, and properties whose values cannot be modified throw an appropriately populated PropertyNotFoundException.

Specified by:

setProperty in class ProxyTestObject

Parameters:

propertyName - The name of the property to redefine. This name is the same as that returned by getProperties().

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.getProperty(String)

addRecognitionProperty

public void addRecognitionProperty(java.lang.String propertyName,
                          java.lang.Object val,
                          int weight)

Description copied from class: ProxyTestObject

Defines an additional recognition property that this proxy can use. Properties defined outside a proxy have the side effect that they must always be attached to the proxy when created. This can be problematic in some domains. These properties must be ignored if appropriate proxy caching is not being performed. Properties added to a proxy are returned through ProxyTestObject.getRecognitionProperties().

Specified by:

addRecognitionProperty in class ProxyTestObject

Parameters:

propertyName - The recognition property name. Care should be taken to avoid conflicts with existing property names.

val - The value of the added recognition property.

weight - The weight associated with this recognition property. This value is returned when getRecognitionPropertyWeight() is called.

See Also:

ProxyTestObject.getRecognitionProperties(), ProxyTestObject.getRecognitionPropertyWeight(String), ProxyTestObject.getProperty(String)

setFindProperties

public void setFindProperties(com.rational.test.ft.object.manager.FindPropertySet propSet)

getFindProperties

public com.rational.test.ft.object.manager.FindPropertySet getFindProperties()

getNonValueProperties

public java.util.Hashtable getNonValueProperties()

Description copied from class: ProxyTestObject

Returns the properties that are not supported because the value is a reference to another object. These properties can still be accessed using getProperty(). If such a property is returned to the test script, it is manifested as a TestObject containing a reference to the object in the SUT. The test script should call the TestObject method unregister() to release the object.

When an object is unregistered, the release() method that all ProxyTestObjects inherit from RegisteredObject is called.

Specified by:

getNonValueProperties in class ProxyTestObject

Returns:

The set of properties that are not available.

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.getStandardProperties(), ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object)

getIndexer

public java.lang.Object getIndexer(java.lang.String name,
                          java.lang.Object[] indexes)

Gets the value of an indexed property

Specified by:

getIndexer in class ProxyTestObject

Parameters:

name - the name of the indexer

indexes - the indexes to get the value of

getIndexers

public IndexerInfo[] getIndexers()

Gets information about a TestObject's indexed properties

Specified by:

getIndexers in class ProxyTestObject

See Also:

com.rational.test.ft.value.IndexerInfo

setIndexer

public void setIndexer(java.lang.String name,
              java.lang.Object[] indexes,
              java.lang.Object val)

Sets the value of an indexed property

Specified by:

setIndexer in class ProxyTestObject

Parameters:

name - the name of the indexer

indexes - the indexes to set the value of

getMappableParent

public ProxyTestObject getMappableParent()

Description copied from class: ProxyTestObject

Returns a proxy object for the mappable parent of this object; returns null if this object has no mappable parent. Note that only a proxy that shouldBeMapped should be returned from this method.

Specified by:

getMappableParent in class ProxyTestObject

Returns:

The proxy for the first mappable parent test object or null for a top-level mapped object.

getOwnedObjects

public ProxyTestObject[] getOwnedObjects()

Description copied from class: ProxyTestObject

Returns an array of proxies for the objects owned by this object.

Specified by:

getOwnedObjects in class ProxyTestObject

Returns:

An array of proxies of objects owned by this proxy.

getOwner

public ProxyTestObject getOwner()

Description copied from class: ProxyTestObject

Returns a proxy object for the owner of this object; returns null if this object has no owner.

Specified by:

getOwner in class ProxyTestObject

Returns:

The proxy for the owning object, or null for a top object without an owner.

getParent

public ProxyTestObject getParent()

Description copied from class: ProxyTestObject

Returns a proxy object for the parent of this object; returns null if this object has no parent.

Specified by:

getParent in class ProxyTestObject

Returns:

The proxy for the parent test object or null for a top-level object.

getProperties

public java.util.Hashtable getProperties()

Description copied from class: ProxyTestObject

Returns a complete set of properties for the associated test object. The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.

This method does not return properties whose values are references to objects. The method ProxyTestObject.getNonValueProperties() returns information about such properties.

Specified by:

getProperties in class ProxyTestObject

Returns:

The set of known properties associated with a test object.

See Also:

ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getStandardProperties(), ProxyTestObject.getNonValueProperties()

getRecognitionProperties

public java.util.Hashtable getRecognitionProperties()

Description copied from class: ProxyTestObject

Returns an enumeration of properties used to identify the associated test object. Useful recognition properties are properties such as the programmatic name or a persistent description. Less interesting are the visible text on a button or label, or the tooltip text, or the foreground color. Uninteresting properties are the transient properties such as hasFocus or isShowing.

Specified by:

getRecognitionProperties in class ProxyTestObject

Returns:

An enumeration of recognition properties. The returned objects are of class TestObjectProperty.

See Also:

ProxyTestObject.getRecognitionPropertyWeight(String), ProxyTestObject.getProperty(String), ProxyTestObject.addRecognitionProperty(String,Object,int)

getRecognitionPropertyWeight

public int getRecognitionPropertyWeight(java.lang.String propertyName)

Description copied from class: ProxyTestObject

Returns an indication of how useful this property is for recognition. A value of 0 indicates not useful at all, and a value of 100 indicates that the property is extremely useful for recognition. This method must return a value greater than or equal to zero and less than or equal to 100.

Specified by:

getRecognitionPropertyWeight in class ProxyTestObject

Parameters:

propertyName - The name of the recognition property to return a weight value for.

See Also:

ProxyTestObject.getRecognitionProperties()

getStandardProperties

public java.util.Hashtable getStandardProperties()

Description copied from class: ProxyTestObject

Returns a complete set of consistent properties for the associated test object. Consistent properties are those properties that exist regardless of the platform the test object is running on. Domains that do not support the notion of standard properties should implement this method identically to ProxyTestObject.getProperties(). The HTML domain supports standard properties and returns properties that are consistent across browser versions. The Java domain does not support this notion of standard properties. In this domain, getStandardProperties, and getProperties do the same thing. For HTML, standard properties are a subset of the properties returned by getProperties(). The meaning of a property is specific to the test domain and the test object. Typically, this is a set of name/value pairs that describe the test object and its active state. Properties such as font, colors, and coordinate information are typically associated with a GUI test object. Associated data and state information can also be returned, depending on the test object.

Specified by:

getStandardProperties in class ProxyTestObject

Returns:

The set of standard properties associated with a test object.

See Also:

ProxyTestObject.getProperty(String), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getProperties(), ProxyTestObject.getNonValueProperties()

getTestDataTypes

public java.util.Hashtable getTestDataTypes()

Description copied from class: ProxyTestObject

Returns a hashtable of data type descriptions of the verification point data available with the associated object. The hashtable keys are String objects that are used as the VP type in the associated test data. The type is a simple value that is different from other type values associated with this object under test. The type keys map to a verbose description of the test data, reasonable for presentation to a user.

Specified by:

getTestDataTypes in class ProxyTestObject

Returns:

An hashtable of type/description pairs used to describe the verification data available from this proxy.

See Also:

ProxyTestObject.getTestData(String), com.rational.test.ft.vp.ITestData

getTestDomain

public TestDomainImplementation getTestDomain()

Description copied from class: ProxyTestObject

Returns the TestDomain that this proxy object is associated with.

Specified by:

getTestDomain in interface IProxyBase

Specified by:

getTestDomain in class ProxyTestObject

Returns:

The associated TestDomain class full name.

getTopMappableParent

public ProxyTestObject getTopMappableParent()

Description copied from class: ProxyTestObject

Returns a proxy object for the top mappable parent of this object; returns a pointer to itself if this object has no mappable parent.

Specified by:

getTopMappableParent in class ProxyTestObject

Returns:

The proxy for the top parent test object or itself for a test object with no mappable parent.

getTopParent

public ProxyTestObject getTopParent()

Description copied from class: ProxyTestObject

Returns a proxy object for the top parent of this object; returns a pointer to itself if this object has no parent.

Specified by:

getTopParent in class ProxyTestObject

Returns:

The proxy for the top parent test object or itself for a top-level object.

getUniqueId

public java.lang.String getUniqueId()

Description copied from class: ProxyTestObject

Returns a string for the associated object. This string must be unique and must be identical for each call to this method for the same instance of the UI object.

Specified by:

getUniqueId in class ProxyTestObject

Returns:

A unique and repeatable identifier for the object being evaluated.

shouldBeMapped

public boolean shouldBeMapped()

Description copied from class: ProxyTestObject

Determines whether the object is interesting from a persistent testability sense and should therefore be added to the object map. An object is considered interesting under one or more of the following conditions:

• Significant user actions can be performed against the object.
• The object contains testable properties.
• The object has interesting data associated with it.

Examples of objects that are not interesting include:

• Simple container objects with no interesting data.
• Decorative objects with no interesting side effects.
• Duplicate objects (mirroring data from another available object).

Note that if the object is a container, the children are examined even if this method returns false.

Specified by:

shouldBeMapped in class ProxyTestObject

Returns:

true if the represented control is interesting other than for nested objects.

hasAddedRecognitionProperties

public boolean hasAddedRecognitionProperties()

Description copied from class: ProxyTestObject

Returns true if recognition properties have been added to this proxy from an external source through addRecognitionProperty().

Specified by:

hasAddedRecognitionProperties in class ProxyTestObject

Returns:

true if recognition properties have been added to this proxy from an external source through addRecognitionProperty(String,Object,int).

See Also:

ProxyTestObject.addRecognitionProperty(String,Object,int)

processMouseEvent

public void processMouseEvent(IMouseActionInfo action)

Description copied from class: ProxyTestObject

Updates the supplied action with an appropriate MethodSpecification to play back the action. This method is the primary record interface for mouse events against a particular control. Only one MethodSpecification is maintained in the action state. If the active specification is valid, it is not updated.

Specified by:

processMouseEvent in class ProxyTestObject

Parameters:

action - The event cache and other mouse state information for this mouse action.

See Also:

IMouseActionInfo, com.rational.test.ft.sys.MethodSpecification

isReleaseRequired

public boolean isReleaseRequired()

release

public void release()

equals

public boolean equals(java.lang.Object obj)

Description copied from class: ProxyTestObject

Overrides the object-level equals with an equality against the true test objects.

Overrides:

equals in class ProxyTestObject

Parameters:

obj - The object to compare against. If obj is a ProxyTestObject, the comparison is made with the underlying object.

Returns:

true if the underlying test objects are equal.

getChildren

public ProxyTestObject[] getChildren()

Description copied from class: ProxyTestObject

Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object.

Specified by:

getChildren in class ProxyTestObject

Returns:

An array of child proxies of this proxy.

getDescriptiveName

public java.lang.String getDescriptiveName()

Description copied from class: ProxyTestObject

Returns a name that can be used to describe the associated UI object in a script. This name can be further adjusted to be unique to the script. Only characters used in Java identifiers are returned (alphabetic, numeric, or underscore characters). Other kinds of characters cause script compilation failures. An example of what to return is "OKButton" for a java.awt.Button with the associated text "OK".

Specified by:

getDescriptiveName in class ProxyTestObject

Returns:

A descriptive object name.

getMappableChildren

public ProxyTestObject[] getMappableChildren()

Description copied from class: ProxyTestObject

Returns an array of proxies, visible by using the TestObject interface from a script, for the children of this object. This method is always used when building up the test objects to be added to a map, because a side additional recognition properties may be added to the child objects.

Specified by:

getMappableChildren in class ProxyTestObject

Returns:

An array of child proxies of this proxy.

getMethods

public com.rational.test.ft.value.MethodInfo[] getMethods()

Description copied from class: ProxyTestObject

Returns an array containing method signatures for all methodsaccessiblee against the associated test object. Methods that cannot be directly invoked are not returned. The set of accessible methods is domain and test-object specific.

Specified by:

getMethods in class ProxyTestObject

Returns:

An array containing method signatures for all methods accessible against the associated test object.

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.getStandardProperties(), ProxyTestObject.getNonValueProperties()

getMethodSpecForPoint

public com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Description copied from class: ProxyTestObject

Returns a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default, a method specification for IGraphical.getScreenPoint is returned.

Specified by:

getMethodSpecForPoint in class ProxyTestObject

See Also:

com.rational.test.ft.sys.MethodSpecification

getTestObjectClassName

public java.lang.String getTestObjectClassName()

Description copied from class: ProxyTestObject

Returns a valid class name specification. The test script (which runs in a separate process) interacts with a class that supports a shared interface with a specific proxy. This class is called a TestObject class. The testObject performs a cross-process (and cross-JVM) call to the same method against an associated proxy, which is this proxy.

This method should never return null, even if shouldBeMapped() returns false. User may still access objects such as this through scripting method calls and can return references to them. If a null were returned, the marshalling code would be confused and would not be able to construct a test object.

This method may be called from any thread.

Specified by:

getTestObjectClassName in interface IProxyBase

Specified by:

getTestObjectClassName in class ProxyTestObject

Returns:

The associated testObject class full name.

getObject

public java.lang.Object getObject()