org.apache.flink.api.common.functions

Class RichMapFunction<IN,OUT>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.api.common.functions.RichMapFunction<IN,OUT>

Type Parameters:

IN - Type of the input elements.

OUT - Type of the returned elements.

All Implemented Interfaces:

Serializable, Function, MapFunction<IN,OUT>, RichFunction

Direct Known Subclasses:

ArtificalOperatorStateMapper, ArtificialKeyedStateMapper, BlockingIncrementingMapFunction, FailureMapper, KeyExtractingMapper, KeyRemovingMapper, KMeans.SelectNearestCenter, RollingAdditionMapper, StatefulStreamingJob.MyStatefulFunction, TwoKeyExtractingMapper

@Public
public abstract class RichMapFunction<IN,OUT>
extends AbstractRichFunction
implements MapFunction<IN,OUT>

Rich variant of the MapFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(org.apache.flink.configuration.Configuration) and RichFunction.close().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RichMapFunction()

Method Summary

Modifier and Type	Method and Description
abstract OUT	map(IN value) The mapping method.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RichMapFunction

public RichMapFunction()

Method Detail

map

public abstract OUT map(IN value)
                 throws Exception

Description copied from interface: MapFunction

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

Specified by:

map in interface MapFunction<IN,OUT>

Parameters:

value - The input value.

Returns:

The transformed value

Throws:

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