org.apache.storm.tuple

Class Twister2Tuple

java.lang.Object

org.apache.storm.tuple.Twister2Tuple

All Implemented Interfaces:

Tuple

public class Twister2Tuple
extends java.lang.Object
implements Tuple

Constructor Summary

Constructors

Constructor and Description
Twister2Tuple(Fields fields, Values values, IMessage iMessage)

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Twister2Tuple

public Twister2Tuple(Fields fields,
                     Values values,
                     IMessage iMessage)

Method Detail

size

public int size()

Description copied from interface: Tuple

Returns the number of fields in this tuple.

Specified by:

size in interface Tuple

contains

public boolean contains(java.lang.String field)

Description copied from interface: Tuple

Returns true if this tuple contains the specified name of the field.

Specified by:

contains in interface Tuple

getFields

public Fields getFields()

Description copied from interface: Tuple

Gets the names of the fields in this tuple.

Specified by:

getFields in interface Tuple

fieldIndex

public int fieldIndex(java.lang.String field)

Description copied from interface: Tuple

Returns the position of the specified field in this tuple.

Specified by:

fieldIndex in interface Tuple

select

public java.util.List<java.lang.Object> select(Fields selector)

Description copied from interface: Tuple

Returns a subset of the tuple based on the fields selector.

Specified by:

select in interface Tuple

getValue

public java.lang.Object getValue(int i)

Description copied from interface: Tuple

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)

Description copied from interface: Tuple

Returns the String at position i in the tuple.

Specified by:

getString in interface Tuple

getInteger

public java.lang.Integer getInteger(int i)

Description copied from interface: Tuple

Returns the Integer at position i in the tuple.

Specified by:

getInteger in interface Tuple

getLong

public java.lang.Long getLong(int i)

Description copied from interface: Tuple

Returns the Long at position i in the tuple.

Specified by:

getLong in interface Tuple

getBoolean

public java.lang.Boolean getBoolean(int i)

Description copied from interface: Tuple

Returns the Boolean at position i in the tuple.

Specified by:

getBoolean in interface Tuple

getShort

public java.lang.Short getShort(int i)

Description copied from interface: Tuple

Returns the Short at position i in the tuple.

Specified by:

getShort in interface Tuple

getByte

public java.lang.Byte getByte(int i)

Description copied from interface: Tuple

Returns the Byte at position i in the tuple.

Specified by:

getByte in interface Tuple

getDouble

public java.lang.Double getDouble(int i)

Description copied from interface: Tuple

Returns the Double at position i in the tuple.

Specified by:

getDouble in interface Tuple

getFloat

public java.lang.Float getFloat(int i)

Description copied from interface: Tuple

Returns the Float at position i in the tuple.

Specified by:

getFloat in interface Tuple

getBinary

public byte[] getBinary(int i)

Description copied from interface: Tuple

Returns the byte array at position i in the tuple.

Specified by:

getBinary in interface Tuple

getValueByField

public java.lang.Object getValueByField(java.lang.String field)

Description copied from interface: Tuple

Gets the field with a specific name. Returns object since tuples are dynamically typed.

Specified by:

getValueByField in interface Tuple

getStringByField

public java.lang.String getStringByField(java.lang.String field)

Description copied from interface: Tuple

Gets the String field with a specific name.

Specified by:

getStringByField in interface Tuple

getIntegerByField

public java.lang.Integer getIntegerByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Integer field with a specific name.

Specified by:

getIntegerByField in interface Tuple

getLongByField

public java.lang.Long getLongByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Long field with a specific name.

Specified by:

getLongByField in interface Tuple

getBooleanByField

public java.lang.Boolean getBooleanByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Boolean field with a specific name.

Specified by:

getBooleanByField in interface Tuple

getShortByField

public java.lang.Short getShortByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Short field with a specific name.

Specified by:

getShortByField in interface Tuple

getByteByField

public java.lang.Byte getByteByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Byte field with a specific name.

Specified by:

getByteByField in interface Tuple

getDoubleByField

public java.lang.Double getDoubleByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Double field with a specific name.

Specified by:

getDoubleByField in interface Tuple

getFloatByField

public java.lang.Float getFloatByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Float field with a specific name.

Specified by:

getFloatByField in interface Tuple

getBinaryByField

public byte[] getBinaryByField(java.lang.String field)

Description copied from interface: Tuple

Gets the Byte array field with a specific name.

Specified by:

getBinaryByField in interface Tuple

getValues

public java.util.List<java.lang.Object> getValues()

Description copied from interface: Tuple

Gets all the values in this tuple.

Specified by:

getValues in interface Tuple

getSourceGlobalStreamId

public GlobalStreamId getSourceGlobalStreamId()

Description copied from interface: Tuple

Returns the global stream id (component + stream) of this tuple.

Specified by:

getSourceGlobalStreamId in interface Tuple

getSourceComponent

public java.lang.String getSourceComponent()

Description copied from interface: Tuple

Gets the id of the component that created this tuple.

Specified by:

getSourceComponent in interface Tuple

getSourceTask

public int getSourceTask()

Description copied from interface: Tuple

Gets the id of the task that created this tuple.

Specified by:

getSourceTask in interface Tuple

getSourceStreamId

public java.lang.String getSourceStreamId()

Description copied from interface: Tuple

Gets the id of the stream that this tuple was emitted to.

Specified by:

getSourceStreamId in interface Tuple

resetValues

public void resetValues()

Description copied from interface: Tuple

Resets the tuple values to null TODO:- Is this needed

Specified by:

resetValues in interface Tuple