com.google.cloud.dataflow.sdk.transforms

Class Combine.IterableCombineFn<V>

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.Combine.CombineFn<V,List<V>,V>

com.google.cloud.dataflow.sdk.transforms.Combine.IterableCombineFn<V>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Combine.SimpleCombineFn

Enclosing class:

Combine

public static class Combine.IterableCombineFn<V>
extends Combine.CombineFn<V,List<V>,V>

Converts a SerializableFunction from Iterable<V>s to Vs into a simple Combine.CombineFn over Vs.

Used in the implementation of convenience methods like Combine.globally(SerializableFunction), Combine.perKey(SerializableFunction), and Combine.groupedValues(SerializableFunction).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
List<V>	addInput(List<V> accumulator, V input) Adds the given input value to the given accumulator, returning the new accumulator value.
List<V>	createAccumulator() Returns a new, mutable accumulator value, representing the accumulation of zero input values.
V	extractOutput(List<V> accumulator) Returns the output value that is the result of combining all the input values represented by the given accumulator.
List<V>	mergeAccumulators(Iterable<List<V>> accumulators) Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.
static <V> Combine.IterableCombineFn<V>	of(SerializableFunction<Iterable<V>,V> combiner) Returns a CombineFn that uses the given SerializableFunction to combine values.
static <V> Combine.IterableCombineFn<V>	of(SerializableFunction<Iterable<V>,V> combiner, int bufferSize) Returns a CombineFn that uses the given SerializableFunction to combine values, attempting to buffer at least bufferSize values between invocations.

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.Combine.CombineFn

apply, asKeyedFn, getAccumulatorCoder, getDefaultOutputCoder, getOutputType

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <V> Combine.IterableCombineFn<V> of(SerializableFunction<Iterable<V>,V> combiner)

Returns a CombineFn that uses the given SerializableFunction to combine values.

of

public static <V> Combine.IterableCombineFn<V> of(SerializableFunction<Iterable<V>,V> combiner,
                                                  int bufferSize)

Returns a CombineFn that uses the given SerializableFunction to combine values, attempting to buffer at least bufferSize values between invocations.

createAccumulator

public List<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,List<V>,V>

addInput

public List<V> addInput(List<V> accumulator,
                        V 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 class Combine.CombineFn<V,List<V>,V>

mergeAccumulators

public List<V> mergeAccumulators(Iterable<List<V>> 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 class Combine.CombineFn<V,List<V>,V>

extractOutput

public V extractOutput(List<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,List<V>,V>