org.gridgain.grid.streamer.window

Class GridStreamerWindowAdapter<E>

java.lang.Object

org.gridgain.grid.streamer.window.GridStreamerWindowAdapter<E>

All Implemented Interfaces:

Iterable<E>, GridLifecycleAware, GridStreamerWindow<E>, GridStreamerWindowMBean

Direct Known Subclasses:

GridStreamerBoundedSizeBatchWindow, GridStreamerBoundedSizeSortedWindow, GridStreamerBoundedSizeWindow, GridStreamerBoundedTimeBatchWindow, GridStreamerBoundedTimeWindow, GridStreamerUnboundedWindow

public abstract class GridStreamerWindowAdapter<E>
extends Object
implements GridLifecycleAware, GridStreamerWindow<E>, GridStreamerWindowMBean

Streamer window adapter.

Constructor Summary

Constructors

Constructor and Description
GridStreamerWindowAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	checkConfiguration() Check window configuration.
void	clearEvicted() Clears all evicted entries.
E	dequeue() Dequeues last element from windows.
Collection<E>	dequeue(int cnt) Dequeues up to cnt elements from window.
protected abstract Collection<E>	dequeue0(int cnt) Dequeues up to cnt elements from window.
Collection<E>	dequeueAll() Dequeues all elements from window.
boolean	enqueue(E... evts) Adds events to window.
boolean	enqueue(E evt) Adds single event to window.
protected abstract boolean	enqueue0(E evt) Adds event to window.
boolean	enqueueAll(Collection<E> evts) Adds all events to window.
String	getClassName() Gets window class name.
int	getEvictionQueueSize() Gets estimate for window eviction queue size.
GridPredicate<Object>	getFilter() Gets optional event filter.
String	getName() Gets window name.
int	getSize() Gets current window size.
<K,V> GridStreamerIndex<E,K,V>	index() Gets default index, if default index is not configured then IllegalArgumentException will be thrown.
<K,V> GridStreamerIndex<E,K,V>	index(String name) Gets index by name, if not index with such name was configured then IllegalArgumentException will be thrown.
Collection<GridStreamerIndex<E,?,?>>	indexes() Gets all indexes configured for this window.
GridStreamerIndexProvider<E,?,?>[]	indexProviders() Get array of index providers.
Iterator<E>	iterator()
protected abstract GridStreamerWindowIterator<E>	iterator0() Returns an iterator over a set of elements of type T without check for iteration limit.
String	name() Gets window name.
E	pollEvicted() If window supports eviction, this method will return next evicted element.
Collection<E>	pollEvicted(int cnt) If window supports eviction, this method will return up to cnt evicted elements.
protected abstract Collection<E>	pollEvicted0(int cnt) If window supports eviction, this method will return up to cnt evicted elements.
Collection<E>	pollEvictedAll() If window supports eviction, this method will return all available evicted elements.
Collection<E>	pollEvictedBatch() If window supports batch eviction, this method will poll next evicted batch from window.
protected abstract Collection<E>	pollEvictedBatch0() If window supports batch eviction, this method will poll next evicted batch from window.
void	reset() Resets window.
protected abstract void	reset0() Reset routine.
void	setFilter(GridPredicate<Object> filter) Sets event filter.
void	setIndexes(GridStreamerIndexProvider<E,?,?>... idxs) Set indexes.
void	setName(String name) Sets window name.
Collection<E>	snapshot(boolean includeEvicted) Create window snapshot.
void	start() Starts grid component, called on grid start.
void	stop() Stops grid component, called on grid shutdown.
protected abstract void	stop0() Dispose window.
protected void	updateIndexes(E evt, boolean rmv) Update indexes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.streamer.GridStreamerWindow

evictionQueueSize, size

Constructor Detail

GridStreamerWindowAdapter

public GridStreamerWindowAdapter()

Method Detail

getClassName

public String getClassName()

Gets window class name.

Specified by:

getClassName in interface GridStreamerWindowMBean

Returns:

Window class name.

