Tuple

All Known Implementing Classes:

Twister2Tuple
```
public interface Tuple
```
The tuple is the main data structure in Storm. A tuple is a named list of values, where each value can be any type. Tuples are dynamically typed -- the types of the fields do not need to be declared. Tuples have helper methods like getInteger and getString to get field values without having to cast the result.
Storm needs to know how to serialize all the values in a tuple. By default, Storm knows how to serialize the primitive types, strings, and byte arrays. If you want to use another type, you'll need to implement and register a serializer for that type.

See Also:

Storm serialization

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`contains(java.lang.String field)` Returns true if this tuple contains the specified name of the field.
`int`	`fieldIndex(java.lang.String field)` Returns the position of the specified field in this tuple.
`byte[]`	`getBinary(int i)` Returns the byte array at position i in the tuple.
`byte[]`	`getBinaryByField(java.lang.String field)` Gets the Byte array field with a specific name.
`java.lang.Boolean`	`getBoolean(int i)` Returns the Boolean at position i in the tuple.
`java.lang.Boolean`	`getBooleanByField(java.lang.String field)` Gets the Boolean field with a specific name.
`java.lang.Byte`	`getByte(int i)` Returns the Byte at position i in the tuple.
`java.lang.Byte`	`getByteByField(java.lang.String field)` Gets the Byte field with a specific name.
`java.lang.Double`	`getDouble(int i)` Returns the Double at position i in the tuple.
`java.lang.Double`	`getDoubleByField(java.lang.String field)` Gets the Double field with a specific name.
`Fields`	`getFields()` Gets the names of the fields in this tuple.
`java.lang.Float`	`getFloat(int i)` Returns the Float at position i in the tuple.
`java.lang.Float`	`getFloatByField(java.lang.String field)` Gets the Float field with a specific name.
`java.lang.Integer`	`getInteger(int i)` Returns the Integer at position i in the tuple.
`java.lang.Integer`	`getIntegerByField(java.lang.String field)` Gets the Integer field with a specific name.
`java.lang.Long`	`getLong(int i)` Returns the Long at position i in the tuple.
`java.lang.Long`	`getLongByField(java.lang.String field)` Gets the Long field with a specific name.
`java.lang.Short`	`getShort(int i)` Returns the Short at position i in the tuple.
`java.lang.Short`	`getShortByField(java.lang.String field)` Gets the Short field with a specific name.
`java.lang.String`	`getSourceComponent()` Gets the id of the component that created this tuple.
`GlobalStreamId`	`getSourceGlobalStreamId()` Returns the global stream id (component + stream) of this tuple.
`java.lang.String`	`getSourceStreamId()` Gets the id of the stream that this tuple was emitted to.
`int`	`getSourceTask()` Gets the id of the task that created this tuple.
`java.lang.String`	`getString(int i)` Returns the String at position i in the tuple.
`java.lang.String`	`getStringByField(java.lang.String field)` Gets the String field with a specific name.
`java.lang.Object`	`getValue(int i)` Gets the field at position i in the tuple.
`java.lang.Object`	`getValueByField(java.lang.String field)` Gets the field with a specific name.
`java.util.List<java.lang.Object>`	`getValues()` Gets all the values in this tuple.
`void`	`resetValues()` Resets the tuple values to null TODO:- Is this needed
`java.util.List<java.lang.Object>`	`select(Fields selector)` Returns a subset of the tuple based on the fields selector.
`int`	`size()` Returns the number of fields in this tuple.

- Method Detail
  - size
```
int size()
```
    Returns the number of fields in this tuple.
  - contains
```
boolean contains(java.lang.String field)
```
    Returns true if this tuple contains the specified name of the field.
  - getFields
```
Fields getFields()
```
    Gets the names of the fields in this tuple.
  - fieldIndex
```
int fieldIndex(java.lang.String field)
```
    Returns the position of the specified field in this tuple.
    
    Throws:
    
    java.lang.IllegalArgumentException - - if field does not exist
  - select
