Package org.apache.flink.runtime.operators

Class JoinDriver<IT1,IT2,OT>

java.lang.Object
org.apache.flink.runtime.operators.JoinDriver<IT1,IT2,OT>
All Implemented Interfaces:
Driver<org.apache.flink.api.common.functions.FlatJoinFunction<IT1,IT2,OT>,OT>
Direct Known Subclasses:
AbstractCachedBuildSideJoinDriver
public class JoinDriver<IT1,IT2,OT> extends Object implements Driver<org.apache.flink.api.common.functions.FlatJoinFunction<IT1,IT2,OT>,OT>
The join driver implements the logic of a join operator at runtime. It instantiates either hash or sort-merge based strategies to find joining pairs of records.
See Also:
  • FlatJoinFunction

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final org.slf4j.Logger
    LOG
     
    protected boolean
    running
     
    protected TaskContext<org.apache.flink.api.common.functions.FlatJoinFunction<IT1,IT2,OT>,OT>
    taskContext
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JoinDriver()
     

  • 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.FlatJoinFunction<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.FlatJoinFunction<IT1,IT2,OT>,OT> context)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • LOG

      protected static final org.slf4j.Logger LOG

    • taskContext

      protected TaskContext<org.apache.flink.api.common.functions.FlatJoinFunction<IT1,IT2,OT>,OT> taskContext

    • running

      protected volatile boolean running

  • Constructor Details

    • JoinDriver

      public JoinDriver()

  • Method Details

    • setup

      public void setup(TaskContext<org.apache.flink.api.common.functions.FlatJoinFunction<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.FlatJoinFunction<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()
      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>