com.hazelcast.jet.pipeline

Interface StageWithWindow<T>

Type Parameters:

T - type of the input item

public interface StageWithWindow<T>

Represents an intermediate step in the construction of a pipeline stage that performs a windowed aggregate operation. You can perform a global aggregation or add a grouping key to perform a group-and-aggregate operation.

Method Summary

Modifier and Type	Method and Description
default <A,R> StreamStage<TimestampedItem<R>>	aggregate(AggregateOperation1<? super T,A,R> aggrOp) Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to a given window.
<A,R,OUT> StreamStage<OUT>	aggregate(AggregateOperation1<? super T,A,R> aggrOp, WindowResultFunction<? super R,? extends OUT> mapToOutputFn) Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to a given window.
default <T1,A,R> StreamStage<TimestampedItem<R>>	aggregate2(StreamStage<T1> stage1, AggregateOperation2<? super T,? super T1,A,R> aggrOp) Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to the same window.
<T1,A,R,OUT> StreamStage<OUT>	aggregate2(StreamStage<T1> stage1, AggregateOperation2<? super T,? super T1,A,R> aggrOp, WindowResultFunction<? super R,? extends OUT> mapToOutputFn) Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to the same window.
default <T1,T2,A,R> StreamStage<TimestampedItem<R>>	aggregate3(StreamStage<T1> stage1, StreamStage<T2> stage2, AggregateOperation3<? super T,? super T1,? super T2,A,R> aggrOp) Attaches to this stage a stage that performs the given aggregate operation over the items it receives from this stage as well as stage1 and stage2 you supply.
<T1,T2,A,R,OUT> StreamStage<OUT>	aggregate3(StreamStage<T1> stage1, StreamStage<T2> stage2, AggregateOperation3<? super T,? super T1,? super T2,A,R> aggrOp, WindowResultFunction<? super R,? extends OUT> mapToOutputFn) Attaches to this stage a stage that performs the given aggregate operation over the items it receives from this stage as well as stage1 and stage2 you supply.
default WindowAggregateBuilder<T>	aggregateBuilder() Returns a fluent API builder object to construct an windowed aggregating stage with any number of contributing stages.
<K> StageWithGroupingAndWindow<T,K>	groupingKey(DistributedFunction<? super T,? extends K> keyFn) Specifes the function that will extract the grouping key from the items in the associated pipeline stage and moves on to the step in which you'll complete the construction of a windowed group-and-aggregate stage.
StreamStage<T>	streamStage() Returns the pipeline stage associated with this object.
WindowDefinition	windowDefinition() Returns the definition of the window for the windowed aggregation operation that you are about to construct using this object.

Method Detail

streamStage

@Nonnull
StreamStage<T> streamStage()

Returns the pipeline stage associated with this object. It is the stage to which you are about to attach an aggregating stage.

windowDefinition

@Nonnull
WindowDefinition windowDefinition()

Returns the definition of the window for the windowed aggregation operation that you are about to construct using this object.

groupingKey

@Nonnull
<K> StageWithGroupingAndWindow<T,K> groupingKey(@Nonnull
                                                         DistributedFunction<? super T,? extends K> keyFn)

Specifes the function that will extract the grouping key from the items in the associated pipeline stage and moves on to the step in which you'll complete the construction of a windowed group-and-aggregate stage.

Type Parameters:

K - type of the key

Parameters:

keyFn - function that extracts the grouping key

aggregate

@Nonnull
<A,R,OUT> StreamStage<OUT> aggregate(@Nonnull
                                              AggregateOperation1<? super T,A,R> aggrOp,
                                              @Nonnull
                                              WindowResultFunction<? super R,? extends OUT> mapToOutputFn)

Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to a given window. Once the window is complete, it invokes mapToOutputFn with the result of the aggregate operation and emits its return value as the window result.

Type Parameters:

A - the type of the accumulator used by the aggregate operation

R - the type of the result

Parameters:

aggrOp - the aggregate operation to perform

mapToOutputFn - the function that creates the output item

See Also:

AggregateOperations

aggregate

@Nonnull
default <A,R> StreamStage<TimestampedItem<R>> aggregate(@Nonnull
                                                                 AggregateOperation1<? super T,A,R> aggrOp)

Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to a given window. Once the window is complete, it emits a TimestampedItem with the result of the aggregate operation and the timestamp denoting the window's ending time.

