Package org.apache.flink.runtime.operators

Class CoGroupDriver<IT1,IT2,OT>

java.lang.Object
org.apache.flink.runtime.operators.CoGroupDriver<IT1,IT2,OT>
All Implemented Interfaces:
Driver<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,OT>,OT>
public class CoGroupDriver<IT1,IT2,OT> extends Object implements Driver<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,OT>,OT>
CoGroup task which is executed by a Task Manager. The task has two inputs and one or multiple outputs. It is provided with a CoGroupFunction implementation.

The CoGroupTask group all pairs that share the same key from both inputs. Each for each key, the sets of values that were pair with that key of both inputs are handed to the coGroup() method of the CoGroupFunction.

See Also:
  • CoGroupFunction

  • Constructor Summary

    Constructors
    Constructor
    Description
    CoGroupDriver()
     

  • Method Summary

    Modifier and Type
    Method
    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 that the task has.
    Class<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,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(TaskContext<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,OT>,OT> context)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CoGroupDriver

      public CoGroupDriver()

  • Method Details

    • setup

      public void setup(TaskContext<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,OT>,OT> context)
      Specified by:
      setup in interface Driver<IT1,IT2>

    • getNumberOfInputs

      public int getNumberOfInputs()
      Description copied from interface: Driver
      Gets the number of inputs that the task has.
      Specified by:
      getNumberOfInputs in interface Driver<IT1,IT2>
      Returns:
      The number of inputs.

    • getStubType

      public Class<org.apache.flink.api.common.functions.CoGroupFunction<IT1,IT2,OT>> getStubType()
      Description copied from interface: Driver
      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 Driver<IT1,IT2>
      Returns:
      The class of the stub type run by the task.

    • getNumberOfDriverComparators

      public int getNumberOfDriverComparators()
      Description copied from interface: Driver
      Gets the number of comparators required for this driver.
      Specified by:
      getNumberOfDriverComparators in interface Driver<IT1,IT2>
      Returns:
      The number of comparators required for this driver.

    • prepare

      public void prepare() throws Exception
      Description copied from interface: Driver
      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 Driver<IT1,IT2>
      Throws:
      Exception - Exceptions may be forwarded and signal task failure.

    • run

      public void run() throws Exception
      Description copied from interface: Driver
      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 Driver<IT1,IT2>
      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() throws Exception
      Description copied from interface: Driver
      This method is invoked in any case (clean termination and exception) at the end of the tasks operation.
      Specified by:
      cleanup in interface Driver<IT1,IT2>
      Throws:
      Exception - Exceptions may be forwarded.

    • cancel

      public void cancel() throws Exception
      Description copied from interface: Driver
      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 Driver<IT1,IT2>
      Throws:
      Exception - Exceptions may be forwarded.