org.lsst.ccs.bus

Class EncodedDataStatus

java.lang.Object

org.lsst.ccs.bus.BusMessage

org.lsst.ccs.bus.Status

org.lsst.ccs.bus.EncodedDataStatus

All Implemented Interfaces:

Serializable, Iterable<EncodedDataStatus>, BusPayload

public class EncodedDataStatus
extends Status
implements Iterable<EncodedDataStatus>

Status with additional information.

This is a model for the next version of DataStatus_Deprecated

Instances of this class carry a set of data with a common dataTimeStamp. Each data in this set (of type KVList) is an object with a name. Each object is encoded in a KeyData structure.

Note: keep in mind that each element in the list is of the form Key-VALUE but the VALUE can be itself burst into a list of key-values (if it is a composite Object) (so do not confuse the keys!)

So for example you can have

• a single primitive value contained as KVList{KeyData{"MyInteger",666}}
• multiple primitive values contained as KVList{KeyData{"MyInteger",666}, KeyData{"MyString, "Hello"}}
• single or multiple values that can be of any type (composite objects should have some specific properties: be Serializable or be "decomposable" in a list of key-value pairs) as: KVList{KeyData{"MyInteger", 666}, i KeyData{"MyObject", CodedData{"org.lsst.ccs.MyType", , List{KeyData{"field1", 567}, KeyData{"field2", "world"}}}}} (in that case objects of type MyType have two fields: "field1" and "field2")
  the important thing here is that the object will be read as List{"MyObject.field1"=567, "MyObject.field2"="world"}

Methods encapsulate and simplify this analysis: for reading KeyData objects see corresponding documentation.

Instances of the current class can be "linked" together to be sent in a single message across the buses. This is used when one wants to publish different values with different timestamps in a same message.

Author:

bamade

See Also:

Serialized Form

Field Summary

Fields inherited from class org.lsst.ccs.bus.Status

state

Fields inherited from class org.lsst.ccs.bus.BusMessage

detailLevel, origin, priorityLevel, summary, timeStamp

Constructor Summary

Constructors

Constructor and Description
EncodedDataStatus(KVList content) creates a status with a list of Key-value pairs with the same timestamp which is generated at creation time.
EncodedDataStatus(long timestampArg, KVList content) creates a status with a list of Key-value pairs with the same timestamp
EncodedDataStatus(long timestamp, String key, Object value) creates a status with a single key and value (the timestamp is also provided)
EncodedDataStatus(String key, Object value) creates a status with a single key and value (the timestamp is generated)

Method Summary

Modifier and Type	Method and Description
static EncodedDataStatus	addData(EncodedDataStatus current, long timeStamp, String name, Object value) Static method that adds a new EncodedDataStatus(timestamp, name, value) to the current parameter.
void	addStatus(EncodedDataStatus next) adds another status at the end of the linked list of status sent in a single message
KVList	getContent()
long	getDataTimestamp()
Iterator<EncodedDataStatus>	iterator() helps iterating over a list of linked status message.
void	setNext(EncodedDataStatus next) links another status next to this one (for sending a batch of status in a single message)
String	toString()

Methods inherited from class org.lsst.ccs.bus.Status

getAgent, getMessageType, getState, setAgent, setState

Methods inherited from class org.lsst.ccs.bus.BusMessage

getDetailLevel, getOrigin, getPriorityLevel, getSummary, getTimeStamp, setDetailLevel, setOrigin, setPriorityLevel, setSummary, setTimeStamp

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

EncodedDataStatus

public EncodedDataStatus(long timestampArg,
                         KVList content)

creates a status with a list of Key-value pairs with the same timestamp

Parameters:

timestampArg -

content -

EncodedDataStatus

public EncodedDataStatus(KVList content)

creates a status with a list of Key-value pairs with the same timestamp which is generated at creation time.

Parameters:

content -

EncodedDataStatus

public EncodedDataStatus(long timestamp,
                         String key,
                         Object value)

creates a status with a single key and value (the timestamp is also provided)

Parameters:

timestamp -

key -

value -

EncodedDataStatus

public EncodedDataStatus(String key,
                         Object value)

creates a status with a single key and value (the timestamp is generated)

Parameters:

key -

value -

Method Detail

addStatus

public void addStatus(EncodedDataStatus next)

adds another status at the end of the linked list of status sent in a single message

Parameters:

next -

setNext

public void setNext(EncodedDataStatus next)

links another status next to this one (for sending a batch of status in a single message)

Parameters:

next -

addData

public static EncodedDataStatus addData(EncodedDataStatus current,
                                        long timeStamp,
                                        String name,
                                        Object value)

Static method that adds a new EncodedDataStatus(timestamp, name, value) to the current parameter.

Parameters:

current - The Status we want to add data to (can be null)

timeStamp -

name -

value -

Returns:

iterator

public Iterator<EncodedDataStatus> iterator()

helps iterating over a list of linked status message.

So an idiom to read a message can be:

     EncodedDataStatus received = ..... ;
     for (EncodedDataStatus dataStatus : received) {
          KVList list = dataStatus.getContent();
          for (KeyData keyData : list) {
               .... dataStatus.getDataTimestamp() ....
              .... keyData.getKey() ....
              // one of those Three options
              .... keyData.getValue() .... // Optional
              .... keyData.getContentAsList() ....// may be empty
              .... keyData.getCrystallizedData() .... // Optional
          }
      }
 

Specified by:

iterator in interface Iterable<EncodedDataStatus>

Returns:

getContent

public KVList getContent()

getDataTimestamp

public long getDataTimestamp()

toString

public String toString()

Overrides:

toString in class Status