org.lsst.ccs.bus.data

Class KeyValueData

java.lang.Object

org.lsst.ccs.bus.data.KeyValueData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

KeyValueDataList

public class KeyValueData
extends Object
implements Serializable

Generic Data class for Key-Value pairs. This class is meant to be used by CCS Agents to publish key-value pairs type information. Subclasses of this class will provide additional information when needed. For example KeyValueTimeData provides a timestamp for the key-value pair.

Author:

The LSST CCS Team

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyValueData.KeyValueDataType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	needsEncoding

Constructor Summary

Constructors

Constructor and Description
KeyValueData(String key, Serializable value) Build a KeyValueData object providing the name and the value for the key-value pair.
KeyValueData(String key, Serializable value, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp) Build a KeyValueData object providing the name and the value for the key-value pair and the CCSTimeStamp in which this data was accumulated.
KeyValueData(String key, Serializable value, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, KeyValueData.KeyValueDataType type) Build a KeyValueData object providing the name and the value for the key-value pair and the CCSTimeStamp in which this data was accumulated and their type.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getCCSTimeStamp() Get the CCSTimeStamp associated with the key-value pair.
String	getKey() Get the key.
KeyValueData.KeyValueDataType	getType() Get the KeyValueData type.
Serializable	getValue() Get the value embedding in this object.
boolean	needsEncoding()
String	toString()
protected void	updateNeedsEncoding(Object obj)

Methods inherited from class java.lang.Object

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

Field Detail

needsEncoding

protected transient boolean needsEncoding

Constructor Detail

KeyValueData

public KeyValueData(String key,
                    Serializable value,
                    org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp,
                    KeyValueData.KeyValueDataType type)

Build a KeyValueData object providing the name and the value for the key-value pair and the CCSTimeStamp in which this data was accumulated and their type. The type defines what client codes will do with the KeyValueData.

Parameters:

key - The String representing the key

value - The Object representing the value of the pair.

ccsTimeStamp - The CCSTimestamp for this KeyValueData.

type - The type for this KeyValueData

KeyValueData

public KeyValueData(String key,
                    Serializable value,
                    org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp)

Build a KeyValueData object providing the name and the value for the key-value pair and the CCSTimeStamp in which this data was accumulated.

Parameters:

key - The String representing the key

value - The Object representing the value of the pair.

ccsTimeStamp - The CCSTimestamp for this KeyValueData.

KeyValueData

public KeyValueData(String key,
                    Serializable value)

Build a KeyValueData object providing the name and the value for the key-value pair. The timestamp is automatically assigned the time this object was created.

Parameters:

key - The String representing the key

value - The Object representing the value of the pair.

Method Detail

getCCSTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getCCSTimeStamp()

Get the CCSTimeStamp associated with the key-value pair.

Returns:

The CCSTimeStamp.

getValue

public Serializable getValue()

Get the value embedding in this object.

Returns:

The value.

getKey

public String getKey()

Get the key.

Returns:

The name of the Key

getType

public KeyValueData.KeyValueDataType getType()

Get the KeyValueData type.

Returns:

The KeyValueData type.

toString

public String toString()

Overrides:

toString in class Object

updateNeedsEncoding

protected final void updateNeedsEncoding(Object obj)

needsEncoding

public boolean needsEncoding()