org.gridgain.grid.streamer.index

Class GridStreamerIndexProviderAdapter<E,K,V>

java.lang.Object

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

All Implemented Interfaces:

GridStreamerIndexProvider<E,K,V>, GridStreamerIndexProviderMBean

Direct Known Subclasses:

GridStreamerHashIndexProvider, GridStreamerTreeIndexProvider

public abstract class GridStreamerIndexProviderAdapter<E,K,V>
extends Object
implements GridStreamerIndexProvider<E,K,V>

Convenient GridStreamerIndexProvider adapter implementing base configuration methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GridStreamerIndexProviderAdapter.DedupTrackingEntry<E,K,V> Entry with index policy GridStreamerIndexPolicy.EVENT_TRACKING_ON_DEDUP.
protected static class	GridStreamerIndexProviderAdapter.Entry<E,K,V> Streamer window index entry.
protected static class	GridStreamerIndexProviderAdapter.EventTrackingEntry<E,K,V> Entry with index policy GridStreamerIndexPolicy.EVENT_TRACKING_ON.
protected static interface	GridStreamerIndexProviderAdapter.IndexKey<V> Streamer window index key.
protected static class	GridStreamerIndexProviderAdapter.NonTrackingEntry<E,K,V> Entry with index policy GridStreamerIndexPolicy.EVENT_TRACKING_OFF.

Field Summary

Fields

Modifier and Type	Field and Description
protected GridClosure<GridStreamerIndexEntry<E,K,V>,K>	entryToKey
protected GridClosure<GridStreamerIndexEntry<E,K,V>,V>	entryToVal

Constructor Summary

Constructors

Constructor and Description
GridStreamerIndexProviderAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	add(E evt, K key, GridStreamerIndexUpdateSync sync) Add event to the index.
void	add(GridStreamerIndexUpdateSync sync, E evt) Add event to the index.
protected GridStreamerIndexProviderAdapter.Entry<E,K,V>	addEvent(GridStreamerIndexEntry<E,K,V> oldEntry, K key, V val, GridStreamerIndexProviderAdapter.IndexKey<V> idxKey, E evt)
protected static <E> Collection<E>	addToCollection(Collection<E> col, E evt)
protected static <E> Map<E,Integer>	addToMap(Map<E,Integer> map, E evt)
void	dispose() Disposes the index.
void	endUpdate(GridStreamerIndexUpdateSync sync, E evt, boolean rollback, boolean rmv) Finalizes an update operation.
protected abstract void	endUpdate0(GridStreamerIndexUpdateSync sync, E evt, K key, boolean rollback)
protected int	eventsCount()
String	getName() Gets index name.
GridStreamerIndexPolicy	getPolicy() Gets event indexing policy, which defines how events are tracked within an index.
GridStreamerIndexUpdater<E,K,V>	getUpdater() Gets index updater.
GridStreamerIndex<E,K,V>	index() Gets user view for this index.
protected abstract GridStreamerIndex<E,K,V>	index0()
boolean	isUnique() Checks whether this index is unique or not.
protected void	lockIndexKey(GridStreamerIndexProviderAdapter.IndexKey<V> key, GridStreamerIndexUpdateSync sync) Lock updates on particular key.
String	name() Index name.
protected GridStreamerIndexProviderAdapter.Entry<E,K,V>	newEntry(K key, V val, GridStreamerIndexProviderAdapter.IndexKey<V> idxKey, E evt)
GridStreamerIndexPolicy	policy() Gets index policy.
protected void	readLock()
protected void	readUnlock()
protected abstract void	remove(E evt, K key, GridStreamerIndexUpdateSync sync) Remove event from the index.
void	remove(GridStreamerIndexUpdateSync sync, E evt) Remove event from the index.
protected GridStreamerIndexProviderAdapter.Entry<E,K,V>	removeEvent(GridStreamerIndexEntry<E,K,V> oldEntry, K key, V val, GridStreamerIndexProviderAdapter.IndexKey<V> idxKey, E evt)
protected static <E> Collection<E>	removeFromCollection(Collection<E> col, E evt)
protected static <E> Map<E,Integer>	removeFromMap(Map<E,Integer> map, E evt)
void	reset() Resets the index to an initial empty state.
protected abstract void	reset0() Called on reset.
void	setName(String name) Sets index name.
void	setPolicy(GridStreamerIndexPolicy plc) Sets index policy.
void	setUnique(boolean unique) Sets unique flag.
void	setUpdater(GridStreamerIndexUpdater<E,K,V> updater) Sets index updater.
int	size() Gets current index size.
String	toString()
protected static <K,V> V	trieGet(K key, TrieMap<K,V> map) Utility method to safely get values from TrieMap.
boolean	unique() Gets index unique flag.
protected void	unlockIndexKey(GridStreamerIndexProviderAdapter.IndexKey<V> key, GridStreamerIndexUpdateSync sync) Unlock updates on particular key.
String	updaterClass() Gets index updater class name.
protected void	writeLock()
protected void	writeUnlock()

