info.aduna.gee.spectacle
Interface Entity

All Known Implementing Classes:

DefaultEntity, InternalJitEntity

public interface Entity

Entity is the interface for object that represent data from the underlying enterprise information systems.

Method Summary

void	addData(Object key, Object value) Add a piece of information to this Entity
void	addLabel(String label) Add a label to this entity.
void	addLabels(Set<String> labels) Add a set of labels to this entity.
void	addTransientData(Object key, Object value) Add a piece of transient information to this Entity.
Map<Object,Object>	getData()
Object	getData(Object key)
String	getDestination()
Object	getID()
Set<String>	getLabels()
Map<Object,Object>	getTransientData()
void	setData(Map<Object,Object> data) Set the entire set of data this Entity contains
void	setDestination(String destination) Set the destination (i.e.
void	setLabels(Set<String> labels) Set the set of labels for this entity.
void	setTransientData(Map<Object,Object> data) Set the entire set of transient data this Entity contains

Method Detail

getID

Object getID()

Returns:

the unique ID of this Entity

addData

void addData(Object key,
             Object value)

Add a piece of information to this Entity

Parameters:

key - the key used to store and retrieve the information

value - the information to add

addTransientData

void addTransientData(Object key,
                      Object value)

Add a piece of transient information to this Entity. Transient data is not returned in by getData(). For getData(key): if a key is used both non-transient and transient, the non-transient value is returned.

Parameters:

key - the key used to store and retrieve the information

value - the information to add

getData

Map<Object,Object> getData()

Returns:

the entire set of data this Entity contains

getTransientData

Map<Object,Object> getTransientData()

Returns:

the entire set of transient data this Entity contains

getData

Object getData(Object key)

Parameters:

key - the key with which to get a piece of information

Returns:

a piece of information from this Entity, or null

setData

void setData(Map<Object,Object> data)

Set the entire set of data this Entity contains

Parameters:

data - the new data

setTransientData

void setTransientData(Map<Object,Object> data)

Set the entire set of transient data this Entity contains

Parameters:

data - the new data

addLabel

void addLabel(String label)

Add a label to this entity.

Parameters:

label - the label to add

addLabels

void addLabels(Set<String> labels)

Add a set of labels to this entity.

Parameters:

labels - the set of labels to add

getLabels

Set<String> getLabels()

Returns:

the set of labels for this entity

setLabels

void setLabels(Set<String> labels)

Set the set of labels for this entity.

Parameters:

labels - the new set of labels

getDestination

String getDestination()

Returns:

the destination for this entity

setDestination

void setDestination(String destination)

Set the destination (i.e. the Section it will be stored in) for this entity.

Parameters:

destination - the new destination