edu.iu.dsc.tws.api.tset.fn

Interface SinkFunc<T>

Type Parameters:

T - data type

All Superinterfaces:

java.io.Serializable, TFunction<T,T>

All Known Implementing Classes:

ArrowBasedSinkFunction, BaseDiskPersistIterSink, BaseSinkFunc, CacheGatherSink, CacheIterSink, CacheSingleSink, DiskPersistGatherIterSink, DiskPersistIterIterSink, DiskPersistSingleSink, FileIterSink, FileSink, SideInputSinkFunction, StoreIterSink, StreamingCacheSink, StreamingDiskPersistSink, Twister2SinkFunction

public interface SinkFunc<T>
extends TFunction<T,T>

Adds data sink at the end of the graph. SinkFunc would receive data from an edge of the data flow graph.

Method Summary

Modifier and Type	Method and Description
boolean	add(T value) Every time an edge produces a value, this method is called.
default DataPartition<?>	get() Return the data partition associated with this task instance.

Methods inherited from interface edu.iu.dsc.tws.api.tset.fn.TFunction

close, end, prepare

Method Detail

add

boolean add(T value)

Every time an edge produces a value, this method is called.

Parameters:

value - the value to add

Returns:

true if success

get

default DataPartition<?> get()

Return the data partition associated with this task instance. Specifically to be used for caching functionality.

Returns:

data partition - type remains unknown as the output of sunk data can be a different type than T. Example, caching gatherTlink,T -> Tuple<int, T> but the output would be T