Methods inherited from class java.lang.Object

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

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

initialize

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

sorted

Field Detail

entryToVal

protected final GridClosure<GridStreamerIndexEntry<E,K,V>,V> entryToVal

entryToKey

protected final GridClosure<GridStreamerIndexEntry<E,K,V>,K> entryToKey

Constructor Detail

GridStreamerIndexProviderAdapter

public GridStreamerIndexProviderAdapter()

Method Detail

setName

public void setName(String name)

Sets index name.

Parameters:

name - Index name.

getName

public String getName()

Gets index name.

Specified by:

getName in interface GridStreamerIndexProvider<E,K,V>

Returns:

Name of the index.

setPolicy

public void setPolicy(GridStreamerIndexPolicy plc)

Sets index policy.

Parameters:

plc - Policy.

getPolicy

public GridStreamerIndexPolicy getPolicy()

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

Specified by:

getPolicy in interface GridStreamerIndexProvider<E,K,V>

Returns:

index policy.

setUnique

public void setUnique(boolean unique)

Sets unique flag.

Parameters:

unique - True for unique index.

isUnique

public 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.

Specified by:

isUnique in interface GridStreamerIndexProvider<E,K,V>

Returns:

True for unique index.

setUpdater

public void setUpdater(GridStreamerIndexUpdater<E,K,V> updater)

Sets index updater.

Parameters:

updater - Updater.

getUpdater

public GridStreamerIndexUpdater<E,K,V> getUpdater()

Gets index updater.

Returns:

Updater.

dispose

public void dispose()

Disposes the index.

Specified by:

dispose in interface GridStreamerIndexProvider<E,K,V>

add

public void add(GridStreamerIndexUpdateSync sync,
       E evt)
         throws GridException

Add event to the index.

Specified by:

add in interface GridStreamerIndexProvider<E,K,V>

Parameters:

sync - Sync.

evt - Event.

Throws:

GridException - If failed to add event to an index.

remove

public void remove(GridStreamerIndexUpdateSync sync,
          E evt)
            throws GridException

Remove event from the index.

Specified by:

remove in interface GridStreamerIndexProvider<E,K,V>

Parameters:

sync - Sync.

evt - Event.

Throws:

GridException - If failed to add event to an index.

endUpdate

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

Finalizes an update operation.

Specified by:

endUpdate in interface GridStreamerIndexProvider<E,K,V>

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.

endUpdate0

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

Parameters:

sync - Sync.

evt - Event.

key - Key.

rollback - Rollback flag.

reset

public void reset()

Resets the index to an initial empty state.

Specified by:

reset in interface GridStreamerIndexProvider<E,K,V>

index

public 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.

Specified by:

index in interface GridStreamerIndexProvider<E,K,V>

Returns:

User view for this index.

reset0

protected abstract void reset0()

Called on reset.

index0

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

Returns:

Index

readLock

protected void readLock()

readUnlock

protected void readUnlock()

writeLock

protected void writeLock()

writeUnlock

protected void writeUnlock()

eventsCount

protected int eventsCount()

Returns:

Events count,

add

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

Add event to the index.

Parameters:

evt - Event.

key - key.

