Tuple

java.lang.Object
- com.tibco.as.space.Tuple

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>
```
public abstract class Tuple
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.Object>
```
Tuple stores data and consists of fields. Fields have either a name and a type. A tuple can be seen as a type of Map on which fields can be put or removed. A tuple can also be seen as a self-describing message. A tuple is platform independent and can be serialized and deserialized. When a Tuple is used in a Space operation, it is validated with the Space Definition as follows:
- All the non nullable key fields of the Space Definition should be present in the Tuple and their types should match
- In addition, for put and update type of operations:
  - Field names and type should match (or be of a type that can be automatically casted to the type of the field's definition)
  - Fields marked as nullable need not be present in the Tuple (but if they are present, their type must match or be of a type that can be automatically casted to the type of the field's definition)
(See the user guide for a table of supported automated castings) There is a get and put method for each type and an overloaded put method is also provided for convenience.
See Also:

Space

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Tuple()

Constructors
Constructor and Description
`Tuple()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`clear()` Removes all the fields in the Tuple
`abstract java.lang.Object`	`clone()` /**
`static Tuple`	`create()` Returns a new empty Tuple instance.
`static Tuple`	`create(int size)`
`abstract void`	`deserialize(byte[] buffer)` Deserialize the serialized version of tuple.
`abstract boolean`	`equals(java.lang.Object obj)`
`abstract boolean`	`exists(java.lang.String fieldname)` Given a field name, returns whether the field exists (is not null) or not.
`abstract java.lang.Object`	`get(java.lang.String fieldName)` Convenience function: given a name, returns the value as Object stored in the field with that name.
`abstract byte[]`	`getBlob(java.lang.String fieldName)` Given a name, returns the blob value stored in the field with that name.
`abstract java.lang.Boolean`	`getBoolean(java.lang.String fieldName)` Given a name, returns the boolean value stored in the field with that name.
`abstract java.lang.Character`	`getChar(java.lang.String fieldName)` Given a name, returns the char value stored in the field with that name.
`abstract DateTime`	`getDateTime(java.lang.String fieldName)` Given a name, returns the datetime value stored in the field with that name.
`abstract java.lang.Double`	`getDouble(java.lang.String fieldName)` Given a name, returns the double value stored in the field with that name.
`abstract java.util.Collection<java.lang.String>`	`getFieldNames()` Returns a collection of names of fields inside the Tuple.
`abstract FieldDef.FieldType`	`getFieldType(java.lang.String fieldName)` Return the type of the field given a name.
`abstract java.lang.Float`	`getFloat(java.lang.String fieldName)` Given a name, returns the float value stored in the field with that name.
`abstract java.lang.Integer`	`getInt(java.lang.String fieldName)` Given a name, returns the int value stored in the field with that name.
`abstract java.lang.Long`	`getLong(java.lang.String fieldName)` Given a name, returns the long value stored in the field with that name.
`abstract java.lang.Short`	`getShort(java.lang.String fieldName)` Given a name, returns the short value stored in the field with that name.
`abstract java.lang.String`	`getString(java.lang.String fieldName)` Given a name, returns the String value stored in the field with that name.
`abstract int`	`hashCode()`
`abstract boolean`	`isNull(java.lang.String fieldname)` Given a field name, returns whether the field is null (does not exist) or not.
`abstract java.lang.Object`	`put(java.lang.String fieldName, boolean value)` Given a name, stores the boolean value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, byte[] value)` Given a name, stores the blob value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, char value)` Given a name, stores the char value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, DateTime value)` Given a name, stores the datetime value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, double value)` Given a name, stores the double value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, float value)` Given a name, stores the float value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, int value)` Given a name, stores the int value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, long value)` Given a name, stores the long value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, short value)` Given a name, stores the short value in the field with that name.
`abstract java.lang.Object`	`put(java.lang.String fieldName, java.lang.String value)` Given a name, stores the String value in the field with that name.
`abstract void`	`putAll(Tuple tuple)` Puts a collection of fields into the tuple.
`abstract java.lang.Object`	`putBlob(java.lang.String fieldName, byte[] value)` Given a name, stores the blob value in the field with that name.
`abstract java.lang.Object`	`putBoolean(java.lang.String fieldName, boolean value)` Given a name, stores the boolean value in the field with that name.
`abstract java.lang.Object`	`putChar(java.lang.String fieldName, char value)` Given a name, stores the char value in the field with that name.
`abstract java.lang.Object`	`putDateTime(java.lang.String fieldName, DateTime value)` Given a name, stores the datetime value in the field with that name.
`abstract java.lang.Object`	`putDouble(java.lang.String fieldName, double value)` Given a name, stores the double value in the field with that name.
`abstract java.lang.Object`	`putFloat(java.lang.String fieldName, float value)` Given a name, stores the float value in the field with that name.
`abstract java.lang.Object`	`putInt(java.lang.String fieldName, int value)` Given a name, stores the int value in the field with that name.
`abstract java.lang.Object`	`putLong(java.lang.String fieldName, long value)` Given a name, stores the long value in the field with that name.
`abstract java.lang.Object`	`putShort(java.lang.String fieldName, short value)` Given a name, stores the short value in the field with that name.
`abstract java.lang.Object`	`putString(java.lang.String fieldName, java.lang.String value)` Given a name, stores the String value in the field with that name.
`abstract java.lang.Object`	`remove(java.lang.String fieldName)` Removes the value corresponding to the field name from Tuple.
`abstract byte[]`	`serialize()` Serializes the tuple.
`abstract int`	`size()` Returns the number of fields in the tuple.

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, values

- Constructor Detail
  - Tuple
```
public Tuple()
```
- Method Detail
  - create
```
public static Tuple create()
```
    Returns a new empty Tuple instance.
    
    Returns:
    
    Tuple the new Tuple instance
  - create
```
public static Tuple create(int size)
```
  - get
```
public abstract java.lang.Object get(java.lang.String fieldName)
```
    Convenience function: given a name, returns the value as Object stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    Object The value of the field or null if no field with that name exists in the Tuple
  - getBoolean
```
public abstract java.lang.Boolean getBoolean(java.lang.String fieldName)
```
    Given a name, returns the boolean value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    boolean The value of the field or null if no field with that name exists in the Tuple
  - getChar
```
public abstract java.lang.Character getChar(java.lang.String fieldName)
```
    Given a name, returns the char value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    char The value of the field or null if no field with that name exists in the Tuple
  - getShort
```
public abstract java.lang.Short getShort(java.lang.String fieldName)
```
    Given a name, returns the short value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    short The value of the field or null if no field with that name exists in the Tuple
  - getInt
```
public abstract java.lang.Integer getInt(java.lang.String fieldName)
```
    Given a name, returns the int value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    int The value of the field or null if no field with that name exists in the Tuple
  - getLong
```
public abstract java.lang.Long getLong(java.lang.String fieldName)
```
    Given a name, returns the long value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    long The value of the field or null if no field with that name exists in the Tuple
  - getFloat
```
public abstract java.lang.Float getFloat(java.lang.String fieldName)
```
    Given a name, returns the float value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    float The value of the field or null if no field with that name exists in the Tuple
  - getDouble
```
public abstract java.lang.Double getDouble(java.lang.String fieldName)
```
    Given a name, returns the double value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    double The value of the field or null if no field with that name exists in the Tuple
  - getString
```
public abstract java.lang.String getString(java.lang.String fieldName)
```
    Given a name, returns the String value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    String The value of the field or null if no field with that name exists in the Tuple
  - getDateTime
```
public abstract DateTime getDateTime(java.lang.String fieldName)
```
    Given a name, returns the datetime value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    DateTime The value of the field or null if no field with that name exists in the Tuple
  - getBlob
```
public abstract byte[] getBlob(java.lang.String fieldName)
```
    Given a name, returns the blob value stored in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    blob The value of the field or null if no field with that name exists in the Tuple
  - putBoolean
```
public abstract java.lang.Object putBoolean(java.lang.String fieldName,
                                            boolean value)
