org.mule.extension.aggregator.internal.operations

Class TimeBasedAggregatorOperations

java.lang.Object

org.mule.extension.aggregator.internal.operations.AbstractAggregatorOperations

org.mule.extension.aggregator.internal.operations.SingleGroupAggregatorOperations

org.mule.extension.aggregator.internal.operations.TimeBasedAggregatorOperations

public class TimeBasedAggregatorOperations
extends SingleGroupAggregatorOperations

Constructor Summary

Constructors

Constructor and Description
TimeBasedAggregatorOperations()

Method Summary

Modifier and Type	Method and Description
void	aggregateByTime(TimeBasedAggregatorParameterGroup aggregatorParameters, IncrementalAggregationRoute incrementalAggregationRoute, org.mule.runtime.extension.api.runtime.process.RouterCompletionCallback completionCallback) This aggregator aggregates elements until it reaches the specified time period.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeBasedAggregatorOperations

public TimeBasedAggregatorOperations()

Method Detail

aggregateByTime

@Alias(value="timeBasedAggregator")
 @Throws(value=AggregatorErrorProvider.class)
public void aggregateByTime(@ParameterGroup(name="Aggregator config")
                                                                                                              TimeBasedAggregatorParameterGroup aggregatorParameters,
                                                                                                              @ChainInputResolver(value=AggregationChainInputResolver.class) @ExecutionOccurrence(value=ONCE_OR_NONE) @Alias(value="incrementalAggregation") @Optional
                                                                                                              IncrementalAggregationRoute incrementalAggregationRoute,
                                                                                                              org.mule.runtime.extension.api.runtime.process.RouterCompletionCallback completionCallback)

This aggregator aggregates elements until it reaches the specified time period.

The period to be taken into account will start being computed from the time the first event occurs. Once that aggregation is released, the timer will not start until the next event.

The aggregator also allows an incrementalAggregationRoute route that will be executed every time a new event arrives, unless maxSize is set. If that is the case, the inclrementalAggregation route will be executed every time except when the size of the aggregated elements is equal to maxSize. In that moment, a listener's callback(if any) is executed.

Parameters:

aggregatorParameters - Define the behaviour of the aggregator

incrementalAggregationRoute - Route to be called with every new event

completionCallback - Callback to notify route completion