sync - Sync.

Throws:

GridException - If failed.

remove

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

Remove event from the index.

Parameters:

evt - Event.

key - Key.

sync - Sync.

Throws:

GridException - If failed.

lockIndexKey

protected void lockIndexKey(GridStreamerIndexProviderAdapter.IndexKey<V> key,
                GridStreamerIndexUpdateSync sync)
                     throws GridException

Lock updates on particular key.

Parameters:

key - Key.

sync - Sync.

Throws:

GridException - If failed.

unlockIndexKey

protected void unlockIndexKey(GridStreamerIndexProviderAdapter.IndexKey<V> key,
                  GridStreamerIndexUpdateSync sync)

Unlock updates on particular key.

Parameters:

key - Key.

sync - Sync.

newEntry

protected GridStreamerIndexProviderAdapter.Entry<E,K,V> newEntry(K key,
                                                     V val,
                                                     @Nullable
                                                     GridStreamerIndexProviderAdapter.IndexKey<V> idxKey,
                                                     E evt)

Parameters:

key - Key,

val - Value.

idxKey - Index key.

evt - Event.

Returns:

Entry.

addEvent

protected GridStreamerIndexProviderAdapter.Entry<E,K,V> addEvent(GridStreamerIndexEntry<E,K,V> oldEntry,
                                                     K key,
                                                     V val,
                                                     @Nullable
                                                     GridStreamerIndexProviderAdapter.IndexKey<V> idxKey,
                                                     E evt)

Parameters:

oldEntry - Old entry.

key - Key,

val - Value.

idxKey - Index key.

evt - Event.

Returns:

Entry.

removeEvent

protected GridStreamerIndexProviderAdapter.Entry<E,K,V> removeEvent(GridStreamerIndexEntry<E,K,V> oldEntry,
                                                        K key,
                                                        V val,
                                                        @Nullable
                                                        GridStreamerIndexProviderAdapter.IndexKey<V> idxKey,
                                                        E evt)

Parameters:

oldEntry - Old entry.

key - Key,

val - Value.

idxKey - Index key.

evt - Event.

Returns:

Entry.

addToCollection

protected static <E> Collection<E> addToCollection(@Nullable
                                Collection<E> col,
                                E evt)

Parameters:

col - Collection.

evt - Event.

Returns:

Cloned collection.

addToMap

protected static <E> Map<E,Integer> addToMap(@Nullable
                          Map<E,Integer> map,
                          E evt)

Parameters:

map - Collection.

evt - Event.

Returns:

Cloned map.

removeFromCollection

@Nullable
protected static <E> Collection<E> removeFromCollection(@Nullable
                                              Collection<E> col,
                                              E evt)

Parameters:

col - Collection.

evt - Event.

Returns:

Cloned collection.

removeFromMap

@Nullable
protected static <E> Map<E,Integer> removeFromMap(@Nullable
                                        Map<E,Integer> map,
                                        E evt)

Parameters:

map - Collection.

evt - Event.

Returns:

Cloned map.

name

public String name()

Index name.

Specified by:

name in interface GridStreamerIndexProviderMBean

Returns:

Index name.

updaterClass

public String updaterClass()

Gets index updater class name.

Specified by:

updaterClass in interface GridStreamerIndexProviderMBean

Returns:

Index updater class.

unique

public boolean unique()

Gets index unique flag.

Specified by:

unique in interface GridStreamerIndexProviderMBean

Returns:

Index unique flag.

policy

public GridStreamerIndexPolicy policy()

Gets index policy.

Specified by:

policy in interface GridStreamerIndexProviderMBean

Returns:

Index policy.

size

public int size()

Gets current index size.

Specified by:

size in interface GridStreamerIndexProviderMBean

Returns:

Current index size.

toString

public String toString()

Overrides:

toString in class Object

trieGet

protected static <K,V> V trieGet(K key,
              TrieMap<K,V> map)

Utility method to safely get values from TrieMap. See: https://github.com/romix/java-concurrent-hash-trie-map/issues/4

Parameters:

key - Key.

map - Trie map.

Returns:

Value from map.