org.apache.flink.batch.tests

Class BlockingIncrementingMapFunction

java.lang.Object

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

org.apache.flink.api.common.functions.RichMapFunction<Long,Long>

org.apache.flink.batch.tests.BlockingIncrementingMapFunction

All Implemented Interfaces:

Serializable, Function, MapFunction<Long,Long>, RichFunction

public class BlockingIncrementingMapFunction
extends RichMapFunction<Long,Long>

A map function that increments values by one.

Processing of elements is held until a latch file is created.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BlockingIncrementingMapFunction(String latchFilePath)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
Long	map(Long value) The mapping method.
void	open(Configuration parameters) Initialization method for the function.

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingIncrementingMapFunction

public BlockingIncrementingMapFunction(String latchFilePath)

Method Detail

open

public void open(Configuration parameters)

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

parameters - The configuration containing the parameters attached to the contract.

See Also:

Configuration

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

map

public Long map(Long value)
         throws InterruptedException

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<Long,Long>

Specified by:

map in class RichMapFunction<Long,Long>

Parameters:

value - The input value.

Returns:

The transformed value

Throws:

InterruptedException