Tuple

All Known Implementing Classes:

TupleImpl
```
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)`
`java.lang.Boolean`	`getBoolean(int i)` Returns the Boolean at position i in the tuple.
`java.lang.Boolean`	`getBooleanByField(java.lang.String field)`
`java.lang.Byte`	`getByte(int i)` Returns the Byte at position i in the tuple.
`java.lang.Byte`	`getByteByField(java.lang.String field)`
`java.lang.Double`	`getDouble(int i)` Returns the Double at position i in the tuple.
`java.lang.Double`	`getDoubleByField(java.lang.String field)`
`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)`
`java.lang.Integer`	`getInteger(int i)` Returns the Integer at position i in the tuple.
`java.lang.Integer`	`getIntegerByField(java.lang.String field)`
`java.lang.Long`	`getLong(int i)` Returns the Long at position i in the tuple.
`java.lang.Long`	`getLongByField(java.lang.String field)`
`java.lang.Short`	`getShort(int i)` Returns the Short at position i in the tuple.
`java.lang.Short`	`getShortByField(java.lang.String field)`
`java.lang.String`	`getSourceComponent()` Gets the id of the component that created 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)`
`java.lang.Object`	`getValue(int i)` Gets the field at position i in the tuple.
`java.lang.Object`	`getValueByField(java.lang.String field)`
`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.
  - fieldIndex
```
int fieldIndex(java.lang.String field)
```
    Returns the position of the specified field in this tuple.
  - contains
```
boolean contains(java.lang.String field)
```
    Returns true if this tuple contains the specified name of the field.
  - getValue
```
java.lang.Object getValue(int i)
```
    Gets the field at position i in the tuple. Returns object since tuples are dynamically typed.
  - getString
```
java.lang.String getString(int i)
```
    Returns the String at position i in the tuple. If that field is not a String, you will get a runtime error.
  - getInteger
```
java.lang.Integer getInteger(int i)
```
    Returns the Integer at position i in the tuple. If that field is not an Integer, you will get a runtime error.
  - getLong
```
java.lang.Long getLong(int i)
```
    Returns the Long at position i in the tuple. If that field is not a Long, you will get a runtime error.
  - getBoolean
```
java.lang.Boolean getBoolean(int i)
```
    Returns the Boolean at position i in the tuple. If that field is not a Boolean, you will get a runtime error.
  - getShort
```
java.lang.Short getShort(int i)
```
    Returns the Short at position i in the tuple. If that field is not a Short, you will get a runtime error.
  - getByte
```
java.lang.Byte getByte(int i)
```
    Returns the Byte at position i in the tuple. If that field is not a Byte, you will get a runtime error.
  - getDouble
```
java.lang.Double getDouble(int i)
```
    Returns the Double at position i in the tuple. If that field is not a Double, you will get a runtime error.
  - getFloat
```
java.lang.Float getFloat(int i)
```
    Returns the Float at position i in the tuple. If that field is not a Float, you will get a runtime error.
  - getBinary
```
byte[] getBinary(int i)
```
    Returns the byte array at position i in the tuple. If that field is not a byte array, you will get a runtime error.
  - getValueByField
```
java.lang.Object getValueByField(java.lang.String field)
```
  - getStringByField
```
java.lang.String getStringByField(java.lang.String field)
```
  - getIntegerByField
```
java.lang.Integer getIntegerByField(java.lang.String field)
```
  - getLongByField
```
java.lang.Long getLongByField(java.lang.String field)
```
  - getBooleanByField
```
java.lang.Boolean getBooleanByField(java.lang.String field)
```
  - getShortByField
```
java.lang.Short getShortByField(java.lang.String field)
```
  - getByteByField
```
java.lang.Byte getByteByField(java.lang.String field)
```
  - getDoubleByField
```
java.lang.Double getDoubleByField(java.lang.String field)
```
  - getFloatByField
```
java.lang.Float getFloatByField(java.lang.String field)
```
  - getBinaryByField
```
byte[] getBinaryByField(java.lang.String field)
```
  - getValues
```
java.util.List<java.lang.Object> getValues()
```
    Gets all the values in this tuple.
  - getFields
```
Fields getFields()
```
    Gets the names of the fields in this tuple.
  - select
```
java.util.List<java.lang.Object> select(Fields selector)
```
    Returns a subset of the tuple based on the fields selector.
  - 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

fieldIndex

contains

getValue

getString

getInteger

getLong

getBoolean

getShort

getByte

getDouble

getFloat

getBinary

getValueByField

getStringByField

getIntegerByField

getLongByField

getBooleanByField

getShortByField

getByteByField

getDoubleByField

getFloatByField

getBinaryByField

getValues

getFields

select

getSourceComponent

getSourceTask

getSourceStreamId

resetValues