TupleImpl

java.lang.Object
- backtype.storm.tuple.TupleImpl

All Implemented Interfaces:

Tuple
```
public class TupleImpl
extends java.lang.Object
implements 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

Constructor Summary

Constructors
Constructor and Description

TupleImpl(Tuple t)

Constructors
Constructor and Description
`TupleImpl(Tuple t)`

Method Summary

All Methods Instance Methods Concrete 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)`
`Tuple`	`getDelegate()`
`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.

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

- Constructor Detail
  - TupleImpl
```
public TupleImpl(Tuple t)
```
- Method Detail
  - getDelegate
```
public Tuple getDelegate()
```
  - size
```
public int size()
```
    Returns the number of fields in this tuple.
    
    Specified by:
    
    size in interface Tuple
  - fieldIndex
```
public int fieldIndex(java.lang.String field)
```
    Returns the position of the specified field in this tuple.
    
    Specified by:
    
    fieldIndex in interface Tuple
  - contains
```
public boolean contains(java.lang.String field)
```
    Returns true if this tuple contains the specified name of the field.
    
    Specified by:
    
    contains in interface Tuple
  - getValue
```
public java.lang.Object getValue(int i)
```
    Gets the field at position i in the tuple. Returns object since tuples are dynamically typed.
    
    Specified by:
    
    getValue in interface Tuple
  - getString
```
public 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.
    
    Specified by:
    
    getString in interface Tuple
  - getInteger
```
public 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.
    
    Specified by:
    
    getInteger in interface Tuple
  - getLong
```
public 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.
    
    Specified by:
    
    getLong in interface Tuple
  - getBoolean
```
public 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.
    
    Specified by:
    
    getBoolean in interface Tuple
  - getShort
```
public 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.
    
    Specified by:
    
    getShort in interface Tuple
  - getByte
```
public 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.
    
    Specified by:
    
    getByte in interface Tuple
  - getDouble
```
public 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.
    
    Specified by:
    
    getDouble in interface Tuple
  - getFloat
```
public 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.
    
    Specified by:
    
    getFloat in interface Tuple
  - getBinary
```
public 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.
    
    Specified by:
    
    getBinary in interface Tuple
  - getValueByField
```
public java.lang.Object getValueByField(java.lang.String field)
```
    Specified by:
    
    getValueByField in interface Tuple
  - getStringByField
```
public java.lang.String getStringByField(java.lang.String field)
```
    Specified by:
    
    getStringByField in interface Tuple
  - getIntegerByField
```
public java.lang.Integer getIntegerByField(java.lang.String field)
```
    Specified by:
    
    getIntegerByField in interface Tuple
  - getLongByField
```
public java.lang.Long getLongByField(java.lang.String field)
```
    Specified by:
    
    getLongByField in interface Tuple
  - getBooleanByField
```
public java.lang.Boolean getBooleanByField(java.lang.String field)
```
    Specified by:
    
    getBooleanByField in interface Tuple
  - getShortByField
```
public java.lang.Short getShortByField(java.lang.String field)
```
    Specified by:
    
    getShortByField in interface Tuple
  - getByteByField
```
public java.lang.Byte getByteByField(java.lang.String field)
```
    Specified by:
    
    getByteByField in interface Tuple
  - getDoubleByField
```
public java.lang.Double getDoubleByField(java.lang.String field)
```
    Specified by:
    
    getDoubleByField in interface Tuple
  - getFloatByField
```
public java.lang.Float getFloatByField(java.lang.String field)
```
    Specified by:
    
    getFloatByField in interface Tuple
  - getBinaryByField
```
public byte[] getBinaryByField(java.lang.String field)
```
    Specified by:
    
    getBinaryByField in interface Tuple
  - getValues
```
public java.util.List<java.lang.Object> getValues()
```
    Gets all the values in this tuple.
    
    Specified by:
    
    getValues in interface Tuple
  - getFields
```
public Fields getFields()
```
    Gets the names of the fields in this tuple.
    
    Specified by:
    
    getFields in interface Tuple
  - select
```
public java.util.List<java.lang.Object> select(Fields selector)
```
    Returns a subset of the tuple based on the fields selector.
    
    Specified by:
    
    select in interface Tuple
  - getSourceComponent
```
public java.lang.String getSourceComponent()
```
    Gets the id of the component that created this tuple.
    
    Specified by:
    
    getSourceComponent in interface Tuple
  - getSourceTask
```
public int getSourceTask()
```
    Gets the id of the task that created this tuple.
    
    Specified by:
    
    getSourceTask in interface Tuple
  - getSourceStreamId
```
public java.lang.String getSourceStreamId()
```
    Gets the id of the stream that this tuple was emitted to.
    
    Specified by:
    
    getSourceStreamId in interface Tuple
  - resetValues
```
public void resetValues()
```
    Resets the tuple values to null TODO:- Is this needed
    
    Specified by:
    
    resetValues in interface Tuple

Class TupleImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TupleImpl

Method Detail

getDelegate

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