org.wso2.siddhi.core.util.collection.executor

Interface CollectionExecutor

All Known Implementing Classes:

AndMultiPrimaryKeyCollectionExecutor, AnyAndCollectionExecutor, CompareCollectionExecutor, CompareExhaustiveAndCollectionExecutor, ExhaustiveCollectionExecutor, NonAndCollectionExecutor, NonCollectionExecutor, NotCollectionExecutor, OrCollectionExecutor

public interface CollectionExecutor

Interface for executors which will operate on a collection of events(i.e StateEvent). These will be used by in-memory table implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CollectionExecutor.Cost Enums to specify operation cost.

Method Summary

Modifier and Type	Method and Description
boolean	contains(StateEvent matchingEvent, IndexedEventHolder indexedEventHolder) Checks if a matching event exist in indexedEventHolder
void	delete(StateEvent deletingEvent, IndexedEventHolder indexedEventHolder) Delete matching events exists from indexedEventHolder
StreamEvent	find(StateEvent matchingEvent, IndexedEventHolder indexedEventHolder, StreamEventCloner storeEventCloner) Find the Events matching to the condition, used on the primary call
Collection<StreamEvent>	findEvents(StateEvent matchingEvent, IndexedEventHolder indexedEventHolder) Find the Events matching to the condition, used for consecutive calls from parent CollectionExecutor
CollectionExecutor.Cost	getDefaultCost()

Method Detail

find

StreamEvent find(StateEvent matchingEvent,
                 IndexedEventHolder indexedEventHolder,
                 StreamEventCloner storeEventCloner)

Find the Events matching to the condition, used on the primary call

Parameters:

matchingEvent - matching input event

indexedEventHolder - indexed EventHolder containing data

storeEventCloner - store event cloner

Returns:

matched StreamEvent, null if no events matched. If storeEventCloner is null it will return the actual event references.

findEvents

Collection<StreamEvent> findEvents(StateEvent matchingEvent,
                                   IndexedEventHolder indexedEventHolder)

Find the Events matching to the condition, used for consecutive calls from parent CollectionExecutor

Parameters:

matchingEvent - matching input event

indexedEventHolder - indexed EventHolder containing data

Returns:

matched events as Set, null if Exhaustive processing need to be done.

contains

boolean contains(StateEvent matchingEvent,
                 IndexedEventHolder indexedEventHolder)

Checks if a matching event exist in indexedEventHolder

Parameters:

matchingEvent - matching input event

indexedEventHolder - indexed EventHolder containing data

Returns:

true if a matching event is available in indexedEventHolder else false

delete

void delete(StateEvent deletingEvent,
            IndexedEventHolder indexedEventHolder)

Delete matching events exists from indexedEventHolder

Parameters:

deletingEvent - matching input event

indexedEventHolder - indexed EventHolder containing data

getDefaultCost

CollectionExecutor.Cost getDefaultCost()