com.espertech.esper.epl.join.table
Interface EventTable

All Superinterfaces:

java.lang.Iterable<EventBean>

All Known Subinterfaces:

EventTableAsSet

All Known Implementing Classes:

MultiIndexEventTable, PropertyCompositeEventTable, PropertyIndexedEventTable, PropertyIndexedEventTableCoerceAdd, PropertyIndexedEventTableCoerceAll, PropertyIndexedEventTableSingle, PropertyIndexedEventTableSingleCoerceAdd, PropertyIndexedEventTableSingleCoerceAll, PropertyIndexedEventTableSingleUnique, PropertyIndexedEventTableUnique, PropertySortedEventTable, PropertySortedEventTableCoerced, SingleReferenceEventTable, UnindexedEventTable, UnindexedEventTableList, VirtualDWEventTable

public interface EventTable
extends java.lang.Iterable<EventBean>

Table of events allowing add and remove. Lookup in table is coordinated through the underlying implementation.

Method Summary

void	add(EventBean event) Add event to table.
void	add(EventBean[] events) Add events to table.
void	addRemove(EventBean[] newData, EventBean[] oldData) Add and remove events from table.
void	clear() Clear out index.
java.lang.Object	getIndex() Return the index object itself, or an object-array for multiple index structures.
java.lang.Integer	getNumberOfEvents() If the number of events is readily available, an implementation will return that number or it may return null to indicate that the count is not readily available.
int	getNumKeys() If the index retains events using some key-based organization this returns the number of keys, and may return null to indicate that either the number of keys is not available or costly to obtain.
EventTableOrganization	getOrganization()
boolean	isEmpty() Returns true if the index is empty, or false if not
java.util.Iterator<EventBean>	iterator() Returns an iterator over events in the table.
void	remove(EventBean event) Remove event from table.
void	remove(EventBean[] events) Remove events from table.
java.lang.String	toQueryPlan()

Method Detail

addRemove

void addRemove(EventBean[] newData,
               EventBean[] oldData)

Add and remove events from table.

It is up to the index to decide whether to add first and then remove, or whether to remove and then add.

It is important to note that a given event can be in both the removed and the added events. This means that unique indexes probably need to remove first and then add. Most other non-unique indexes will add first and then remove since the an event can be both in the add and the remove stream.

Parameters:

newData - to add

oldData - to remove

add

void add(EventBean[] events)

Add events to table.

Parameters:

events - to add

add

void add(EventBean event)

Add event to table.

Parameters:

event - to add

remove

void remove(EventBean[] events)

Remove events from table.

Parameters:

events - to remove

remove

void remove(EventBean event)

Remove event from table.

Parameters:

event - to remove

iterator

java.util.Iterator<EventBean> iterator()

Returns an iterator over events in the table.

Specified by:

iterator in interface java.lang.Iterable<EventBean>

Returns:

table iterator

isEmpty

boolean isEmpty()

Returns true if the index is empty, or false if not

Returns:

true for empty index

clear

void clear()

Clear out index.

toQueryPlan

java.lang.String toQueryPlan()

getNumberOfEvents

java.lang.Integer getNumberOfEvents()

If the number of events is readily available, an implementation will return that number or it may return null to indicate that the count is not readily available.

Returns:

number of events

getNumKeys

int getNumKeys()

If the index retains events using some key-based organization this returns the number of keys, and may return null to indicate that either the number of keys is not available or costly to obtain.

The number returned can be an estimate and may not be accurate.

Returns:

number of events

getIndex

java.lang.Object getIndex()

Return the index object itself, or an object-array for multiple index structures.

May return null if the information is not readily available, i.e. externally maintained index

Returns:

index object

getOrganization

EventTableOrganization getOrganization()