com.illumon.iris.db.v2

Class ReverseLookupListener

java.lang.Object

com.illumon.iris.db.v2.InstrumentedListener

com.illumon.iris.db.v2.InstrumentedListenerAdapter

com.illumon.iris.db.v2.ReverseLookupListener

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, NotificationQueue.Dependency, Listener, NotificationStepReceiver, ReverseLookup

public class ReverseLookupListener
extends InstrumentedListenerAdapter
implements NotificationStepReceiver, ReverseLookup

Maintains a map from key column values to their index. This allows you to quickly find a row based on a unique key on a ticking table, without the need for searching the entire table. Note: The key column values must be unique.

Nested Class Summary

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.InstrumentedListener

InstrumentedListener.ErrorNotification, InstrumentedListener.Notification

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.ReverseLookup

ReverseLookup.Null

Field Summary

Fields inherited from class com.illumon.iris.db.v2.InstrumentedListenerAdapter

source

Method Summary

Modifier and Type	Method and Description
void	dumpReverseTable(com.fishlib.io.logger.Logger log)
long	get(Object key) Gets the index value where key exists in the table, or the no-entry-value if it is not found in the table.
protected Object	getKey(long row) Gets the key for a given row.
String[]	getKeyColumns()
long	getLastNotificationStep()
long	getNoEntryValue() Returns the value that will be returned from ReverseLookup.get(java.lang.Object) or if no entry exists for a given key.
long	getPrev(Object key) Gets the index value where key previously in the table, or the no-entry-value if it is was not found in the table.
protected Object	getPrevKey(long row) Gets the previous key for a given row.
static ReverseLookupListener	makeReverseLookupListenerWithLock(DynamicTable source, String... columns)
static ReverseLookupListener	makeReverseLookupListenerWithSnapshot(BaseTable source, String... columns)
void	onUpdate(Index added, Index removed, Index modified) Process notification of table changes.
static void	prepareForTree(BaseTable preTree, String idColumn) Prepare the parameter table for use with tree table
void	setLastNotificationStep(long lastNotificationStep)
String	toString()

Methods inherited from class com.illumon.iris.db.v2.InstrumentedListenerAdapter

onFailureInternal

Methods inherited from class com.illumon.iris.db.v2.InstrumentedListener

append, getEntry, getErrorNotification, getNotification, onFailure, satisfied, setInitialImage, setVerboseLogging

Methods inherited from class java.lang.Object

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

Method Detail

makeReverseLookupListenerWithSnapshot

public static ReverseLookupListener makeReverseLookupListenerWithSnapshot(BaseTable source,
                                                                          String... columns)

makeReverseLookupListenerWithLock

public static ReverseLookupListener makeReverseLookupListenerWithLock(DynamicTable source,
                                                                      String... columns)

prepareForTree

@ScriptApi
public static void prepareForTree(BaseTable preTree,
                                             String idColumn)

Prepare the parameter table for use with tree table

Parameters:

preTree - The tree to prepare

idColumn - The column that will be used as the id for Table.treeTable(String, String)

get

public long get(Object key)

Description copied from interface: ReverseLookup

Gets the index value where key exists in the table, or the no-entry-value if it is not found in the table.

Specified by:

get in interface ReverseLookup

Parameters:

key - a single object for a single column, or a SmartKey for multiple columns

Returns:

the row index where key exists in the table

getPrev

public long getPrev(Object key)

Description copied from interface: ReverseLookup

Gets the index value where key previously in the table, or the no-entry-value if it is was not found in the table.

Specified by:

getPrev in interface ReverseLookup

Parameters:

key - a single object for a single column, or a SmartKey for multiple columns

Returns:

the row index where key previously existed in the table

getNoEntryValue

public long getNoEntryValue()

Description copied from interface: ReverseLookup

Returns the value that will be returned from ReverseLookup.get(java.lang.Object) or if no entry exists for a given key.

Specified by:

getNoEntryValue in interface ReverseLookup

getKey

protected Object getKey(long row)

Gets the key for a given row.

Parameters:

row - the index value to retrieve the key for

Returns:

an individual object or SmartKey for multi-column keys

getPrevKey

protected Object getPrevKey(long row)

Gets the previous key for a given row.

Parameters:

row - the index value to retrieve the previous key for

Returns:

an individual object or SmartKey for multi-column keys

onUpdate

public void onUpdate(Index added,
                     Index removed,
                     Index modified)

Description copied from interface: Listener

Process notification of table changes.

Specified by:

onUpdate in interface Listener

Specified by:

onUpdate in class InstrumentedListenerAdapter

Parameters:

added - rows added

removed - rows removed

modified - rows modified

toString

public String toString()

Overrides:

toString in class Object

dumpReverseTable

public void dumpReverseTable(com.fishlib.io.logger.Logger log)

Specified by:

dumpReverseTable in interface ReverseLookup

getLastNotificationStep

public long getLastNotificationStep()

Specified by:

getLastNotificationStep in interface NotificationStepReceiver

setLastNotificationStep

public void setLastNotificationStep(long lastNotificationStep)

Specified by:

setLastNotificationStep in interface NotificationStepReceiver

getKeyColumns

public String[] getKeyColumns()

Specified by:

getKeyColumns in interface ReverseLookup

Returns:

the key columns this reverse lookup is indexed on