org.apache.flink.graph.asm.translate

Interface TranslateFunction<T,O>

Type Parameters:

T - Type of the input elements.

O - Type of the returned elements.

All Superinterfaces:

Function, Serializable

All Known Implementing Classes:

GraphUtils.MapTo, LongToLongValue, LongValueAddOffset, LongValueToSignedIntValue, LongValueToStringValue, LongValueToUnsignedIntValue, RichTranslateFunction, ToNullValue

public interface TranslateFunction<T,O>
extends Function, Serializable

Base interface for Translate functions. Translate functions take elements and transform them, element wise. A Translate function always produces a single result element for each input element. Typical applications are transcribing between data types or manipulating element values.

Translate functions are used within the Graph API and by translating GraphAlgorithms.

Method Summary

Modifier and Type	Method and Description
O	translate(T value, O reuse) The translating method.

Method Detail

translate

O translate(T value,
            O reuse)
     throws Exception

The translating method. Takes an element from the input data set and transforms it into exactly one element.

Parameters:

value - input value.

reuse - value which may be reused for output; if reuse is null then a new output object must be instantiated and returned

Returns:

the transformed value

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.