org.lsst.ccs.bus.data

Class KeyValueDataList

java.lang.Object

org.lsst.ccs.bus.data.KeyValueData

org.lsst.ccs.bus.data.KeyValueDataList

All Implemented Interfaces:

Serializable, Iterable<KeyValueData>

public final class KeyValueDataList
extends KeyValueData
implements Serializable, Iterable<KeyValueData>

An object designed to group together KeyValueData objects before publication on the Status bus. This is a KeyValueData itself, whose value is a List At construction time this list is associated a time stamp, either as a user input or set to the creation time by default. When data is added to this list, it is stored internally as a KeyValueData. If no time stamp is provided at the time the key-value pair is added, it is by default assigned the time stamp of the list.

Once a client submits an instance of KeyValueDataList for publication on the status bus, it logically belongs to the framework and should no longer be used or updated by the client.

Contrary to what one might expect, the list key you supply when making a KeyValueDataList is not encoded and so doesn't appear in trending. For example if in a subsystem whose name on the buses is "subsys" you choose a list key of "foo" and add a list item with a key of "bar", the item will appear in trending under the path "subsys/bar" and not as "subsys/foo/bar". In order to get the latter you must use an item key of "foo/bar". This behavior was coded at a time when full hierarchical path names were not used in trending and the writers of the filter changer subsystem wished to use the master key as a kind of message type tag.

Author:

The LSST CCS Team

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.bus.data.KeyValueData

KeyValueData.KeyValueDataType

Field Summary

Fields inherited from class org.lsst.ccs.bus.data.KeyValueData

needsEncoding

Constructor Summary

Constructors

Constructor and Description
KeyValueDataList() Create a KeyValueDataList without a key or a timestamp.
KeyValueDataList(org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp) Create a KeyValueDataList with a ccs time stamp.
KeyValueDataList(Map<String,Serializable> attributes) Create a KeyValueDataList with attributes.
KeyValueDataList(String key) Create a KeyValueDataList with a key.
KeyValueDataList(String key, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp) Create a KeyValueDataList with a key and a time stamp.
KeyValueDataList(String key, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, Map<String,Serializable> attributes) Create a KeyValueDataList with a key and a time stamp.
KeyValueDataList(String key, Map<String,Serializable> attributes) Create a KeyValueDataList with a key.The time stamp is by default the object creation time.

Method Summary

Modifier and Type	Method and Description
void	addData(KeyValueData data) Add a KeyValueData object to the KeyValueDataList.
void	addData(String key, Serializable value) Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList.
void	addData(String key, Serializable value, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp) Add a key-value pair with a CCS timestamp to this KeyValueDataList.
void	addData(String key, Serializable value, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, KeyValueData.KeyValueDataType type) Add a key-value pair with a CCS timestamp to this KeyValueDataList.
void	addData(String key, Serializable value, KeyValueData.KeyValueDataType type) Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList.
Serializable	getAttribute(String name) Get the value of the provided attribute name.
Map<String,Serializable>	getAttributes() Get all the data attributes.
List<KeyValueData>	getListOfKeyValueData() Get the list of KeyValueData contained in this object.
List<KeyValueData>	getListOfKeyValueData(KeyValueData.KeyValueDataType type) Get the list of KeyValueData contained in this object for a given type.
Iterator<KeyValueData>	iterator()
String	toString()

Methods inherited from class org.lsst.ccs.bus.data.KeyValueData

getCCSTimeStamp, getKey, getType, getValue, needsEncoding, updateNeedsEncoding

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyValueDataList

public KeyValueDataList()

Create a KeyValueDataList without a key or a timestamp. By default the key is assigned the empty String, while the time stamp is that of the object creation. The value of this KeyValueData is a List<KeyValueData>

KeyValueDataList

public KeyValueDataList(Map<String,Serializable> attributes)

Create a KeyValueDataList with attributes. By default the key is assigned the empty String, while the time stamp is that of the object creation. The value of this KeyValueData is a List<KeyValueData>

Parameters:

