public abstract static class Combine.BinaryCombineFn<V> extends Combine.CombineFn<V,Combine.Holder<V>,V>
Combine.CombineFn
for implementing combiners that are more easily
expressed as binary operations.Constructor and Description |
---|
BinaryCombineFn() |
Modifier and Type | Method and Description |
---|---|
Combine.Holder<V> |
addInput(Combine.Holder<V> accumulator,
V input)
Adds the given input value to the given accumulator, returning the new accumulator value.
|
abstract V |
apply(V left,
V right)
Applies the binary operation to the two operands, returning the result.
|
Combine.Holder<V> |
createAccumulator()
Returns a new, mutable accumulator value, representing the accumulation of zero input values.
|
V |
extractOutput(Combine.Holder<V> 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 the
TypeVariable of AccumT . |
Coder<Combine.Holder<V>> |
getAccumulatorCoder(CoderRegistry registry,
Coder<V> inputCoder)
Returns the
Coder to use for accumulator AccumT values, or null if it is not
able to be inferred. |
Coder<V> |
getDefaultOutputCoder(CoderRegistry registry,
Coder<V> inputCoder)
Returns the
Coder to use by default for output OutputT 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 the
TypeVariable of InputT . |
java.lang.reflect.TypeVariable<?> |
getOutputTVariable()
Returns the
TypeVariable of OutputT . |
V |
identity()
Returns the value that should be used for the combine of the empty set.
|
Combine.Holder<V> |
mergeAccumulators(java.lang.Iterable<Combine.Holder<V>> accumulators)
Returns an accumulator representing the accumulation of all the input values accumulated in
the merging accumulators.
|
static <V> Combine.BinaryCombineFn<V> |
of(SerializableBiFunction<V,V,V> combiner)
Returns a
CombineFn that uses the given SerializableBiFunction to combine
values. |
void |
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.
|
apply, compact, defaultValue, getInputType, getOutputType
public static <V> Combine.BinaryCombineFn<V> of(SerializableBiFunction<V,V,V> combiner)
CombineFn
that uses the given SerializableBiFunction
to combine
values.public abstract V apply(V left, V right)
public V identity()
public Combine.Holder<V> createAccumulator()
Combine.CombineFn
createAccumulator
in class Combine.CombineFn<V,Combine.Holder<V>,V>
public Combine.Holder<V> addInput(Combine.Holder<V> accumulator, V input)
Combine.CombineFn
addInput
in class Combine.CombineFn<V,Combine.Holder<V>,V>
accumulator
- may be modified and returned for efficiencyinput
- should not be mutatedpublic Combine.Holder<V> mergeAccumulators(java.lang.Iterable<Combine.Holder<V>> accumulators)
Combine.CombineFn
mergeAccumulators
in class Combine.CombineFn<V,Combine.Holder<V>,V>
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.public V extractOutput(Combine.Holder<V> accumulator)
Combine.CombineFn
extractOutput
in class Combine.CombineFn<V,Combine.Holder<V>,V>
accumulator
- can be modified for efficiencypublic Coder<Combine.Holder<V>> getAccumulatorCoder(CoderRegistry registry, Coder<V> inputCoder)
CombineFnBase.GlobalCombineFn
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.
getAccumulatorCoder
in interface CombineFnBase.GlobalCombineFn<V,Combine.Holder<V>,V>
public Coder<V> getDefaultOutputCoder(CoderRegistry registry, Coder<V> inputCoder)
CombineFnBase.GlobalCombineFn
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.
getDefaultOutputCoder
in interface CombineFnBase.GlobalCombineFn<V,Combine.Holder<V>,V>
public java.lang.String getIncompatibleGlobalWindowErrorMessage()
CombineFnBase.GlobalCombineFn
getIncompatibleGlobalWindowErrorMessage
in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
public java.lang.reflect.TypeVariable<?> getInputTVariable()
TypeVariable
of InputT
.public java.lang.reflect.TypeVariable<?> getAccumTVariable()
TypeVariable
of AccumT
.public java.lang.reflect.TypeVariable<?> getOutputTVariable()
TypeVariable
of OutputT
.public void populateDisplayData(DisplayData.Builder builder)
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.
populateDisplayData
in interface HasDisplayData
builder
- The builder to populate with display data.HasDisplayData