org.apache.reef.vortex.api

Interface VortexAggregateFunction<TOutput>

Type Parameters:

TOutput - output type of the aggregation function and the functions to-be-aggregated.

All Superinterfaces:

Serializable

All Known Implementing Classes:

AdditionAggregateFunction

public interface VortexAggregateFunction<TOutput>
extends Serializable

Typed user function for Local Aggregation. Implement your functions using this interface. TODO[REEF-504]: Clean up Serializable in Vortex. TODO[REEF-1003]: Use reflection instead of serialization when launching VortexFunction.

Method Summary

Methods

Modifier and Type	Method and Description
TOutput	call(List<TOutput> taskletOutputs) Runs a custom local aggregation function on Tasklets assigned to a VortexWorker.
Codec<TOutput>	getOutputCodec() Users must define codec for the AggregationOutput.

Method Detail

call

TOutput call(List<TOutput> taskletOutputs)
             throws VortexAggregateException

Runs a custom local aggregation function on Tasklets assigned to a VortexWorker.

Parameters:

taskletOutputs - the list of outputs from Tasklets on a Worker.

Returns:

the aggregated output of Tasklets.

Throws:

Exception

VortexAggregateException

getOutputCodec

Codec<TOutput> getOutputCodec()

Users must define codec for the AggregationOutput. VoidCodec can be used if the aggregation output is empty, and SerializableCodec can be used for (Serializable aggregation output. Custom aggregation output Codec can also be supplied.

Returns:

Codec used to serialize/deserialize the output.