attributes - The Map of attributes

KeyValueDataList

public KeyValueDataList(String key)

Create a KeyValueDataList with a key. The time stamp is by default the object creation time. The value of this KeyValueData is a List<KeyValueData>

Parameters:

key - The list's key. See the remarks about this key in the class description.

KeyValueDataList

public KeyValueDataList(String key,
                        Map<String,Serializable> attributes)

Create a KeyValueDataList with a key.The time stamp is by default the object creation time. The value of this KeyValueData is a List<KeyValueData>

Parameters:

key - The list's key. See the remarks about this key in the class description.

attributes - The Map of attributes

KeyValueDataList

public KeyValueDataList(String key,
                        org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp)

Create a KeyValueDataList with a key and a time stamp. The value of this KeyValueData is a List<KeyValueData>

Parameters:

key - The list's key. See the remarks about this key in the class description.

ccsTimeStamp - The key-value pair ccsTimeStamp.

KeyValueDataList

public KeyValueDataList(String key,
                        org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp,
                        Map<String,Serializable> attributes)

Create a KeyValueDataList with a key and a time stamp. The value of this KeyValueData is a List<KeyValueData>

Parameters:

key - The list's key. See the remarks about this key in the class description.

ccsTimeStamp - The key-value pair ccsTimeStamp.

attributes - The Map of attributes

KeyValueDataList

public KeyValueDataList(org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp)

Create a KeyValueDataList with a ccs time stamp. The key is assigned by default the empty String. The value of this KeyValueData is a List<KeyValueData>

Parameters:

ccsTimeStamp - The key-value pair ccs timestamp.

Method Detail

getAttribute

public Serializable getAttribute(String name)

Get the value of the provided attribute name.

Parameters:

name - The name of the attribute

Returns:

The attribute's value. null if there is no such attribute.

getAttributes

public Map<String,Serializable> getAttributes()

Get all the data attributes.

Returns:

The data attributes.

addData

public void addData(String key,
                    Serializable value)

Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList. Internally the pair is stored in a KeyValueData object. The default type is KeyValueData.KeyValueDataType.KeyValueTrendingData

Parameters:

key - The key of the pair.

value - The value of the pair.

addData

public void addData(String key,
                    Serializable value,
                    KeyValueData.KeyValueDataType type)

Add a key-value pair to this KeyValueDataList by assigning it the timestamp of the KeyDataList. Internally the pair is stored in a KeyValueData object.

Parameters:

key - The key of the pair.

value - The value of the pair.

type - The type of the KeyValueData to add.

addData

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

Add a key-value pair with a CCS timestamp to this KeyValueDataList. Internally the pair is stored in a KeyValueData object. The default type is KeyValueData.KeyValueDataType.KeyValueTrendingData

Parameters:

key - The key of the pair.

value - The value of the pair.

ccsTimeStamp - The ccsTimeStamp associated to the pair.

addData

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

Add a key-value pair with a CCS timestamp to this KeyValueDataList. Internally the pair is stored in a KeyValueData object.

Parameters:

key - The key of the pair.

value - The value of the pair.

ccsTimeStamp - The CCS timestamp associated to the pair.

type - The type of the KeyValueData to add.

getListOfKeyValueData

public List<KeyValueData> getListOfKeyValueData()

Get the list of KeyValueData contained in this object.

Returns:

The list of KeyValueData.

getListOfKeyValueData

public List<KeyValueData> getListOfKeyValueData(KeyValueData.KeyValueDataType type)

Get the list of KeyValueData contained in this object for a given type.

Parameters:

type - The KeyValueDataType for which the data is required.

Returns:

The list of KeyValueData that match the provided type.

addData

public void addData(KeyValueData data)

Add a KeyValueData object to the KeyValueDataList.

Parameters:

data - The KeyValueData object to add to the KeyValueDataList.

iterator

public Iterator<KeyValueData> iterator()

Specified by:

iterator in interface Iterable<KeyValueData>

toString

public String toString()

Overrides:

toString in class KeyValueData