getSize

public int getSize()

Gets current window size.

Specified by:

getSize in interface GridStreamerWindowMBean

Returns:

Current window size.

getEvictionQueueSize

public int getEvictionQueueSize()

Gets estimate for window eviction queue size.

Specified by:

getEvictionQueueSize in interface GridStreamerWindowMBean

Returns:

Eviction queue size estimate.

name

public String name()

Gets window name.

Specified by:

name in interface GridStreamerWindow<E>

Returns:

Window name.

getName

public String getName()

Gets window name.

Specified by:

getName in interface GridStreamerWindowMBean

Returns:

Window name.

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

iterator0

protected abstract GridStreamerWindowIterator<E> iterator0()

Returns an iterator over a set of elements of type T without check for iteration limit. That is, in case concurrent thread constantly adding new elements to the window we could iterate forever.

Returns:

Iterator.

enqueue

public boolean enqueue(E evt)
                throws GridException

Adds single event to window.

Specified by:

enqueue in interface GridStreamerWindow<E>

Parameters:

evt - Event to add.

Returns:

True if event was added.

Throws:

GridException - If index update failed.

enqueue

public boolean enqueue(E... evts)
                throws GridException

Adds events to window.

Specified by:

enqueue in interface GridStreamerWindow<E>

Parameters:

evts - Events to add.

Returns:

Throws:

GridException - If index update failed.

enqueueAll

public boolean enqueueAll(Collection<E> evts)
                   throws GridException

Adds all events to window.

Specified by:

enqueueAll in interface GridStreamerWindow<E>

Parameters:

evts - Collection of events to add.

Returns:

True if all events were added, false if at least 1 event was skipped.

Throws:

GridException - If index update failed.

enqueue0

protected abstract boolean enqueue0(E evt)

Adds event to window.

Parameters:

evt - Event.

Returns:

True if event added.

dequeue

public E dequeue()
          throws GridException

Dequeues last element from windows. Will return null if window is empty.

Specified by:

dequeue in interface GridStreamerWindow<E>

Returns:

Dequeued element.

Throws:

GridException - If index update failed.

dequeueAll

public Collection<E> dequeueAll()
                         throws GridException

Dequeues all elements from window.

Specified by:

dequeueAll in interface GridStreamerWindow<E>

Returns:

Collection of dequeued elements.

Throws:

GridException - If index update failed.

dequeue

public Collection<E> dequeue(int cnt)
                      throws GridException

Dequeues up to cnt elements from window. If current window size is less than cnt, will dequeue all elements from window.

Specified by:

dequeue in interface GridStreamerWindow<E>

Parameters:

cnt - Count to dequeue.

Returns:

Collection of dequeued elements.

Throws:

GridException - If index update failed.

dequeue0

protected abstract Collection<E> dequeue0(int cnt)

Dequeues up to cnt elements from window. If current window size is less than cnt, will dequeue all elements from window.

Parameters:

cnt - Count.

Returns:

Dequeued elements.

pollEvicted

public E pollEvicted()
              throws GridException

If window supports eviction, this method will return next evicted element.

Specified by:

pollEvicted in interface GridStreamerWindow<E>

Returns:

Polls and returns next evicted event or null if eviction queue is empty or if window does not support eviction.

Throws:

GridException - If index update failed.

pollEvictedAll

public Collection<E> pollEvictedAll()
                             throws GridException

If window supports eviction, this method will return all available evicted elements.

Specified by:

pollEvictedAll in interface GridStreamerWindow<E>

Returns:

Collection of evicted elements.

Throws:

GridException - If index update failed.

pollEvicted

public Collection<E> pollEvicted(int cnt)
                          throws GridException

If window supports eviction, this method will return up to cnt evicted elements.

Specified by:

pollEvicted in interface GridStreamerWindow<E>

Parameters:

cnt - Number of elements to evict.

Returns:

Collection of evicted elements.

Throws:

GridException - If index update failed.

pollEvicted0

