org.apache.flink.api.common.functions

Class RichMapPartitionFunction<I,O>

java.lang.Object

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

org.apache.flink.api.common.functions.RichMapPartitionFunction<I,O>

Type Parameters:

I - Type of the input elements.

O - Type of the returned elements.

All Implemented Interfaces:

Serializable, Function, MapPartitionFunction<I,O>, RichFunction

Direct Known Subclasses:

AssignRangeIndex, BoundedOneInputStreamTaskRunner, RangeBoundaryBuilder, SampleInPartition, SampleWithFraction

@Public
public abstract class RichMapPartitionFunction<I,O>
extends AbstractRichFunction
implements MapPartitionFunction<I,O>

Rich variant of the MapPartitionFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(OpenContext) and RichFunction.close().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RichMapPartitionFunction()

Method Summary

Modifier and Type	Method and Description
abstract void	mapPartition(Iterable<I> values, Collector<O> out) A user-implemented function that modifies or transforms an incoming object.

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

Methods inherited from interface org.apache.flink.api.common.functions.RichFunction

open

Constructor Detail

RichMapPartitionFunction

public RichMapPartitionFunction()

Method Detail

mapPartition

public abstract void mapPartition(Iterable<I> values,
                                  Collector<O> out)
                           throws Exception

Description copied from interface: MapPartitionFunction

A user-implemented function that modifies or transforms an incoming object.

Specified by:

mapPartition in interface MapPartitionFunction<I,O>

Parameters:

values - All records for the mapper

out - The collector to hand results to.

Throws:

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