Type Parameters:

A - the type of the accumulator used by the aggregate operation

R - the type of the result

Parameters:

aggrOp - the aggregate operation to perform

See Also:

AggregateOperations

aggregate2

@Nonnull
<T1,A,R,OUT> StreamStage<OUT> aggregate2(@Nonnull
                                                  StreamStage<T1> stage1,
                                                  @Nonnull
                                                  AggregateOperation2<? super T,? super T1,A,R> aggrOp,
                                                  @Nonnull
                                                  WindowResultFunction<? super R,? extends OUT> mapToOutputFn)

Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to the same window. It receives the items from both this stage and stage1. Once a given window is complete, it invokes mapToOutputFn with the result of the aggregate operation and emits its return value as the window result.

The aggregate operation must specify a separate accumulator function for each of the two streams (refer to its Javadoc for a simple example).

The aggregating stage emits a single item for each completed window.

Type Parameters:

T1 - type of items in stage1

A - type of the accumulator used by the aggregate operation

R - type of the result

Parameters:

aggrOp - the aggregate operation to perform

mapToOutputFn - the function that creates the output item

See Also:

AggregateOperations

aggregate2

@Nonnull
default <T1,A,R> StreamStage<TimestampedItem<R>> aggregate2(@Nonnull
                                                                     StreamStage<T1> stage1,
                                                                     @Nonnull
                                                                     AggregateOperation2<? super T,? super T1,A,R> aggrOp)

Attaches to this stage a stage that performs the given aggregate operation over all the items that belong to the same window. It receives the items from both this stage and stage1. Once a given window is complete, it emits a TimestampedItem with the result of the aggregate operation and the timestamp denoting the window's ending time.

The aggregate operation must specify a separate accumulator function for each of the two streams (refer to its Javadoc for a simple example).

Type Parameters:

T1 - type of items in stage1

A - type of the accumulator used by the aggregate operation

R - type of the result

Parameters:

aggrOp - the aggregate operation to perform

See Also:

AggregateOperations

aggregate3

@Nonnull
<T1,T2,A,R,OUT> StreamStage<OUT> aggregate3(@Nonnull
                                                     StreamStage<T1> stage1,
                                                     @Nonnull
                                                     StreamStage<T2> stage2,
                                                     @Nonnull
                                                     AggregateOperation3<? super T,? super T1,? super T2,A,R> aggrOp,
                                                     @Nonnull
                                                     WindowResultFunction<? super R,? extends OUT> mapToOutputFn)

Attaches to this stage a stage that performs the given aggregate operation over the items it receives from this stage as well as stage1 and stage2 you supply. Once a given window is complete, it invokes mapToOutputFn with the result of the aggregate operation and emits its return value as the window result.

The aggregate operation must specify a separate accumulator function for each of the three streams (refer to its Javadoc for a simple example).

Type Parameters:

T1 - type of items in stage1

T2 - type of items in stage2

A - type of the accumulator used by the aggregate operation

R - type of the result

Parameters:

aggrOp - the aggregate operation to perform

See Also:

AggregateOperations

aggregate3

@Nonnull
default <T1,T2,A,R> StreamStage<TimestampedItem<R>> aggregate3(@Nonnull
                                                                        StreamStage<T1> stage1,
                                                                        @Nonnull
                                                                        StreamStage<T2> stage2,
                                                                        @Nonnull
                                                                        AggregateOperation3<? super T,? super T1,? super T2,A,R> aggrOp)

Attaches to this stage a stage that performs the given aggregate operation over the items it receives from this stage as well as stage1 and stage2 you supply. Once a given window is complete, it emits a TimestampedItem with the result of the aggregate operation and the timestamp denoting the window's ending time.

The aggregate operation must specify a separate accumulator function for each of the three streams (refer to its Javadoc for a simple example).

Type Parameters:

T1 - type of items in stage1

T2 - type of items in stage2

A - type of the accumulator used by the aggregate operation

R - type of the result

Parameters:

aggrOp - the aggregate operation to perform

See Also:

AggregateOperations

aggregateBuilder

@Nonnull
default WindowAggregateBuilder<T> aggregateBuilder()

Returns a fluent API builder object to construct an windowed aggregating stage with any number of contributing stages. It is mainly intended to co-aggregate four or more stages. For up to three stages prefer the direct stage.aggregateN(...) calls because they offer more static type safety.