Data (Cilia :: Reactor 1.7.4 API)

java.lang.Object
- fr.liglab.adele.cilia.Data<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SerializedData
```
public class Data<T>
extends Object
implements Serializable
```
Data Used to encapsulate the data to be processed on the MediatorImpl. It has a 'content' of type Object, and a dictionary of extra informations (metadata). The values of the metadata cannot be null.

Author:

Cilia Project Team

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_CLASSNAME` Data Types.
`protected Hashtable<String,Object>`	`data` All the data will be stored in this Data dictionary.
`static String`	`DATA_CONTENT` Key to be used to obtain the data content.
`static String`	`DATA_ID` Key used to add or get the identifier unique of this data.
`static String`	`DATA_NAME` This name is not used as a key to obtain data content.
`static String`	`DATA_SOURCE` Key to obtain the data source.
`static String`	`DATA_TIMESTAMP` Date timespamp.
`static String`	`DATA_TYPE` Key to obtain the data type.
`protected ReadWriteLock`	`lock` The lock used to keep data integrity.
`static String`	`RETURN_ADDRESS` Return address.

Constructor Summary

Constructors
Constructor and Description
`Data(T content)` Constructor
`Data(T content, String name)` Constructor
`Data(T content, String name, Dictionary metadata)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Return an exact copy of the given data.
`Object`	`get(Object key)` Deprecated.
`Dictionary`	`getAllData()` Get data content plus all the metadata associated to it.
`T`	`getContent()` Get the content
`String`	`getId()`
`String`	`getLastDeliveryPort()` Get the data source
`String`	`getLastReceivingPort()` Get the data source
`String`	`getName()` Get the data name
`Object`	`getProperty(String key)` Get a metadata
`Object`	`getTimestamp()` Get data timestamp
`String`	`getType()` Get data type
`boolean`	`hasContent()`
`void`	`removeProperty(String key)` Remove a metadata
`void`	`setContent(T content)` Set the data content
`void`	`setId(String id)` Set the identificator used to route message.
`void`	`setLastDeliveryPort(String port)` Set the data source
`void`	`setLastReceivingPort(String port)` Set the data source
`void`	`setProperty(String key, Object value)` Add a metadata
`void`	`setType(String type)` Set the data type
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - data
```
protected Hashtable<String,Object> data
```
    All the data will be stored in this Data dictionary.
  - lock
```
protected transient ReadWriteLock lock
```
    The lock used to keep data integrity.
  - DATA_NAME
```
public static final String DATA_NAME
```
    This name is not used as a key to obtain data content. The only purpose is to have a data identifier. Once set, the data.name property cannot be changed. If no data name is specified at creation time, the default "data" name is used.
    Type : String.
    
    See Also:
    Constant Field Values
  - DATA_CONTENT
```
public static final String DATA_CONTENT
```
    Key to be used to obtain the data content.
    Type : Object.
    
    See Also:
    Constant Field Values
  - DATA_TYPE
```
public static final String DATA_TYPE
```
    Key to obtain the data type.
    Type : String.
    
    See Also:
    Constant Field Values
  - DATA_SOURCE
```
public static final String DATA_SOURCE
```
    Key to obtain the data source.
    Type : String.
    
    See Also:
    Constant Field Values
  - DATA_TIMESTAMP
```
public static final String DATA_TIMESTAMP
```
    Date timespamp. The data.timestamp property is automatically set when the data is created and cannot be changed.
    Type : java.util.Date.
    
    See Also:
    Constant Field Values
  - DATA_ID
```
public static final String DATA_ID
```
    Key used to add or get the identifier unique of this data.
    Type : String.
    
    See Also:
    Constant Field Values
  - CONTENT_CLASSNAME
```
public static final String CONTENT_CLASSNAME
```
    Data Types. // Not used actually.
    
    See Also:
    Constant Field Values
  - RETURN_ADDRESS
```
public static final String RETURN_ADDRESS
```
    Return address.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Data
```
public Data(T content,
    String name,
    Dictionary metadata)
```
    Constructor.
    
    Parameters:
    content -
    name -
    metadata -
  - Data
```
public Data(T content)
```
    Constructor
    
    Parameters:
    content -
  - Data
```
public Data(T content,
    String name)
```
    Constructor
    
    Parameters:
    content -
    name -
- Method Detail
  - getProperty
```
public final Object getProperty(String key)
```
    Get a metadata
    
    Parameters:
    key -
    
    Returns:
  - setProperty
```
public final void setProperty(String key,
               Object value)
```
    Add a metadata
    
    Parameters:
    key -
    value -
  - removeProperty
```
public final void removeProperty(String key)
```
    Remove a metadata
    
    Parameters:
    key -
  - getAllData
```
public final Dictionary getAllData()
```
    Get data content plus all the metadata associated to it. Changes to the data are not propagated to the returned dictionary.
    
    Returns:
  - getContent
```
public final T getContent()
```
    Get the content
    
    Returns:
  - hasContent
```
public final boolean hasContent()
```
  - setContent
```
public final void setContent(T content)
```
    Set the data content
    
    Parameters:
    content -
  - getName
```
public final String getName()
```
    Get the data name
    
    Returns:
  - getLastReceivingPort
```
public final String getLastReceivingPort()
```
    Get the data source
    
    Returns:
  - setLastReceivingPort
```
public final void setLastReceivingPort(String port)
```
    Set the data source
    
    Parameters:
    port -
  - setLastDeliveryPort
```
public final void setLastDeliveryPort(String port)
```
    Set the data source
    
    Parameters:
    port -
  - getLastDeliveryPort
```
public final String getLastDeliveryPort()
```
    Get the data source
    
    Returns:
  - getTimestamp
```
public final Object getTimestamp()
```
    Get data timestamp
    
    Returns:
  - getType
```
public final String getType()
```
    Get data type
    
    Returns:
  - setType
```
public final void setType(String type)
```
    Set the data type
    
    Parameters:
    type -
  - setId
```
public final void setId(String id)
```
    Set the identificator used to route message.
    
    Parameters:
    id - identificator to set.
  - getId
```
public final String getId()
```
    Returns:
    ID setted before.
  - get
```
public final Object get(Object key)
```
    Deprecated.
    
    Parameters:
    key -
    
    Returns:
  - clone
```
public final Object clone()
```
    Return an exact copy of the given data. Changes to the given data are not propagated to the returned copy.
    
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Data<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

lock

DATA_NAME

DATA_CONTENT

DATA_TYPE

DATA_SOURCE

DATA_TIMESTAMP

DATA_ID

CONTENT_CLASSNAME

RETURN_ADDRESS

Constructor Detail

Data

Data

Data

Method Detail

getProperty

setProperty

removeProperty

getAllData

getContent

hasContent

setContent

getName

getLastReceivingPort

setLastReceivingPort

setLastDeliveryPort

getLastDeliveryPort

getTimestamp

getType

setType

setId

getId

get

clone

toString