org.gridgain.grid.streamer.index

Interface GridStreamerIndexProvider<E,K,V>

All Superinterfaces:

GridStreamerIndexProviderMBean

All Known Implementing Classes:

GridStreamerHashIndexProvider, GridStreamerIndexProviderAdapter, GridStreamerTreeIndexProvider

public interface GridStreamerIndexProvider<E,K,V>
extends GridStreamerIndexProviderMBean

Represents an actual instance of an index. Used by a GridStreamerWindow to perform event indexing.

To configure index for a streamer window, use GridStreamerWindowAdapter.setIndexes(GridStreamerIndexProvider[]).

Method Summary

Methods

Modifier and Type	Method and Description
void	add(GridStreamerIndexUpdateSync sync, E evt) Adds an event to index.
void	dispose() Disposes the index.
void	endUpdate(GridStreamerIndexUpdateSync sync, E evt, boolean rollback, boolean rmv) Finalizes an update operation.
String	getName() Gets index name.
GridStreamerIndexPolicy	getPolicy() Gets event indexing policy, which defines how events are tracked within an index.
GridStreamerIndex<E,K,V>	index() Gets user view for this index.
void	initialize() Initializes the index.
boolean	isUnique() Checks whether this index is unique or not.
void	remove(GridStreamerIndexUpdateSync sync, E evt) Removes an event from index.
void	reset() Resets the index to an initial empty state.

Methods inherited from interface org.gridgain.grid.streamer.index.GridStreamerIndexProviderMBean

name, policy, size, sorted, unique, updaterClass

Method Detail

getName

String getName()

Gets index name.

Returns:

Name of the index.

index

GridStreamerIndex<E,K,V> index()

Gets user view for this index. This view is a snapshot of a current index state. Once returned, it does not change over time.

Returns:

User view for this index.

initialize

void initialize()

Initializes the index.

reset

void reset()

Resets the index to an initial empty state.

dispose

void dispose()

Disposes the index.

add

void add(GridStreamerIndexUpdateSync sync,
       E evt)
         throws GridException

Adds an event to index.

Parameters:

sync - Index update synchronizer.

evt - Event to add to an index.

Throws:

GridException - If failed to add event to an index.

remove

void remove(GridStreamerIndexUpdateSync sync,
          E evt)
            throws GridException

Removes an event from index.

Parameters:

sync - Index update synchronizer.

evt - Event to remove from index.

Throws:

GridException - If failed to add event to an index.

getPolicy

GridStreamerIndexPolicy getPolicy()

Gets event indexing policy, which defines how events are tracked within an index.

Returns:

index policy.

isUnique

boolean isUnique()

Checks whether this index is unique or not. If it is, equal events are not allowed, which means that if a newly-added event is found to be equal to one of the already present events (Object.equals(Object) returns true), an exception is thrown.

Returns:

True for unique index.

endUpdate

void endUpdate(GridStreamerIndexUpdateSync sync,
             E evt,
             boolean rollback,
             boolean rmv)

Finalizes an update operation.

Parameters:

sync - Index update synchronizer.

evt - Updated event.

rollback - Rollback flag. If true, a rollback was made.

rmv - Remove flag. If true, the event was removed from index.