: Class SuperTuple

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.tspaces
Class SuperTuple

java.lang.Object
  |
  +--com.ibm.tspaces.SuperTuple

Direct Known Subclasses:: SubclassableTuple, Tuple

public abstract class SuperTuple
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A SuperTuple is an ordered sequence of Fields. Since it's abstract, any SuperTuple is actually either a Tuple or a SubclassableTuple.

Refer to the SuperTuple.matches() method for the matching algorithm for Tuples

Template Tuples:
Normally Tuples contain "Actual Fields that contain data and these Tuples are written to and taken from TupleSpaces.

But we also have Template Tuples that are used for matching Tuples to be retrieved. These Template Tuples have zero or more "Formal" Fields that contains only the class of the value that is to be matched.

 For Example:
    Tuple template = new Tuple("Key1",new Field(String.class));

The above would match any Tuple that contained "Key1" in the 1st Field and any String value in the 2nd and final Field.

We have defined a "Null Tuple" as a wildcard that matches all Tuples. A "Null Tuple" is a SuperTuple with no fields, not a null reference to a SuperTuple.
For Example: Tuple nullTuple = new Tuple();
Since Formal Fields match the class and any subclass, new Field(Serializable.class) can act as a wildcard for any one of the fields.

Another Example:

       TupleSpace ts = new TupleSpace("test");
       Tuple tuple = new Tuple("Key1","Data1");
       ts.write(tuple);
  
       Tuple template = new Tuple("Key1",new Field(String.class));
       Tuple result = ts.take(template);
       String data = rusult.getField(1).getValue();

Author:: Daniel Ford, Tobin Lehman, Stephen McLaughry, Peter Wyckoff, Ben Y. Zhao
See Also:: Tuple, SubclassableTuple, Field, TupleSpace, Serialized Form

Constructor Summary

SuperTuple()
          The default SuperTuple constructor.

SuperTuple(java.io.Serializable obj)
          Make a Tuple whose Field is the type and value of an Object.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2)
          Make a SuperTuple whose Fields are the type and value of Objects.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2, java.io.Serializable obj3)
          Make a SuperTuple whose Fields are the type and value of Objects.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2, java.io.Serializable obj3, java.io.Serializable obj4)
          Make a SuperTuple whose Fields are the type and value of Objects.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2, java.io.Serializable obj3, java.io.Serializable obj4, java.io.Serializable obj5)
          Make a SuperTuple whose Fields are the type and value of Objects.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2, java.io.Serializable obj3, java.io.Serializable obj4, java.io.Serializable obj5, java.io.Serializable obj6)
          Make a SuperTuple whose Fields are the type and value of Objects.

SuperTuple(java.io.Serializable obj1, java.io.Serializable obj2, java.io.Serializable obj3, java.io.Serializable obj4, java.io.Serializable obj5, java.io.Serializable obj6, java.io.Serializable obj7)
          Make a SuperTuple whose Fields are the type and value of Objects.

Method Summary

void add(java.lang.Class class_)
          Add a Field with the Class as its type (this is a "Formal" Field).

void add(double d_)
          Add a Field for the integral type "double" by wrapping it as a Double.

void add(Field f_)
          Add a Field to the SuperTuple.

void add(float f_)
          Add a Field for the integral type "float" by wrapping it as a Float.

void add(int i_)
          Add a Field for the integral type "int" by wrapping it as an Integer.

void add(long l_)
          Add a Field for the integral type "long" by wrapping it as an Long.

void add(java.io.Serializable obj_)
          Add a Field with the Object as its value.

void add(java.lang.String value_)
          Add a String Field to the Tuple.

void add(java.lang.String name, java.lang.Class t)
          Add a named Field with the Class as its type (this is a "Formal" Field).

void add(java.lang.String name, double d_)
          Add a named Field for the integral type "double" by wrapping it as a Double.

void add(java.lang.String name, float f_)
          Add a named Field for the integral type "float" by wrapping it as a Float.

void add(java.lang.String name, int i_)
          Add a named Field for the integral type "int" by wrapping it as an Integer.

void add(java.lang.String name, long l_)
          Add a Field for the integral type "long" by wrapping it as an Long.

void add(java.lang.String name, java.io.Serializable obj_)
          Add a named Field with the Object as its value.

void add(java.lang.String name, java.lang.String value_)
          Add a named String Field Tuple

void addFieldType(int orValue)


void changeName(java.lang.String oldName, java.lang.String newName)
          Change the name of the named field.

java.lang.Object clone()
          Return a clone of the this SuperTuple.

boolean equals(java.lang.Object t_)
          Return true if the specified Tuple is equal to this Tuple.

boolean fieldExists(java.lang.String name)
          Return true if the named Field exists in the Tuple.

java.util.Enumeration fields()
          Return an enumeration of the Fields in the Tuple.

long getExpire()
          Get the Expire time interval (ms) of the Tuple

Field getField(int i)
          Return the i'th Field in the Tuple.

Field getField(java.lang.String name)
          Return a named Field in the Tuple.

int getFieldType()


long getTimeStamp()
          Get the timeStamp of when the Tuple was written into the TupleSpace on the server.

TupleID getTupleID()
          The UniqueId for a SuperTuple

boolean isExpired()
          Return true if the current time is greater than the Tuple (_timeStamp + _expire) Normally this should only be done by the server since the _timestamp is set by the server and the client and server clocks may not be in sync.

boolean matches(SuperTuple t_)
          Return true if the specified Tuple matches this Tuple.

int numberOfFields()
          Return the number of fields in the Tuple.

void putField(int i, Field f)
          Insert the specified Field at the indicated position i.

void setExpire(long time)
          Set the _expire value.

void setField(int i, Field f)
          replace the specified Field at the indicated position i.

protected void setFields(java.util.Vector fields)
          Reset the Vector that contains the Fields Used to clone the SuperTuple Since clients should not be aware of this Vector this must be a protected field.

void setFormal(int i)
          Deprecated. Use the form setFormal(i,true)

void setFormal(int i, boolean setting)
          Set the indexed Field to the specified formal setting

void setFormal(java.lang.String name)
          Deprecated. Use the form setFormal(name,true)

void setFormal(java.lang.String name, boolean setting)
          Set the named Field to the specified formal setting

void setName(int i, java.lang.String name)
          Set the name of the indexed Field.

void setTimeStamp(long time)
          Set the TimeStamp value.

void setTupleID(TupleID id)
          Assign to the unique id.

void setType(int i, java.lang.Class t)
          Set the type of a indexed field to the specified Class.

void setType(java.lang.String name, java.lang.Class t)
          Set the type of a named field to the Specified Class.

void setValue(int i, java.io.Serializable v)
          Set the value of a field to the Object passed.

void setValue(java.lang.String name, java.io.Serializable v)
          Set the value of a named field to the Object passed.

java.lang.String structureName()
          Return a string representation of the Tuple's structure.

boolean template()
          Deprecated. Since we no longer differentiate between "formal" and "actual" tuples, this is no longer useful.

java.lang.String toString()
          Return a string representation of the Tuple.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SuperTuple

public SuperTuple()

The default SuperTuple constructor. Constructs a NULL SuperTuple, one with no Fields. Subsequent Fields can be added with the "add" method.

See Also:: add(com.ibm.tspaces.Field)

SuperTuple

public SuperTuple(java.io.Serializable obj)
           throws TupleSpaceException

Make a Tuple whose Field is the type and value of an Object. If the object itself is a Field, then it will be used as the Field and not as the Field's value.

Parameters:: obj - the value of the first Field of the Tuple.