org.thales.punch.libraries.storm.core.topology.light

Class LightTuple

java.lang.Object

org.thales.punch.libraries.storm.core.topology.light.LightTuple

All Implemented Interfaces:

org.apache.storm.tuple.ITuple, org.apache.storm.tuple.Tuple

public class LightTuple
extends Object
implements org.apache.storm.tuple.Tuple

These are the (storm compatible) tuples given to bolts.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
void	ack() Only after all anchors have acked will the tuple be acked to the originating spout.
void	check() Check if this tuple has been emitted at least once.
boolean	contains(String field)
boolean	equals(Object other)
void	fail() Once a tuple is failed, subsequent fail or acks are discarded.
int	fieldIndex(String field)
LightTuple	getAnchor()
Object	getAttachement() The attachement is an arbitrary object attached to that tuple.
byte[]	getBinary(int i)
byte[]	getBinaryByField(String field)
static LightTuple	getBoltTuple(String streamId, String sourceComponentId, List<Object> values, org.apache.storm.tuple.Fields fields, LightTuple anchor) Build a new bolt tuple.
Boolean	getBoolean(int i)
Boolean	getBooleanByField(String field)
Byte	getByte(int i)
Byte	getByteByField(String field)
org.apache.storm.task.GeneralTopologyContext	getContext()
Double	getDouble(int i)
Double	getDoubleByField(String field)
org.apache.storm.tuple.Fields	getFields()
Float	getFloat(int i)
Float	getFloatByField(String field)
Integer	getInteger(int i)
Integer	getIntegerByField(String field)
Long	getLong(int i)
Long	getLongByField(String field)
org.apache.storm.tuple.MessageId	getMessageId()
long	getRefCount()
Short	getShort(int i)
Short	getShortByField(String field)
String	getSourceComponent()
org.apache.storm.generated.GlobalStreamId	getSourceGlobalStreamId()
String	getSourceStreamId()
int	getSourceTask()
static LightTuple	getSpoutTuple(String streamId, String sourceComponentId, List<Object> values, org.apache.storm.tuple.Fields fields, Object messageId) Build a new spout tuple.
String	getString(int i)
String	getStringByField(String field)
static LightTuple	getTickTuple()
long	getUuid()
Object	getValue(int i)
Object	getValueByField(String field)
List<Object>	getValues()
int	hashCode()
LightTuple	inc()
boolean	isSpoutTuple() This method is thread-safe.
List<Object>	select(org.apache.storm.tuple.Fields selector)
LightTuple	setAcker(LightAcker acker) Only a spout is interested to know when this tuple ack or fail.
int	size()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSpoutTuple

public static LightTuple getSpoutTuple(String streamId,
                                       String sourceComponentId,
                                       List<Object> values,
                                       org.apache.storm.tuple.Fields fields,
                                       Object messageId)

Build a new spout tuple. A spout tuple is associated to an arbitrary object messageId, and has a reference count to keep track of acks by all child tuples.

Parameters:

streamId - streamId

sourceComponentId - sourceComponentId

values - values

fields - fields

messageId - messageId

Returns:

a new spout LightTuple

getBoltTuple

public static LightTuple getBoltTuple(String streamId,
                                      String sourceComponentId,
                                      List<Object> values,
                                      org.apache.storm.tuple.Fields fields,
                                      LightTuple anchor)