```
    Given a name, stores the boolean value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - true or false
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putChar
```
public abstract java.lang.Object putChar(java.lang.String fieldName,
                                         char value)
```
    Given a name, stores the char value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - char value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putShort
```
public abstract java.lang.Object putShort(java.lang.String fieldName,
                                          short value)
```
    Given a name, stores the short value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - short value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putInt
```
public abstract java.lang.Object putInt(java.lang.String fieldName,
                                        int value)
```
    Given a name, stores the int value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - integer value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putLong
```
public abstract java.lang.Object putLong(java.lang.String fieldName,
                                         long value)
```
    Given a name, stores the long value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - long value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putFloat
```
public abstract java.lang.Object putFloat(java.lang.String fieldName,
                                          float value)
```
    Given a name, stores the float value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - float value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putDouble
```
public abstract java.lang.Object putDouble(java.lang.String fieldName,
                                           double value)
```
    Given a name, stores the double value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - double value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putString
```
public abstract java.lang.Object putString(java.lang.String fieldName,
                                           java.lang.String value)
```
    Given a name, stores the String value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - String value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putDateTime
```
public abstract java.lang.Object putDateTime(java.lang.String fieldName,
                                             DateTime value)
```
    Given a name, stores the datetime value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - DateTime instance
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - putBlob
```
public abstract java.lang.Object putBlob(java.lang.String fieldName,
                                         byte[] value)