protected abstract Collection<E> pollEvicted0(int cnt)

If window supports eviction, this method will return up to cnt evicted elements.

Parameters:

cnt - Count.

Returns:

Evicted elements.

pollEvictedBatch

public Collection<E> pollEvictedBatch()
                               throws GridException

If window supports batch eviction, this method will poll next evicted batch from window. If windows does not support batch eviction but supports eviction, will return collection of single last evicted element. If window does not support eviction, will return empty collection.

Specified by:

pollEvictedBatch in interface GridStreamerWindow<E>

Returns:

Next evicted batch.

Throws:

GridException - If index update failed.

pollEvictedBatch0

protected abstract Collection<E> pollEvictedBatch0()

If window supports batch eviction, this method will poll next evicted batch from window. If windows does not support batch eviction but supports eviction, will return collection of single last evicted element. If window does not support eviction, will return empty collection.

Returns:

Elements from evicted batch.

start

public final void start()
                 throws GridException

Starts grid component, called on grid start.

Specified by:

start in interface GridLifecycleAware

Throws:

GridException - If failed.

reset

public final void reset()

Resets window. Usually will clear all events from window.

Specified by:

reset in interface GridStreamerWindow<E>

checkConfiguration

protected abstract void checkConfiguration()
                                    throws GridException

Check window configuration.

Throws:

GridException - If failed.

reset0

protected abstract void reset0()

Reset routine.

stop

public void stop()

Stops grid component, called on grid shutdown.

Specified by:

stop in interface GridLifecycleAware

stop0

protected abstract void stop0()

Dispose window.

snapshot

public Collection<E> snapshot(boolean includeEvicted)

Create window snapshot. Evicted entries are not included.

Specified by:

snapshot in interface GridStreamerWindow<E>

Parameters:

includeEvicted - Whether to include evicted entries or not.

Returns:

Window snapshot.

setName

public void setName(String name)

Sets window name.

Parameters:

name - Window name.

getFilter

@Nullable
public GridPredicate<Object> getFilter()

Gets optional event filter.

Returns:

Optional event filter.

setFilter

public void setFilter(@Nullable
             GridPredicate<Object> filter)

Sets event filter.

Parameters:

filter - Event filter.

index

public <K,V> GridStreamerIndex<E,K,V> index()

Gets default index, if default index is not configured then IllegalArgumentException will be thrown.

Specified by:

index in interface GridStreamerWindow<E>

Type Parameters:

K - Type of the index key.

V - Type of the index value.

Returns:

Index with default name.

index

public <K,V> GridStreamerIndex<E,K,V> index(@Nullable
                                   String name)

Gets index by name, if not index with such name was configured then IllegalArgumentException will be thrown.

Specified by:

index in interface GridStreamerWindow<E>

Type Parameters:

K - Type of the index key.

V - Type of the index value.

Parameters:

name - Name of the index, if null then analogous to GridStreamerWindow.index().

Returns:

Index with a given name.

indexes

public Collection<GridStreamerIndex<E,?,?>> indexes()

Gets all indexes configured for this window.

Specified by:

indexes in interface GridStreamerWindow<E>

Returns:

All indexes configured for this window or empty collection, if no indexes were configured.

indexProviders

public GridStreamerIndexProvider<E,?,?>[] indexProviders()

Get array of index providers.

Returns:

Index providers.

setIndexes

public void setIndexes(GridStreamerIndexProvider<E,?,?>... idxs)
                throws IllegalArgumentException

Set indexes.

Parameters:

idxs - Indexes.

Throws:

IllegalArgumentException - If some index names are not unique.

clearEvicted

public void clearEvicted()
                  throws GridException

Clears all evicted entries.

Specified by:

clearEvicted in interface GridStreamerWindow<E>

Throws:

GridException - If index update failed.

updateIndexes

protected void updateIndexes(E evt,
                 boolean rmv)
                      throws GridException

Update indexes.

Parameters:

evt - Event.

rmv - Remove flag.

Throws:

GridException - If index update failed.