ds.granules.dataset

Class StreamEvent

java.lang.Object

ds.granules.dataset.StreamEvent

Direct Known Subclasses:

AbstractStreamEvent

public abstract class StreamEvent
extends Object

Every data type used in Granules Streaming should implement this interface. The implementations of StreamSource and StreamProcessor interface should emit and process implementations of this interface.

Author:

: Thilina Buddhika

Constructor Summary

Constructors

Constructor and Description
StreamEvent()

Method Summary

Methods

Modifier and Type	Method and Description
Object	getPartitionKey() Return the partitioning key used for partitioning a stream.
String	getStreamId() Returns the identifier of the stream to which the event belongs to.
abstract byte[]	marshall() Convert a StreamTuple object into a byte[] for communication.
abstract void	marshallAsBatch(DataOutputStream dataOutputStream)
void	setStreamId(String streamId)
abstract void	unmarshall(byte[] bytes) Populate a StreamTuple object from a byte array.
abstract void	unmarshallAsBatch(DataInputStream dataInputStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamEvent

public StreamEvent()

Method Detail

getStreamId

public String getStreamId()

Returns the identifier of the stream to which the event belongs to.

Returns:

Identifier of the stream as mentioned in the Job configuration.

setStreamId

public void setStreamId(String streamId)

unmarshall

public abstract void unmarshall(byte[] bytes)
                         throws IOException

Populate a StreamTuple object from a byte array.

Parameters:

bytes - byte array offered by the communication layer.

Throws:

IOException

marshall

public abstract byte[] marshall()
                         throws IOException

Convert a StreamTuple object into a byte[] for communication.

Returns:

byte array generated after serialization.

Throws:

IOException

marshallAsBatch

public abstract void marshallAsBatch(DataOutputStream dataOutputStream)
                              throws IOException

Throws:

IOException

unmarshallAsBatch

public abstract void unmarshallAsBatch(DataInputStream dataInputStream)
                                throws IOException

Throws:

IOException

getPartitionKey

public Object getPartitionKey()

Return the partitioning key used for partitioning a stream. Classes that extend this class may override this method to emit an appropriate key

Returns:

partition key