org.mule.extension.aggregator.internal.storage.content

Interface AggregatedContent

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAggregatedContent, SimpleAggregatedContent

public interface AggregatedContent
extends Serializable

Method Summary

Modifier and Type	Method and Description
void	add(org.mule.runtime.api.metadata.TypedValue newElement, Long timestamp) Add a new element to the storage
void	add(org.mule.runtime.api.metadata.TypedValue newElement, Long timestamp, int sequenceNumber) Add a new element to the storage
List<org.mule.runtime.api.metadata.TypedValue>	getAggregatedElements() Gets the aggregated elements from the storage
Long	getFirstValueArrivalTime() Get a timestamp representing when the first value was aggregated
Long	getLastValueArrivalTime() Get a timestamp with the time of the last aggregated element
boolean	isComplete() Get a boolean indicating if the number of elements is equal to the maximum allowed
boolean	upgradeIfNeeded() Deprecated.

Method Detail

add

void add(org.mule.runtime.api.metadata.TypedValue newElement,
         Long timestamp)

Add a new element to the storage

Parameters:

newElement - the element to be added

timestamp - the moment when the element was added

add

void add(org.mule.runtime.api.metadata.TypedValue newElement,
         Long timestamp,
         int sequenceNumber)

Add a new element to the storage

Parameters:

newElement - the element to be added

timestamp - the moment when the element was added

sequenceNumber - the position of the new element inside content being aggregated

getAggregatedElements

List<org.mule.runtime.api.metadata.TypedValue> getAggregatedElements()

Gets the aggregated elements from the storage

Returns:

all the elements in the storage

getFirstValueArrivalTime

Long getFirstValueArrivalTime()

Get a timestamp representing when the first value was aggregated

Returns:

a timestamp with the time of the first aggregated value

getLastValueArrivalTime

Long getLastValueArrivalTime()

Get a timestamp with the time of the last aggregated element

Returns:

a timestamp with the time of the last aggregated element

isComplete

boolean isComplete()

Get a boolean indicating if the number of elements is equal to the maximum allowed

Returns:

true if the group is complete, false otherwise

upgradeIfNeeded

@Deprecated
boolean upgradeIfNeeded()

Deprecated.

This method upgrades the sequenced elements to the new data structure for backward compatibility.

Returns:

true if the upgrade was made, false otherwise.