```
    Given a name, stores the blob value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - Any blob value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     boolean value)
```
    Given a name, stores the boolean value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - true or false
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     char value)
```
    Given a name, stores the char value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - char value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     short value)
```
    Given a name, stores the short value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - short value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     int value)
```
    Given a name, stores the int value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - integer value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     long value)
```
    Given a name, stores the long value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - long value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     float value)
```
    Given a name, stores the float value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - float value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     double value)
```
    Given a name, stores the double value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - double value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     java.lang.String value)
```
    Given a name, stores the String value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - String value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     DateTime value)
```
    Given a name, stores the datetime value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - DateTime instance
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - put
```
public abstract java.lang.Object put(java.lang.String fieldName,
                                     byte[] value)
```
    Given a name, stores the blob value in the field with that name.
    
    Parameters:
    
    fieldName - Name of field
    
    value - blob value
    
    Returns:
    
    Object return old value if it exists, null otherwise
  - clear
```
public abstract void clear()
```
    Removes all the fields in the Tuple
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.String,java.lang.Object>
  - remove
```
public abstract java.lang.Object remove(java.lang.String fieldName)
```
    Removes the value corresponding to the field name from Tuple.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    Object return old value, null if it does not exist
  - size
```
public abstract int size()
```
    Returns the number of fields in the tuple.
    
    Specified by:
    
    size in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Returns:
    
    int The number of fields in the tuple
  - serialize
```
public abstract byte[] serialize()
                          throws ASException
```
    Serializes the tuple.
    
    Returns:
    
    byte[] The serialized version of tuple
    
    Throws:
    
    ASException
  - deserialize
```
public abstract void deserialize(byte[] buffer)
                          throws ASException
```
    Deserialize the serialized version of tuple.
    
    Parameters:
    
    buffer - serialized version of tuple
    
    Throws:
    
    ASException
  - isNull
```
public abstract boolean isNull(java.lang.String fieldname)
```
    Given a field name, returns whether the field is null (does not exist) or not.
    
    Parameters:
    
    fieldname - Name of field
    
    Returns:
    
    boolean true is the field is null (does not exist), false otherwise
  - exists
```
public abstract boolean exists(java.lang.String fieldname)
```
    Given a field name, returns whether the field exists (is not null) or not.
    
    Parameters:
    
    fieldname - Name of field
    
    Returns:
    
    boolean true if the field exists, false otherwise
  - getFieldNames
```
public abstract java.util.Collection<java.lang.String> getFieldNames()
```
    Returns a collection of names of fields inside the Tuple. Field names are not necessarily in the same order as they are put.
    
    Returns:
    
    Collection of field names
  - getFieldType
```
public abstract FieldDef.FieldType getFieldType(java.lang.String fieldName)
```
    Return the type of the field given a name.
    
    Parameters:
    
    fieldName - Name of field
    
    Returns:
    
    FieldType The field type
  - putAll
```
public abstract void putAll(Tuple tuple)
```
    Puts a collection of fields into the tuple. Merges the fields of the provided incoming tuple into the current Tuple. If the field name of the incoming tuple matches the field inside the current Tuple, it overwrites the existing value.
    
    Parameters:
    
    tuple - incoming tuple
  - clone
```
public abstract java.lang.Object clone()
```
    /**
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    cloned tuple
  - equals
```
public abstract boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - object to compare to
    
    Returns:
    
    true if Tuples are equal, false otherwise
  - hashCode
```
public abstract int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    hashcode of the tuple

Class Tuple

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Tuple

Method Detail

create

create

get

getBoolean

getChar

getShort

getInt

getLong

getFloat

getDouble

getString

getDateTime

getBlob

putBoolean

putChar

putShort

putInt

putLong

putFloat

putDouble

putString

putDateTime

putBlob

put

put

put

put

put

put

put

put

put

put

clear

remove

size

serialize

deserialize

isNull

exists

getFieldNames

getFieldType

putAll

clone

equals

hashCode