com.illumon.iris.db.v2

Class ReverseLookupListener

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

com.illumon.iris.db.util.liveness.LivenessArtifact

com.illumon.iris.db.v2.ReverseLookupListener

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, DynamicNode, ReverseLookup, Serializable

public class ReverseLookupListener
extends LivenessArtifact
implements ReverseLookup, DynamicNode

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.

See Also:

Serialized Form

Nested Class Summary

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

ReverseLookup.Null

Method Summary

Modifier and Type	Method and Description
void	addParentReference(Object parent) Called on a dependent node to ensure that a strong reference is maintained to any parent object that is required for the proper maintenance and functioning of the dependent.
protected void	destroy() Attempt to release (destructively when necessary) resources held by this object.
void	dropReference() Drop a previously-retained reference to this referent.
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	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.
WeakReference<? extends LivenessReferent>	getWeakReference() Get a WeakReference to this referent.
void	initializeTransientFieldsForLiveness() Package-private for Serializable sub-classes to use in readObject only.
boolean	isRefreshing() Is the node updating?
static ReverseLookupListener	makeReverseLookupListenerWithLock(DynamicTable source, String... columns)
static ReverseLookupListener	makeReverseLookupListenerWithSnapshot(BaseTable source, String... columns)
protected void	onReferenceCountAtZero() Callback method that will be invoked when the reference count returns to zero.
static void	prepareForTree(BaseTable preTree, String idColumn) Prepare the parameter table for use with tree table
boolean	setRefreshing(boolean refreshing) Change the node's refresh mode.
String	toString()
boolean	tryManage(LivenessReferent referent) Attempt to add the specified referent to this manager.
boolean	tryRetainReference() If this referent is "live", behave as LivenessReferent.retainReference() and return true.

Methods inherited from class com.illumon.iris.db.util.liveness.LivenessArtifact

manageWithCurrentScope, unmanage, unmanage

Methods inherited from class com.illumon.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, incrementReferenceCount, resetReferenceCount, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.v2.DynamicNode

isDynamicAndIsRefreshing, isDynamicAndNotRefreshing, notDynamicOrIsRefreshing, notDynamicOrNotRefreshing

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessReferent

getReferentDescription, retainReference

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessManager

manage

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

toString

public String toString()

Overrides:

toString in class ReferenceCounted

dumpReverseTable

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

Specified by:

dumpReverseTable in interface ReverseLookup

getKeyColumns

public String[] getKeyColumns()

Specified by:

getKeyColumns in interface ReverseLookup

Returns:

the key columns this reverse lookup is indexed on

isRefreshing

public boolean isRefreshing()

Description copied from interface: DynamicNode

Is the node updating?

Specified by:

isRefreshing in interface DynamicNode

Returns:

true if the node is updating; false otherwise.

setRefreshing

public boolean setRefreshing(boolean refreshing)

Description copied from interface: DynamicNode

Change the node's refresh mode.

Specified by:

setRefreshing in interface DynamicNode

Parameters:

refreshing - true to cause the node to update; false otherwise.

Returns:

new refreshing state

addParentReference

public void addParentReference(Object parent)

Description copied from interface: DynamicNode

Called on a dependent node to ensure that a strong reference is maintained to any parent object that is required for the proper maintenance and functioning of the dependent. In the most common case, the parent object is a child listener to a parent node. The parent node only keeps a weak reference to its child listener, but the listener maintains a strong reference to the parent node. In this scenario, the only strong reference to the listener (and thus indirectly to the parent node itself) is the reference kept by the dependent node.

Specified by:

addParentReference in interface DynamicNode

Parameters:

parent - A parent of this node

initializeTransientFieldsForLiveness

@VisibleForTesting
public final void initializeTransientFieldsForLiveness()

Package-private for Serializable sub-classes to use in readObject only. Public to allow unit tests in another package to work around mock issues where the constructor is never invoked.

tryRetainReference

public final boolean tryRetainReference()

Description copied from interface: LivenessReferent

If this referent is "live", behave as LivenessReferent.retainReference() and return true. Otherwise, returns false rather than throwing an exception.

Specified by:

tryRetainReference in interface LivenessReferent

Returns:

True if this referent was retained, false otherwise

dropReference

public final void dropReference()

Description copied from interface: LivenessReferent

Drop a previously-retained reference to this referent.

Specified by:

dropReference in interface LivenessReferent

getWeakReference

public WeakReference<? extends LivenessReferent> getWeakReference()

Description copied from interface: LivenessReferent

Get a WeakReference to this referent. This may be cached, or newly created.

Specified by:

getWeakReference in interface LivenessReferent

Returns:

A new or cached reference to this referent

tryManage

public final boolean tryManage(@NotNull
                               LivenessReferent referent)

Description copied from interface: LivenessManager

Attempt to add the specified referent to this manager.

Specified by:

tryManage in interface LivenessManager

Parameters:

referent - The referent to add

Returns:

Whether the referent was in fact added

destroy

protected void destroy()

Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().

This is intended to only ever be used as a side effect of decreasing the reference count to 0.

onReferenceCountAtZero

protected final void onReferenceCountAtZero()

Description copied from class: ReferenceCounted

Callback method that will be invoked when the reference count returns to zero.

Specified by:

onReferenceCountAtZero in class ReferenceCounted