org.lsst.ccs.bus.messages

Class EncodedDataStatus

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

org.lsst.ccs.bus.messages.StatusMessage<T,KeyValueDataList>

org.lsst.ccs.bus.messages.StatusData

org.lsst.ccs.bus.messages.StatusSubsystemData

org.lsst.ccs.bus.messages.EncodedDataStatus

All Implemented Interfaces:

Serializable, Iterable<EncodedDataStatus>

Deprecated.

@Deprecated
public class EncodedDataStatus
extends StatusSubsystemData
implements Iterable<EncodedDataStatus>

Status with additional information. 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

Constructor Summary

Constructors

Constructor and Description
EncodedDataStatus(KVList content) Deprecated.
EncodedDataStatus(long timestampArg, KVList content) Deprecated.
EncodedDataStatus(long timestamp, String key, Object value) Deprecated.
EncodedDataStatus(String key, Object value) Deprecated.

Method Summary

Modifier and Type	Method and Description
static EncodedDataStatus	addData(EncodedDataStatus current, long timeStamp, String name, Object value) Deprecated.
void	addStatus(EncodedDataStatus next) Deprecated.
protected KeyValueDataList	encodeObject(Serializable obj) Deprecated. Subclasses must provide a specific implementation of the encoding process.
boolean	equals(Object obj) Deprecated.
KVList	getContent() Deprecated.
long	getDataTimestamp() Deprecated.
Object	getEmbeddedObject() Deprecated.
KeyValueDataList	getEncodedData() Deprecated. Get the Encoded version of the embedded Object.
String	getKey() Deprecated.
int	hashCode() Deprecated.
Iterator<EncodedDataStatus>	iterator() Deprecated. helps iterating over a list of linked status message.
void	setNext(EncodedDataStatus next) Deprecated.
String	toString() Deprecated.

Methods inherited from class org.lsst.ccs.bus.messages.StatusSubsystemData

getDataKey, getSubsystemData

Methods inherited from class org.lsst.ccs.bus.messages.StatusMessage

getSerializedObject, getState, setState

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

getClassName, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EncodedDataStatus

@Deprecated
public EncodedDataStatus(long timestampArg,
                                     KVList content)

Deprecated.

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

Parameters:

timestampArg -

content -

EncodedDataStatus

@Deprecated
public EncodedDataStatus(KVList content)

Deprecated.

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

Parameters:

content -

EncodedDataStatus

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

Deprecated.

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

Parameters:

timestamp -

key -

value -

EncodedDataStatus

@Deprecated
public EncodedDataStatus(String key,
                                     Object value)

Deprecated.

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

Parameters:

key -

value -

Method Detail

addStatus

@Deprecated
public void addStatus(EncodedDataStatus next)

Deprecated.

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

Parameters:

next -

setNext

@Deprecated
public void setNext(EncodedDataStatus next)

Deprecated.

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

Parameters:

next -

addData

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

Deprecated.

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:

getEncodedData

public KeyValueDataList getEncodedData()

Deprecated.

Description copied from class: BusMessage

Get the Encoded version of the embedded Object.

Overrides:

getEncodedData in class StatusData

Returns:

The Encoded version of the embedded Object.

iterator

public Iterator<EncodedDataStatus> iterator()

Deprecated.

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:

getKey

public String getKey()

Deprecated.

getContent

@Deprecated
public KVList getContent()

Deprecated.

getEmbeddedObject

@Deprecated
public Object getEmbeddedObject()

Deprecated.

getDataTimestamp

@Deprecated
public long getDataTimestamp()

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class StatusMessage

encodeObject

protected KeyValueDataList encodeObject(Serializable obj)

Deprecated.

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Overrides:

encodeObject in class StatusData

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Deprecated.

Overrides:

equals in class Object