org.gridgain.grid.streamer.index.tree

Class GridStreamerTreeIndexProvider<E,K,V>

java.lang.Object

org.gridgain.grid.streamer.index.GridStreamerIndexProviderAdapter<E,K,V>

org.gridgain.grid.streamer.index.tree.GridStreamerTreeIndexProvider<E,K,V>

All Implemented Interfaces:

GridStreamerIndexProvider<E,K,V>, GridStreamerIndexProviderMBean

public class GridStreamerTreeIndexProvider<E,K,V>
extends GridStreamerIndexProviderAdapter<E,K,V>

Tree index implementation of a GridStreamerIndexProvider.

The advantage of a tree index is that it maintains entries in a sorted order, which is invaluable for many kinds of tasks, where event ordering makes sense (like GridStreamingPopularNumbersExample). The drawback is that the index entry values should be comparable to each other, and you'll are likely to need to implement a custom comparator for values in place of a default one.

If ordering is not required, consider using GridStreamerHashIndexProvider instead, which is more efficient (O(1) vs. O(log(n))) and does not require comparability.

See Also:

GridStreamerHashIndexProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.gridgain.grid.streamer.index.GridStreamerIndexProviderAdapter

GridStreamerIndexProviderAdapter.DedupTrackingEntry<E,K,V>, GridStreamerIndexProviderAdapter.Entry<E,K,V>, GridStreamerIndexProviderAdapter.EventTrackingEntry<E,K,V>, GridStreamerIndexProviderAdapter.IndexKey<V>, GridStreamerIndexProviderAdapter.NonTrackingEntry<E,K,V>

Field Summary

Fields inherited from class org.gridgain.grid.streamer.index.GridStreamerIndexProviderAdapter

entryToKey, entryToVal

Constructor Summary

Constructors

Constructor and Description
GridStreamerTreeIndexProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	add(E evt, K key, GridStreamerIndexUpdateSync sync) Add event to the index.
protected void	endUpdate0(GridStreamerIndexUpdateSync sync, E evt, K key, boolean rollback)
protected GridStreamerIndex<E,K,V>	index0()
void	initialize() Initializes the index.
protected GridStreamerIndexProviderAdapter.IndexKey<V>	nextKey(V val)
protected void	remove(E evt, K key, GridStreamerIndexUpdateSync sync) Remove event from the index.
void	reset0() Called on reset.
void	setComparator(Comparator<V> cmp) Sets comparator.
boolean	sorted() Returns true if index supports sorting and therefore can perform range operations.

Methods inherited from class org.gridgain.grid.streamer.index.GridStreamerIndexProviderAdapter

add, addEvent, addToCollection, addToMap, dispose, endUpdate, eventsCount, getName, getPolicy, getUpdater, index, isUnique, lockIndexKey, name, newEntry, policy, readLock, readUnlock, remove, removeEvent, removeFromCollection, removeFromMap, reset, setName, setPolicy, setUnique, setUpdater, size, toString, trieGet, unique, unlockIndexKey, updaterClass, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

GridStreamerTreeIndexProvider

public GridStreamerTreeIndexProvider()

Method Detail

setComparator

public void setComparator(Comparator<V> cmp)

Sets comparator.

Parameters:

cmp - Comparator.

index0

protected GridStreamerIndex<E,K,V> index0()

Specified by:

index0 in class GridStreamerIndexProviderAdapter<E,K,V>

Returns:

Index

initialize

public void initialize()

Initializes the index.

reset0

public void reset0()

Called on reset.

Specified by:

reset0 in class GridStreamerIndexProviderAdapter<E,K,V>

add

protected void add(E evt,
       K key,
       GridStreamerIndexUpdateSync sync)
            throws GridException

Add event to the index.

Specified by:

add in class GridStreamerIndexProviderAdapter<E,K,V>

Parameters:

evt - Event.

key - key.

sync - Sync.

Throws:

GridException - If failed.

remove

protected void remove(E evt,
          K key,
          GridStreamerIndexUpdateSync sync)
               throws GridException

Remove event from the index.

Specified by:

remove in class GridStreamerIndexProviderAdapter<E,K,V>

Parameters:

evt - Event.

key - Key.

sync - Sync.

Throws:

GridException - If failed.

endUpdate0

protected void endUpdate0(GridStreamerIndexUpdateSync sync,
              E evt,
              K key,
              boolean rollback)

Specified by:

endUpdate0 in class GridStreamerIndexProviderAdapter<E,K,V>

Parameters:

sync - Sync.

evt - Event.

key - Key.

rollback - Rollback flag.

nextKey

protected GridStreamerIndexProviderAdapter.IndexKey<V> nextKey(V val)

Parameters:

val - Value.

Returns:

Index key.

sorted

public boolean sorted()

Returns true if index supports sorting and therefore can perform range operations.

Returns:

Index sorted flag.