Build a new bolt tuple. A bolt tuple is associated with an anchor tuple, pointing to the original spout tuple from where the bolt tuple has been created. If the anchor is null (permitted0, it is a spontaneous tuple created by the bolt.

Parameters:

streamId - streamId

sourceComponentId - sourceComponentId

values - values

fields - fields

anchor - anchor

Returns:

a new bolt tuple

setAcker

public LightTuple setAcker(LightAcker acker)

Only a spout is interested to know when this tuple ack or fail.

Parameters:

acker - a LightSpout

Returns:

this tuple

getAnchor

public LightTuple getAnchor()

getRefCount

public long getRefCount()

getTickTuple

public static LightTuple getTickTuple()

getUuid

public long getUuid()

getAttachement

public Object getAttachement()

The attachement is an arbitrary object attached to that tuple. For s a spout tuple it is the messageId, for a bolt tuple it is the source tuple from where this bolt tuple originated.

Returns:

the attachement

isSpoutTuple

public boolean isSpoutTuple()

This method is thread-safe. It returns a final boolean.

Returns:

true if this tuple is a root tuple emitted from a spout

fail

public void fail()

Once a tuple is failed, subsequent fail or acks are discarded.

check

public void check()

Check if this tuple has been emitted at least once. If not, make it acked straight ahead

ack

public void ack()

Only after all anchors have acked will the tuple be acked to the originating spout.

inc

public LightTuple inc()

size

public int size()

Specified by:

size in interface org.apache.storm.tuple.ITuple

fieldIndex

public int fieldIndex(String field)

Specified by:

fieldIndex in interface org.apache.storm.tuple.ITuple

contains

public boolean contains(String field)

Specified by:

contains in interface org.apache.storm.tuple.ITuple

getValue

public Object getValue(int i)

Specified by:

getValue in interface org.apache.storm.tuple.ITuple

getString

public String getString(int i)

Specified by:

getString in interface org.apache.storm.tuple.ITuple

getInteger

public Integer getInteger(int i)

Specified by:

getInteger in interface org.apache.storm.tuple.ITuple

getLong

public Long getLong(int i)

Specified by:

getLong in interface org.apache.storm.tuple.ITuple

getBoolean

public Boolean getBoolean(int i)

Specified by:

getBoolean in interface org.apache.storm.tuple.ITuple

getShort

public Short getShort(int i)

Specified by:

getShort in interface org.apache.storm.tuple.ITuple

getByte

public Byte getByte(int i)

Specified by:

getByte in interface org.apache.storm.tuple.ITuple

getDouble

public Double getDouble(int i)

Specified by:

getDouble in interface org.apache.storm.tuple.ITuple

getFloat

public Float getFloat(int i)

Specified by:

getFloat in interface org.apache.storm.tuple.ITuple

getBinary

public byte[] getBinary(int i)

Specified by:

getBinary in interface org.apache.storm.tuple.ITuple

getValueByField

public Object getValueByField(String field)

Specified by:

getValueByField in interface org.apache.storm.tuple.ITuple

getStringByField

public String getStringByField(String field)

Specified by:

getStringByField in interface org.apache.storm.tuple.ITuple

getIntegerByField

public Integer getIntegerByField(String field)

Specified by:

getIntegerByField in interface org.apache.storm.tuple.ITuple

getLongByField

public Long getLongByField(String field)

Specified by:

getLongByField in interface org.apache.storm.tuple.ITuple

getBooleanByField

public Boolean getBooleanByField(String field)

Specified by:

getBooleanByField in interface org.apache.storm.tuple.ITuple

getShortByField

public Short getShortByField(String field)

Specified by:

getShortByField in interface org.apache.storm.tuple.ITuple

getByteByField

public Byte getByteByField(String field)

Specified by:

getByteByField in interface org.apache.storm.tuple.ITuple

getDoubleByField

public Double getDoubleByField(String field)

Specified by:

getDoubleByField in interface org.apache.storm.tuple.ITuple

getFloatByField

public Float getFloatByField(String field)

Specified by:

getFloatByField in interface org.apache.storm.tuple.ITuple

getBinaryByField

public byte[] getBinaryByField(String field)

Specified by:

getBinaryByField in interface org.apache.storm.tuple.ITuple

getValues

public List<Object> getValues()

Specified by:

getValues in interface org.apache.storm.tuple.ITuple

getFields

public org.apache.storm.tuple.Fields getFields()

Specified by:

getFields in interface org.apache.storm.tuple.ITuple

select

public List<Object> select(org.apache.storm.tuple.Fields selector)

Specified by:

select in interface org.apache.storm.tuple.ITuple

getSourceGlobalStreamId

public org.apache.storm.generated.GlobalStreamId getSourceGlobalStreamId()

Specified by:

getSourceGlobalStreamId in interface org.apache.storm.tuple.Tuple

getSourceComponent

public String getSourceComponent()

Specified by:

getSourceComponent in interface org.apache.storm.tuple.Tuple

getSourceTask

public int getSourceTask()

Specified by:

getSourceTask in interface org.apache.storm.tuple.Tuple

getSourceStreamId

public String getSourceStreamId()

Specified by:

getSourceStreamId in interface org.apache.storm.tuple.Tuple

getMessageId

public org.apache.storm.tuple.MessageId getMessageId()

Specified by:

getMessageId in interface org.apache.storm.tuple.Tuple

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getContext

public org.apache.storm.task.GeneralTopologyContext getContext()

Specified by:

getContext in interface org.apache.storm.tuple.Tuple