edu.iu.dsc.tws.api.tset.link

Interface TLink<T1,T0>

Type Parameters:

T1 - Type output from the communication layer for the corresponding edge

T0 - Base type of the edge

All Superinterfaces:

java.io.Serializable, TBase

All Known Subinterfaces:

BatchTLink<T1,T0>, StreamingTLink<T1,T0>

All Known Implementing Classes:

AllGatherTLink, AllReduceTLink, BatchGatherLink, BatchIteratorLink, BatchIteratorLinkWrapper, BatchSingleLink, BatchTLinkImpl, DirectTLink, GatherTLink, JoinTLink, KeyedBatchIteratorLinkWrapper, KeyedDirectTLink, KeyedGatherTLink, KeyedGatherUngroupedTLink, KeyedPartitionTLink, KeyedPipeTLink, KeyedReduceTLink, PartitionTLink, PipeTLink, ReduceTLink, ReplicateTLink, SAllGatherTLink, SAllReduceTLink, SDirectTLink, SGatherTLink, SKeyedDirectTLink, SKeyedPartitionTLink, SPartitionTLink, SReduceTLink, SReplicateTLink, StreamingGatherLink, StreamingIteratorLink, StreamingSingleLink, StreamingTLinkImpl

public interface TLink<T1,T0>
extends TBase

Link represents the connections between TSets and TupleTSets. These would map to some form of communication operations in the communication layer. Communication layer outputs three variations/types of data outputs (corresponds to T1). - Single value - Iterator of values - Special iterator for gather operations

Method Summary

Modifier and Type	Method and Description
<O> TSet<O>	compute(ComputeCollectorFunc<O,T1> computeFunction) Creates a Compute TSet based on the ComputeCollectorFunc provided.
<O> TSet<O>	compute(ComputeFunc<O,T1> computeFunction) Creates a Compute TSet based on the ComputeFunc provided.
<O> TSet<O>	flatmap(FlatMapFunc<O,T0> mapFn) Performs flat map operation based on the FlatMapFunc provided
void	forEach(ApplyFunc<T0> applyFunction) Applies a function elementwise.
<O> TSet<O>	map(MapFunc<O,T0> mapFn) Performs elementwise map operation based on the MapFunc provided
<K,V> TupleTSet<K,V>	mapToTuple(MapFunc<Tuple<K,V>,T0> genTupleFn) Maps the data passed through the TLink to Tuple based on a MapFunc and thereby creating a TupleTSet
TLink<T1,T0>	setName(java.lang.String name) Name of the TSet and return the same tlink
TBase	sink(SinkFunc<T1> sinkFunction) Creates a Sink TSet based on the SinkFunc.

Methods inherited from interface edu.iu.dsc.tws.api.tset.TBase

getId, getName

Method Detail

setName

TLink<T1,T0> setName(java.lang.String name)

Name of the TSet and return the same tlink

Specified by:

setName in interface TBase

Parameters:

name - name

Returns:

this tlink

compute

<O> TSet<O> compute(ComputeFunc<O,T1> computeFunction)

Creates a Compute TSet based on the ComputeFunc provided.

Type Parameters:

O - output tset base type

Parameters:

computeFunction - comp function. Takes in T0 type object and map to the output type O

Returns:

Compute TSet

compute

<O> TSet<O> compute(ComputeCollectorFunc<O,T1> computeFunction)

Creates a Compute TSet based on the ComputeCollectorFunc provided.

Type Parameters:

O - output type (for the RecordCollector)

Parameters:

computeFunction - compute function with collector

Returns:

Compute TSet

map

<O> TSet<O> map(MapFunc<O,T0> mapFn)

Performs elementwise map operation based on the MapFunc provided

Type Parameters:

O - output type

Parameters:

mapFn - map function T0 to O

Returns:

Compute tset

flatmap

<O> TSet<O> flatmap(FlatMapFunc<O,T0> mapFn)

Performs flat map operation based on the FlatMapFunc provided

Type Parameters:

O - map function to T0 to multiple elements of <O>

Parameters:

mapFn - map function which can produce multiple elements for a single <T0> element

Returns:

Compute TSet

mapToTuple

<K,V> TupleTSet<K,V> mapToTuple(MapFunc<Tuple<K,V>,T0> genTupleFn)

Maps the data passed through the TLink to Tuple based on a MapFunc and thereby creating a TupleTSet

Type Parameters:

K - key type

V - value type

Parameters:

genTupleFn - MapFunc to generate a Tuple

Returns:

Keyed TSet

forEach

void forEach(ApplyFunc<T0> applyFunction)

Applies a function elementwise. Similar to compute, but the ApplyFunc does not return anything.

Parameters:

applyFunction - apply function

sink

TBase sink(SinkFunc<T1> sinkFunction)

Creates a Sink TSet based on the SinkFunc.

Parameters:

sinkFunction - sink function which takes in <T1>. Similar to a compute, but would not return any TSet

Returns:

Sink tset. This would would be a terminal TSet with no transformation capabilities.