```
java.util.List<java.lang.Object> select(Fields selector)
```
    Returns a subset of the tuple based on the fields selector.
  - getValue
```
java.lang.Object getValue(int i)
```
    Gets the field at position i in the tuple. Returns object since tuples are dynamically typed.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getString
```
java.lang.String getString(int i)
```
    Returns the String at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a String
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getInteger
```
java.lang.Integer getInteger(int i)
```
    Returns the Integer at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Integer
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getLong
```
java.lang.Long getLong(int i)
```
    Returns the Long at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Long
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getBoolean
```
java.lang.Boolean getBoolean(int i)
```
    Returns the Boolean at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Boolean
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getShort
```
java.lang.Short getShort(int i)
```
    Returns the Short at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Short
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getByte
```
java.lang.Byte getByte(int i)
```
    Returns the Byte at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Byte
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getDouble
```
java.lang.Double getDouble(int i)
```
    Returns the Double at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Double
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getFloat
```
java.lang.Float getFloat(int i)
```
    Returns the Float at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Float
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getBinary
```
byte[] getBinary(int i)
```
    Returns the byte array at position i in the tuple.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a byte array
    
    java.lang.IndexOutOfBoundsException - - if the index is out of range `(index < 0 || index >= size())`
  - getValueByField
```
java.lang.Object getValueByField(java.lang.String field)
```
    Gets the field with a specific name. Returns object since tuples are dynamically typed.
    
    Throws:
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getStringByField
```
java.lang.String getStringByField(java.lang.String field)
```
    Gets the String field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a String
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getIntegerByField
```
java.lang.Integer getIntegerByField(java.lang.String field)
```
    Gets the Integer field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not an Integer
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getLongByField
```
java.lang.Long getLongByField(java.lang.String field)
```
    Gets the Long field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Long
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getBooleanByField
```
java.lang.Boolean getBooleanByField(java.lang.String field)
```
    Gets the Boolean field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Boolean
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getShortByField
```
java.lang.Short getShortByField(java.lang.String field)
```
    Gets the Short field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Short
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getByteByField
```
java.lang.Byte getByteByField(java.lang.String field)
```
    Gets the Byte field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Byte
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getDoubleByField
```
java.lang.Double getDoubleByField(java.lang.String field)
```
    Gets the Double field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Double
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getFloatByField
```
java.lang.Float getFloatByField(java.lang.String field)
```
    Gets the Float field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a Float
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getBinaryByField
```
byte[] getBinaryByField(java.lang.String field)
```
    Gets the Byte array field with a specific name.
    
    Throws:
    
    java.lang.ClassCastException - If that field is not a byte array
    
    java.lang.IllegalArgumentException - - if field does not exist
  - getValues
```
java.util.List<java.lang.Object> getValues()
```
    Gets all the values in this tuple.
  - getSourceGlobalStreamId
```
GlobalStreamId getSourceGlobalStreamId()
```
    Returns the global stream id (component + stream) of this tuple.
  - getSourceComponent
```
java.lang.String getSourceComponent()
```
    Gets the id of the component that created this tuple.
  - getSourceTask
```
int getSourceTask()
```
    Gets the id of the task that created this tuple.
  - getSourceStreamId
```
java.lang.String getSourceStreamId()
```
    Gets the id of the stream that this tuple was emitted to.
  - resetValues
```
void resetValues()
```
    Resets the tuple values to null TODO:- Is this needed

Interface Tuple

Method Summary

Method Detail

size

contains

getFields

fieldIndex

select

getValue

getString

getInteger

getLong

getBoolean

getShort

getByte

getDouble

getFloat

getBinary

getValueByField

getStringByField

getIntegerByField

getLongByField

getBooleanByField

getShortByField

getByteByField

getDoubleByField

getFloatByField

getBinaryByField

getValues

getSourceGlobalStreamId

getSourceComponent

getSourceTask

getSourceStreamId

resetValues