com.rational.test.ft.services
Class PlaybackMonitorPreferencesValue

java.lang.Object
  com.rational.test.ft.services.PlaybackMonitorPreferencesValue

public class PlaybackMonitorPreferencesValue
extends java.lang.Object

This value class handles the value considerations for a PlaybackMonitorPreferences class object.

Constructor Summary

PlaybackMonitorPreferencesValue()

Method Summary

int	compare(java.lang.Object left, java.lang.Object right, ICompareValueClass nested) This method compares objects supported by this value class manager and returns a result in the range 0 to 100.
java.lang.Object	createValue(java.lang.Object sourceToCopy) This method is essentially a copy constructor for an object of the managed class.
java.lang.String	getCanonicalName() This method returns a canonical name for the value class that uniquely identifies the streamed format of the data associated with this class.
java.lang.String	getClassName() This method returns the class name of the object that this manager represents.
java.lang.Object	persistIn(IPersistIn persist, IAuxiliaryDataManager auxData) This method pulls data from a supplied input object.
void	persistOut(java.lang.Object theObject, IPersistOut persist, IAuxiliaryDataManager auxData) This method pushes the significant data associated with an object into the specified output object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaybackMonitorPreferencesValue

public PlaybackMonitorPreferencesValue()

Method Detail

persistOut

public void persistOut(java.lang.Object theObject,
                       IPersistOut persist,
                       IAuxiliaryDataManager auxData)

This method pushes the significant data associated with an object into the specified output object. Note that the data persisted must be either a primitive type or have a IManageValueClass in the value class map to support the data class.

Supplied is an IAuxiliaryDataManager instance that should be used to name auxiliary data files. Failure to use this object to name auxiliary data will result in the auxiliary files not be properly managed by the test management system.

Parameters:

theObject - The object that is to be sequentially inserted into the supplied output stream.

persist - The output stream to sequentially insert data into.

auxData - The auxiliary data interface used for naming associated data files.

See Also:

persistIn(IPersistIn,IAuxiliaryDataManager), #persistIn(IPersistInNamed,IAuxiliaryDataManager), IPersistOut, IAuxiliaryDataManager

persistIn

public java.lang.Object persistIn(IPersistIn persist,
                                  IAuxiliaryDataManager auxData)

This method pulls data from a supplied input object. The data must be pulled in the same order in which it was pushed by persistOut.

Supplied is an IAuxiliaryDataManager instance that should be used to locate auxiliary data files. Auxiliary data files that do not follow the supplied naming convention will not be managed by the test management system.

Parameters:

persist - The input stream that data is pulled sequentially out of.

auxData - The auxiliary data interface used for naming associated data files.

Returns:

The object extracted from the data stream.

See Also:

persistOut(Object,IPersistOut,IAuxiliaryDataManager)

compare

public int compare(java.lang.Object left,
                   java.lang.Object right,
                   ICompareValueClass nested)

This method compares objects supported by this value class manager and returns a result in the range 0 to 100. If the objects are equivalent this method will return 100. If the objects have no similarities 0 will be returned. If the objects are partially equivalent then an appropriate value between 0 and 100 will be returned. Commonly only 0 and 100 are returned by an implementation (based on straight equality "((left.equals(right)) ? 100 : 0 )").

An example of when a value other then 0 or 100 will be returned is a caption. Window captions commonly contain dynamic information such as file name or date type information. A partial match on a caption might return a 50 rather then a 0 or 100.

Parameters:

left - The first object in the comparison.

right - The second object in the comparison.

nested - An object that can perform nested complex compare actions.

Returns:

An integer value in the range 0 to 100 that depicts the level of equality. 0 is poor and 100 is good.

createValue

public java.lang.Object createValue(java.lang.Object sourceToCopy)

This method is essentially a copy constructor for an object of the managed class. The copy does not have to be a deep copy and should return null if a copy operation is not be performed. The primary use of this method is to shear property methods returning extended instances of the expected class. For instance if java.awt.Point is the expected return type, however mycompany.MyPoint (which extends the AWT Point class) is actually returned, then the returned object will need to be sheared before it may be used as a Point property. To get the MyPoint object use an IManageValueClass will need to be crated for the new class (it must be a value class object).

Parameters:

sourceToCopy - An instance of the associated value class.

Returns:

A pure copy of the expected value class.

getCanonicalName

public java.lang.String getCanonicalName()

This method returns a canonical name for the value class that uniquely identifies the streamed format of the data associated with this class. Verification point data may be read on more then one platform via multiple languages. The data format remains the same, however the associated IManageValueClass may vary from platform to platform. This method returns a name that does not vary between platforms.

For instance rational.hashtable may be returned for the set of key/value pairs associated with a java.util.hashtable. On another platform this data may be read into a C++ STL grid type object. Regardless the data can be read because a canonical name for the value class has been associated with the data. Note that the name in this example uses the rational company name so that this value class name for a hashtable does not conflict with another companies.

This name is automatically added to the data stream for an IManageValueClass mapped object and therefore does not need to be explicitly added by an implementation of persistOut.

Returns:

The canonical name for the value class.

getClassName

public java.lang.String getClassName()

This method returns the class name of the object that this manager represents. Each IManageValueClass can only support one value class. The name of that class is returned by this method so that the mapping of the value class to the appropriate value class manager can be performed.

Returns:

The full class name of the associated value class.