All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.tspaces.SuperTuple

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

public abstract class SuperTuple
extends Object
implements Serializable

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

The standard matching algorithm for Tuples is based on structural equivalence. If two tuples (1) have the same number of Fields, (2) the fields are the same type, (3) fields with value (actuals) have the same value, and (4) fields without values (formals) are not matched against other formals, the tuples will match. For SubclassableTuples, the type (Class) of the target tuple must be a subclass of the Class of this tuple. (This implies that a Tuple will never match a SubclassableTuple, and vice versa.)

Author:: Daniel Ford, Tobin Lehman, Stephen McLaughry, Peter Wyckoff
See Also:: Tuple, SubclassableTuple, Field, TupleSpace

SuperTuple(): The default SuperTuple constructor.
SuperTuple(Serializable): Make a Tuple whose Field is the type and value of an Object.
SuperTuple(Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.
SuperTuple(Serializable, Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.
SuperTuple(Serializable, Serializable, Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.
SuperTuple(Serializable, Serializable, Serializable, Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.
SuperTuple(Serializable, Serializable, Serializable, Serializable, Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.
SuperTuple(Serializable, Serializable, Serializable, Serializable, Serializable, Serializable, Serializable): Make a SuperTuple whose Fields are the type and value of Objects.

add(Class): Add a Field with the Class as its type (this is a "Formal" Field).
add(double): Add a Field for the integral type "double" by wrapping it as a Double.
add(Field): Add a Field to the SuperTuple.
add(float): Add a Field for the integral type "float" by wrapping it as a Float.
add(int): Add a Field for the integral type "int" by wrapping it as an Integer.
add(long): Add a Field for the integral type "long" by wrapping it as an Long.
add(Serializable): Add a Field with the Object as its value.
add(String): Add a String Field to the Tuple.
add(String, Class): Add a named Field with the Class as its type (this is a "Formal" Field).
add(String, double): Add a named Field for the integral type "double" by wrapping it as a Double.
add(String, float): Add a named Field for the integral type "float" by wrapping it as a Float.
add(String, int): Add a named Field for the integral type "int" by wrapping it as an Integer.
add(String, long): Add a Field for the integral type "long" by wrapping it as an Long.
add(String, Serializable): Add a named Field with the Object as its value.
add(String, String): Add a named String Field Tuple
changeName(String, String): Change the name of the named field.
debugOut(): Print a string representation of the Tuple to standard out
fieldExists(String): Return true if the named Field exists in the Tuple.
fields(): Return an enumeration of the Fields in the Tuple.
getField(int): Return the i'th Field in the Tuple.
getField(String): Return a named Field in the Tuple.
main(String[]): Test routine for Tuple
matches(SuperTuple): Return true if the specified Tuple matches this Tuple.
numberOfFields(): Return the number of fields in the Tuple.
printOn(PrintStream): Print the Fields of the Tuple on the PrintStream.
putField(Field, int): Set the i'th Field.
setFormal(int): Set the indexed Field to be formal
setFormal(String): Set the named Field to be formal
setName(String, int): Set the name of the indexed Field.
setType(String, Class): Set the type of a named field to the Class passed.
setValue(int, Serializable): Set the value of a field to the Object passed.
setValue(String, Serializable): Set the value of a named field to the Object passed.
structureName(): Return a string representation of the Tuple's structure.
template(): Return true if the Tuple is a template. Deprecated.
toString(): Return a string representation of the Tuple.
uniqueId()
uniqueId(int): Assign to the unique id.

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

SuperTuple

 public SuperTuple(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.

SuperTuple

 public SuperTuple(Serializable obj1,
                   Serializable obj2) throws TupleSpaceException