Google Cloud Dataflow SDK for Java, version 1.9.1
Class Combine.BinaryCombineIntegerFn
- java.lang.Object
-
- com.google.cloud.dataflow.sdk.transforms.Combine.CombineFn<Integer,int[],Integer>
-
- com.google.cloud.dataflow.sdk.transforms.Combine.BinaryCombineIntegerFn
-
- All Implemented Interfaces:
- CombineFnBase.GlobalCombineFn<Integer,int[],Integer>, HasDisplayData, Serializable
- Direct Known Subclasses:
- Sum.SumIntegerFn
- Enclosing class:
- Combine
public abstract static class Combine.BinaryCombineIntegerFn extends Combine.CombineFn<Integer,int[],Integer>
An abstract subclass ofCombine.CombineFn
for implementing combiners that are more easily and efficiently expressed as binary operations onint
sIt uses
int[0]
as the mutable accumulator.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description BinaryCombineIntegerFn()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description int[]
addInput(int[] accumulator, Integer input)
Adds the given input value to the given accumulator, returning the new accumulator value.abstract int
apply(int left, int right)
Applies the binary operation to the two operands, returning the result.int[]
createAccumulator()
Returns a new, mutable accumulator value, representing the accumulation of zero input values.Integer
extractOutput(int[] accumulator)
Returns the output value that is the result of combining all the input values represented by the given accumulator.TypeVariable<?>
getAccumTVariable()
Returns theTypeVariable
ofAccumT
.Coder<int[]>
getAccumulatorCoder(CoderRegistry registry, Coder<Integer> inputCoder)
Returns theCoder
to use for accumulatorAccumT
values, or null if it is not able to be inferred.com.google.cloud.dataflow.sdk.util.common.Counter<Integer>
getCounter(String name)
Coder<Integer>
getDefaultOutputCoder(CoderRegistry registry, Coder<Integer> inputCoder)
Returns theCoder
to use by default for outputOutputT
values, or null if it is not able to be inferred.String
getIncompatibleGlobalWindowErrorMessage()
Returns the error message for not supported default values in Combine.globally().TypeVariable<?>
getInputTVariable()
Returns theTypeVariable
ofInputT
.TypeVariable<?>
getOutputTVariable()
Returns theTypeVariable
ofOutputT
.abstract int
identity()
Returns the identity element of this operation, i.e.int[]
mergeAccumulators(Iterable<int[]> accumulators)
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.void
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.-
Methods inherited from class com.google.cloud.dataflow.sdk.transforms.Combine.CombineFn
apply, asKeyedFn, compact, defaultValue, getOutputType
-
-
-
-
Method Detail
-
apply
public abstract int apply(int left, int right)
Applies the binary operation to the two operands, returning the result.
-
identity
public abstract int identity()
Returns the identity element of this operation, i.e. an elemente
such thatapply(e, x) == apply(x, e) == x
for all values ofx
.
-
createAccumulator
public int[] createAccumulator()
Description copied from class:Combine.CombineFn
Returns a new, mutable accumulator value, representing the accumulation of zero input values.- Specified by:
createAccumulator
in classCombine.CombineFn<Integer,int[],Integer>
-
addInput
public int[] addInput(int[] accumulator, Integer input)
Description copied from class:Combine.CombineFn
Adds the given input value to the given accumulator, returning the new accumulator value.For efficiency, the input accumulator may be modified and returned.
- Specified by:
addInput
in classCombine.CombineFn<Integer,int[],Integer>
-
mergeAccumulators
public int[] mergeAccumulators(Iterable<int[]> accumulators)
Description copied from class:Combine.CombineFn
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.May modify any of the argument accumulators. May return a fresh accumulator, or may return one of the (modified) argument accumulators.
- Specified by:
mergeAccumulators
in classCombine.CombineFn<Integer,int[],Integer>
-
extractOutput
public Integer extractOutput(int[] 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 classCombine.CombineFn<Integer,int[],Integer>
-
getAccumulatorCoder
public Coder<int[]> getAccumulatorCoder(CoderRegistry registry, Coder<Integer> inputCoder)
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns theCoder
to use for accumulatorAccumT
values, or null if it is not able to be inferred.By default, uses the knowledge of the
Coder
being used forInputT
values and the enclosingPipeline
'sCoderRegistry
to try to infer the Coder forAccumT
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 interfaceCombineFnBase.GlobalCombineFn<Integer,int[],Integer>
-
getDefaultOutputCoder
public Coder<Integer> getDefaultOutputCoder(CoderRegistry registry, Coder<Integer> inputCoder)
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns theCoder
to use by default for outputOutputT
values, or null if it is not able to be inferred.By default, uses the knowledge of the
Coder
being used for inputInputT
values and the enclosingPipeline
'sCoderRegistry
to try to infer the Coder forOutputT
values.- Specified by:
getDefaultOutputCoder
in interfaceCombineFnBase.GlobalCombineFn<Integer,int[],Integer>
-
getCounter
public com.google.cloud.dataflow.sdk.util.common.Counter<Integer> getCounter(String name)
-
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 interfaceCombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
-
getInputTVariable
public TypeVariable<?> getInputTVariable()
Returns theTypeVariable
ofInputT
.
-
getAccumTVariable
public TypeVariable<?> getAccumTVariable()
Returns theTypeVariable
ofAccumT
.
-
getOutputTVariable
public TypeVariable<?> getOutputTVariable()
Returns theTypeVariable
ofOutputT
.
-
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 viaDisplayData.from(HasDisplayData)
. Implementations may callsuper.populateDisplayData(builder)
in order to register display data in the current namespace, but should otherwise usesubcomponent.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 interfaceHasDisplayData
- Parameters:
builder
- The builder to populate with display data.- See Also:
HasDisplayData
-
-