Class Combine.AccumulatingCombineFn<InputT,AccumT extends Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>,OutputT>
- java.lang.Object
-
- org.apache.beam.sdk.transforms.Combine.CombineFn<InputT,AccumT,OutputT>
-
- org.apache.beam.sdk.transforms.Combine.AccumulatingCombineFn<InputT,AccumT,OutputT>
-
- Type Parameters:
InputT
- type of input valuesAccumT
- type of mutable accumulator valuesOutputT
- type of output values
- All Implemented Interfaces:
java.io.Serializable
,CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
,HasDisplayData
- Direct Known Subclasses:
ApproximateQuantiles.ApproximateQuantilesCombineFn
,Top.TopCombineFn
- Enclosing class:
- Combine
public abstract static class Combine.AccumulatingCombineFn<InputT,AccumT extends Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>,OutputT> extends Combine.CombineFn<InputT,AccumT,OutputT>
ACombineFn
that uses a subclass ofCombine.AccumulatingCombineFn.Accumulator
as its accumulator type. By defining the operations of theAccumulator
helper class, the operations of the enclosingCombineFn
are automatically provided. This can reduce the code required to implement aCombineFn
.For example, the example from
Combine.CombineFn
above can be expressed usingAccumulatingCombineFn
more concisely as follows:public class AverageFn extends AccumulatingCombineFn<Integer, AverageFn.Accum, Double> { public Accum createAccumulator() { return new Accum(); } public class Accum extends AccumulatingCombineFn<Integer, AverageFn.Accum, Double> .Accumulator { private int sum = 0; private int count = 0; public void addInput(Integer input) { sum += input; count++; } public void mergeAccumulator(Accum other) { sum += other.sum; count += other.count; } public Double extractOutput() { return ((double) sum) / count; } } } PCollection<Integer> pc = ...; PCollection<Double> average = pc.apply(Combine.globally(new AverageFn()));
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>
The type of mutable accumulator values used by thisAccumulatingCombineFn
.
-
Constructor Summary
Constructors Constructor Description AccumulatingCombineFn()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccumT
addInput(AccumT accumulator, InputT input)
Adds the given input value to the given accumulator, returning the new accumulator value.OutputT
extractOutput(AccumT accumulator)
Returns the output value that is the result of combining all the input values represented by the given accumulator.java.lang.reflect.TypeVariable<?>
getAccumTVariable()
Returns theTypeVariable
ofAccumT
.Coder<AccumT>
getAccumulatorCoder(CoderRegistry registry, Coder<InputT> inputCoder)
Returns theCoder
to use for accumulatorAccumT
values, or null if it is not able to be inferred.Coder<OutputT>
getDefaultOutputCoder(CoderRegistry registry, Coder<InputT> inputCoder)
Returns theCoder
to use by default for outputOutputT
values, or null if it is not able to be inferred.java.lang.String
getIncompatibleGlobalWindowErrorMessage()
Returns the error message for not supported default values in Combine.globally().java.lang.reflect.TypeVariable<?>
getInputTVariable()
Returns theTypeVariable
ofInputT
.java.lang.reflect.TypeVariable<?>
getOutputTVariable()
Returns theTypeVariable
ofOutputT
.AccumT
mergeAccumulators(java.lang.Iterable<AccumT> 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 org.apache.beam.sdk.transforms.Combine.CombineFn
apply, compact, createAccumulator, defaultValue, getInputType, getOutputType
-
-
-
-
Method Detail
-
addInput
public final AccumT addInput(AccumT accumulator, InputT 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 classCombine.CombineFn<InputT,AccumT extends Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>,OutputT>
- Parameters:
accumulator
- may be modified and returned for efficiencyinput
- should not be mutated
-
mergeAccumulators
public final AccumT mergeAccumulators(java.lang.Iterable<AccumT> 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 classCombine.CombineFn<InputT,AccumT extends Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>,OutputT>
- 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 final OutputT extractOutput(AccumT 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<InputT,AccumT extends Combine.AccumulatingCombineFn.Accumulator<InputT,AccumT,OutputT>,OutputT>
- Parameters:
accumulator
- can be modified for efficiency
-
getAccumulatorCoder
public Coder<AccumT> getAccumulatorCoder(CoderRegistry registry, Coder<InputT> inputCoder) throws CannotProvideCoderException
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<InputT,AccumT,OutputT>
- Throws:
CannotProvideCoderException
-
getDefaultOutputCoder
public Coder<OutputT> getDefaultOutputCoder(CoderRegistry registry, Coder<InputT> inputCoder) throws CannotProvideCoderException
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<InputT,AccumT,OutputT>
- Throws:
CannotProvideCoderException
-
getIncompatibleGlobalWindowErrorMessage
public java.lang.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 java.lang.reflect.TypeVariable<?> getInputTVariable()
Returns theTypeVariable
ofInputT
.
-
getAccumTVariable
public java.lang.reflect.TypeVariable<?> getAccumTVariable()
Returns theTypeVariable
ofAccumT
.
-
getOutputTVariable
public java.lang.reflect.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
-
-