org.systemsbiology.gaggle.core.datatypes
Class GaggleTuple

java.lang.Object
  extended by org.systemsbiology.gaggle.core.datatypes.GaggleTuple
All Implemented Interfaces:
java.io.Serializable, GaggleData

public class GaggleTuple
extends java.lang.Object
implements GaggleData

The top-level GaggleDataType for transmitting relatively-free form data structures. This replaces the old gaggle API which transmitted HashMap objects; the Tuple can do anything that a HashMap can do and more. Note that this object is actually composed of two Tuple objects, as the GaggleData interface requires one for metadata.

See Also:
Serialized Form

Constructor Summary
GaggleTuple()
           
 
Method Summary
 Tuple getData()
           
 Tuple getMetadata()
          Every GaggleData object contains a Tuple which can contain optional metadata.
 java.lang.String getName()
          Returns the name of this GaggleData object
 java.lang.String getSpecies()
          Returns the species of this GaggleData object
 void setData(Tuple data)
           
 void setMetadata(Tuple metadata)
           
 void setName(java.lang.String name)
           
 void setSpecies(java.lang.String species)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GaggleTuple

public GaggleTuple()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: GaggleData
Returns the name of this GaggleData object

Specified by:
getName in interface GaggleData
Returns:
the name of this GaggleData object

setName

public void setName(java.lang.String name)

getSpecies

public java.lang.String getSpecies()
Description copied from interface: GaggleData
Returns the species of this GaggleData object

Specified by:
getSpecies in interface GaggleData
Returns:
the species of this GaggleData object

setSpecies

public void setSpecies(java.lang.String species)

getData

public Tuple getData()

setData

public void setData(Tuple data)

getMetadata

public Tuple getMetadata()
Description copied from interface: GaggleData
Every GaggleData object contains a Tuple which can contain optional metadata. The Tuple is a general-purpose object which can hold data in many ways; it is up to the sending and receiving goose to put together and parse out the metadata from the Tuple.

Specified by:
getMetadata in interface GaggleData
Returns:
a Tuple containing optional metadata

setMetadata

public void setMetadata(Tuple metadata)