Package org.apache.beam.sdk.transforms

Class Combine.BinaryCombineFn<V>

java.lang.Object
org.apache.beam.sdk.transforms.Combine.CombineFn<V,Combine.Holder<V>,V>
org.apache.beam.sdk.transforms.Combine.BinaryCombineFn<V>
All Implemented Interfaces:
Serializable, CombineFnBase.GlobalCombineFn<V,Combine.Holder<V>,V>, HasDisplayData
Enclosing class:
Combine
public abstract static class Combine.BinaryCombineFn<V> extends Combine.CombineFn<V,Combine.Holder<V>,V>
An abstract subclass of Combine.CombineFn for implementing combiners that are more easily expressed as binary operations.
See Also:

  • Constructor Details

    • BinaryCombineFn

      public BinaryCombineFn()

  • Method Details

    • of

      public static <V> Combine.BinaryCombineFn<V> of(SerializableBiFunction<V,V,V> combiner)
      Returns a CombineFn that uses the given SerializableBiFunction to combine values.

    • apply

      public abstract V apply(V left, V right)
      Applies the binary operation to the two operands, returning the result.

    • identity

      public @Nullable V identity()
      Returns the value that should be used for the combine of the empty set.

    • createAccumulator

      public Combine.Holder<V> createAccumulator()
      Description copied from class: Combine.CombineFn
      Returns a new, mutable accumulator value, representing the accumulation of zero input values.
      Specified by:
      createAccumulator in class Combine.CombineFn<V,Combine.Holder<V>,V>

    • addInput

      public Combine.Holder<V> addInput(Combine.Holder<V> accumulator, V input)
      Description copied from class: Combine.CombineFn
      Adds the given input value to the given accumulator, returning the new accumulator value.
      Specified by:
      addInput in class Combine.CombineFn<V,Combine.Holder<V>,V>
      Parameters:
      accumulator - may be modified and returned for efficiency
      input - should not be mutated

    • mergeAccumulators

      public Combine.Holder<V> mergeAccumulators(Iterable<Combine.Holder<V>> accumulators)
      Description copied from class: Combine.CombineFn
      Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.
      Specified by:
      mergeAccumulators in class Combine.CombineFn<V,Combine.Holder<V>,V>
      Parameters:
      accumulators - only the first accumulator may be modified and returned for efficiency; the other accumulators should not be mutated, because they may be shared with other code and mutating them could lead to incorrect results or data corruption.

    • extractOutput

      public V extractOutput(Combine.Holder<V> accumulator)
      Description copied from class: Combine.CombineFn
      Returns the output value that is the result of combining all the input values represented by the given accumulator.
      Specified by:
      extractOutput in class Combine.CombineFn<V,Combine.Holder<V>,V>
      Parameters:
      accumulator - can be modified for efficiency

    • getAccumulatorCoder

      public Coder<Combine.Holder<V>> getAccumulatorCoder(CoderRegistry registry, Coder<V> inputCoder)
      Description copied from interface: CombineFnBase.GlobalCombineFn
      Returns the Coder to use for accumulator AccumT values, or null if it is not able to be inferred.

      By default, uses the knowledge of the Coder being used for InputT values and the enclosing Pipeline's CoderRegistry to try to infer the Coder for AccumT values.

      This is the Coder used to send data through a communication-intensive shuffle step, so a compact and efficient representation may have significant performance benefits.

      Specified by:
      getAccumulatorCoder in interface CombineFnBase.GlobalCombineFn<V,Combine.Holder<V>,V>

    • getDefaultOutputCoder

      public Coder<V> getDefaultOutputCoder(CoderRegistry registry, Coder<V> inputCoder)
      Description copied from interface: CombineFnBase.GlobalCombineFn
      Returns the Coder to use by default for output OutputT values, or null if it is not able to be inferred.

      By default, uses the knowledge of the Coder being used for input InputT values and the enclosing Pipeline's CoderRegistry to try to infer the Coder for OutputT values.

      Specified by:
      getDefaultOutputCoder in interface CombineFnBase.GlobalCombineFn<V,Combine.Holder<V>,V>

    • getIncompatibleGlobalWindowErrorMessage

      public String getIncompatibleGlobalWindowErrorMessage()
      Description copied from interface: CombineFnBase.GlobalCombineFn
      Returns the error message for not supported default values in Combine.globally().
      Specified by:
      getIncompatibleGlobalWindowErrorMessage in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>

    • getInputTVariable

      public TypeVariable<?> getInputTVariable()
      Returns the TypeVariable of InputT.

    • getAccumTVariable

      public TypeVariable<?> getAccumTVariable()
      Returns the TypeVariable of AccumT.

    • getOutputTVariable

      public TypeVariable<?> getOutputTVariable()
      Returns the TypeVariable of OutputT.

    • populateDisplayData

      public void populateDisplayData(DisplayData.Builder builder)
      Register display data for the given transform or component.

      populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

      By default, does not register any display data. Implementors may override this method to provide their own display data.

      Specified by:
      populateDisplayData in interface HasDisplayData
      Parameters:
      builder - The builder to populate with display data.
      See Also: