com.rational.test.ft.domain
Class RegisteredDescribedObjectReferenceValue

java.lang.Object   com.rational.test.ft.sys.RegisteredObjectReferenceValue       com.rational.test.ft.domain.RegisteredDescribedObjectReferenceValue

All Implemented Interfaces:

com.rational.test.ft.value.managers.IManageValueClass

public class RegisteredDescribedObjectReferenceValue
extends com.rational.test.ft.sys.RegisteredObjectReferenceValue

This class converts between a RegisteredDescribedObjectReference and a SpyValueClass that contains the same information. Uses the base class (RegisteredObjectReferenceValue) for most its implementation.

Constructor Summary

RegisteredDescribedObjectReferenceValue()

Method Summary

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(com.rational.test.ft.value.managers.IPersistIn persist, com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData) This method pulls data from a supplied input object.
java.lang.Object	persistIn(com.rational.test.ft.value.managers.IPersistInNamed persist, com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData) This method pulls data from a supplied input object.
void	persistOut(java.lang.Object theObject, com.rational.test.ft.value.managers.IPersistOut persist, com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData) This method pushes the significant data associated with an object into the specified output object.

Methods inherited from class com.rational.test.ft.sys.RegisteredObjectReferenceValue

compare, createValue

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredDescribedObjectReferenceValue

public RegisteredDescribedObjectReferenceValue()

Method Detail

getCanonicalName

public java.lang.String getCanonicalName()

Description copied from class: com.rational.test.ft.sys.RegisteredObjectReferenceValue

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.

Specified by:

getCanonicalName in interface com.rational.test.ft.value.managers.IManageValueClass

Overrides:

getCanonicalName in class com.rational.test.ft.sys.RegisteredObjectReferenceValue

Returns:

The canonical name for the value class.

getClassName

public java.lang.String getClassName()

Description copied from class: com.rational.test.ft.sys.RegisteredObjectReferenceValue

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.

Specified by:

getClassName in interface com.rational.test.ft.value.managers.IManageValueClass

Overrides:

getClassName in class com.rational.test.ft.sys.RegisteredObjectReferenceValue

Returns:

The full class name of the associated value class.

persistIn

public java.lang.Object persistIn(com.rational.test.ft.value.managers.IPersistIn persist,                                   com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData)

Description copied from class: com.rational.test.ft.sys.RegisteredObjectReferenceValue

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.

Specified by:

persistIn in interface com.rational.test.ft.value.managers.IManageValueClass

Overrides:

persistIn in class com.rational.test.ft.sys.RegisteredObjectReferenceValue

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:

RegisteredObjectReferenceValue.persistOut(Object,IPersistOut,IAuxiliaryDataManager)

persistIn

public java.lang.Object persistIn(com.rational.test.ft.value.managers.IPersistInNamed persist,                                   com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData)

Description copied from class: com.rational.test.ft.sys.RegisteredObjectReferenceValue

This method pulls data from a supplied input object. The data must be pulled in using the names supplied when the object was persisted 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.

Specified by:

persistIn in interface com.rational.test.ft.value.managers.IManageValueClass

Overrides:

persistIn in class com.rational.test.ft.sys.RegisteredObjectReferenceValue

Parameters:

persist - The input object that the named data is pulled out of.

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

Returns:

The object extracted from the data stream.

See Also:

RegisteredObjectReferenceValue.persistOut(Object,IPersistOut,IAuxiliaryDataManager)

persistOut

public void persistOut(java.lang.Object theObject,                        com.rational.test.ft.value.managers.IPersistOut persist,                        com.rational.test.ft.value.managers.IAuxiliaryDataManager auxData)

Description copied from class: com.rational.test.ft.sys.RegisteredObjectReferenceValue

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.

Specified by:

persistOut in interface com.rational.test.ft.value.managers.IManageValueClass

Overrides:

persistOut in class com.rational.test.ft.sys.RegisteredObjectReferenceValue

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:

RegisteredObjectReferenceValue.persistIn(IPersistIn,IAuxiliaryDataManager), RegisteredObjectReferenceValue.persistIn(IPersistInNamed,IAuxiliaryDataManager), IPersistOut, IAuxiliaryDataManager