org.apache.flink.runtime.operators

Class AllGroupReduceDriver<IT,OT>

java.lang.Object

org.apache.flink.runtime.operators.AllGroupReduceDriver<IT,OT>

All Implemented Interfaces:

PactDriver<GroupReduceFunction<IT,OT>,OT>

public class AllGroupReduceDriver<IT,OT>
extends Object
implements PactDriver<GroupReduceFunction<IT,OT>,OT>

GroupReduce task which is executed by a Nephele task manager. The task has a single input and one or multiple outputs. It is provided with a GroupReduceFunction implementation.

The GroupReduceTask creates a iterator over all records from its input. The iterator returns all records grouped by their key. The iterator is handed to the reduce() method of the GroupReduceFunction.

See Also:

GroupReduceFunction

Constructor Summary

Constructors

Constructor and Description
AllGroupReduceDriver()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() This method is invoked when the driver must aborted in mid processing.
void	cleanup() This method is invoked in any case (clean termination and exception) at the end of the tasks operation.
int	getNumberOfDriverComparators() Gets the number of comparators required for this driver.
int	getNumberOfInputs() Gets the number of inputs (= Nephele Gates and Readers) that the task has.
Class<GroupReduceFunction<IT,OT>>	getStubType() Gets the class of the stub type that is run by this task.
void	prepare() This method is called before the user code is opened.
void	run() The main operation method of the task.
void	setup(PactTaskContext<GroupReduceFunction<IT,OT>,OT> context)

Methods inherited from class java.lang.Object

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

Constructor Detail

AllGroupReduceDriver

public AllGroupReduceDriver()

Method Detail

setup

public void setup(PactTaskContext<GroupReduceFunction<IT,OT>,OT> context)

Specified by:

setup in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

getNumberOfInputs

public int getNumberOfInputs()

Description copied from interface: PactDriver

Gets the number of inputs (= Nephele Gates and Readers) that the task has.

Specified by:

getNumberOfInputs in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

Returns:

The number of inputs.

getStubType

public Class<GroupReduceFunction<IT,OT>> getStubType()

Description copied from interface: PactDriver

Gets the class of the stub type that is run by this task. For example, a MapTask should return MapFunction.class.

Specified by:

getStubType in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

Returns:

The class of the stub type run by the task.

getNumberOfDriverComparators

public int getNumberOfDriverComparators()

Description copied from interface: PactDriver

Gets the number of comparators required for this driver.

Specified by:

getNumberOfDriverComparators in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

Returns:

The number of comparators required for this driver.

prepare

public void prepare()
             throws Exception

Description copied from interface: PactDriver

This method is called before the user code is opened. An exception thrown by this method signals failure of the task.

Specified by:

prepare in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

Throws:

Exception - Exceptions may be forwarded and signal task failure.

run

public void run()
         throws Exception

Description copied from interface: PactDriver

The main operation method of the task. It should call the user code with the data subsets until the input is depleted.

Specified by:

run in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

Throws:

Exception - Any exception thrown by this method signals task failure. Because exceptions in the user code typically signal situations where this instance in unable to proceed, exceptions from the user code should be forwarded.

cleanup

public void cleanup()

Description copied from interface: PactDriver

This method is invoked in any case (clean termination and exception) at the end of the tasks operation.

Specified by:

cleanup in interface PactDriver<GroupReduceFunction<IT,OT>,OT>

cancel

public void cancel()

Description copied from interface: PactDriver

This method is invoked when the driver must aborted in mid processing. It is invoked asynchronously by a different thread.

Specified by:

cancel in interface PactDriver<GroupReduceFunction<IT,OT>,OT>