com.illumon.iris.db.v2

Interface TableMap

All Superinterfaces:

Deflatable<TableMap>, LivenessManager, LivenessNode, LivenessReferent, TransformableTableMap

public interface TableMap
extends Deflatable<TableMap>, TransformableTableMap, LivenessNode

A map of tables.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TableMap.KeyListener Table map key change listener.
static interface	TableMap.Listener Table map change listener.

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

TransformableTableMap.AsTableBuilder

Method Summary

Modifier and Type	Method and Description
void	addKeyListener(TableMap.KeyListener listener) Listen to changes in the map's keys.
void	addListener(TableMap.Listener listener) Add a new listener for changes to the map.
<R> R	apply(com.fishlib.base.Function.Unary<R,TableMap> function) Applies a function to this tableMap.
default TableMap	asTableMap() If you're a TableMap return this, otherwise if you're a Proxy return the underlying TableMap.
default Inflatable<TableMap>	deflate(ExportedObjectClient client)
static TableMap	emptyMap()
TableMap	flatten() Flattens all of the result tables within the tablemap.
Table	get(Object key) Gets a table with a given key.
Object[]	getKeySet() Gets the keys.
Table	getWithTransform(Object key, Function<Table,Table> transform) Gets a table with a given key, applying the specified transform before returning.
TableMap	populateKeys(Object... keys) When creating the table map, some of the keys that we would like to be there eventually may not exist.
TableMap	preemptiveUpdatesTable(int intervalMillis) Creates preemptive tables out of all of the result tables within the tablemap.
void	removeKeyListener(TableMap.KeyListener listener)
void	removeListener(TableMap.Listener listener) Removes a map change listener.
int	size() Number of tables in the map.
TableMap	transformTables(Function<Table,Table> function) Applies a transformation function on all tables in the TableMap, producing a new TableMap which will update as new keys are added.
TableMap	transformTablesWithMap(TableMap otherMap, BiFunction<Table,Table,Table> function) Applies a BiFunction function on all tables in this TableMap and otherMap that have matching keys, producing a new TableMap which will update as new keys are added.
Collection<Table>	values() Gets the values.

Methods inherited from interface com.illumon.iris.db.tables.remote.Deflatable

maybeDeflate

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

asTable, asTable, asTableBuilder, merge

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

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

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

manage, tryManage

Method Detail

emptyMap

static TableMap emptyMap()

get

Table get(Object key)

Gets a table with a given key. Note that this causes the current LivenessManager (see LivenessScopeStack) to manage the result if non-null.

Parameters:

key - key

Returns:

table associated with the key, or null if the key is not present.

getWithTransform

Table getWithTransform(Object key,
                       Function<Table,Table> transform)

Gets a table with a given key, applying the specified transform before returning.

Parameters:

key - key

Returns:

table associated with the key, or null if the key is not present.

getKeySet

Object[] getKeySet()

Gets the keys.

Returns:

keys

values

Collection<Table> values()

Gets the values.

Returns:

values

size

int size()

Number of tables in the map.

Returns:

number of tables in the map.

populateKeys

TableMap populateKeys(Object... keys)

When creating the table map, some of the keys that we would like to be there eventually may not exist. This call lets you pre-populate keys, so that at initialization time you can perform the appropriate joins, etc., on empty tables that you expect to be populated in the future.

Parameters:

keys - the keys to add to the map

Returns:

this TableMap

addListener

void addListener(TableMap.Listener listener)

Add a new listener for changes to the map.

Parameters:

listener - map change listener

removeListener

void removeListener(TableMap.Listener listener)

Removes a map change listener.

Parameters:

listener - map change listener.

addKeyListener

void addKeyListener(TableMap.KeyListener listener)

Listen to changes in the map's keys.

Parameters:

listener - key change listener

removeKeyListener

void removeKeyListener(TableMap.KeyListener listener)

flatten

TableMap flatten()

Flattens all of the result tables within the tablemap.

preemptiveUpdatesTable

TableMap preemptiveUpdatesTable(int intervalMillis)

Creates preemptive tables out of all of the result tables within the tablemap.

Parameters:

intervalMillis - update interval for the preemptive tables

apply

<R> R apply(com.fishlib.base.Function.Unary<R,TableMap> function)

Applies a function to this tableMap. This is useful if you have a reference to a tableMap; but not the database and want to run a series of operations against the table map without each individual operation resulting in a remote method invocation.

Type Parameters:

R - the return type of function

Parameters:

function - the function to run, its single argument will be this table map.

Returns:

the return value of function

transformTables

TableMap transformTables(Function<Table,Table> function)

Applies a transformation function on all tables in the TableMap, producing a new TableMap which will update as new keys are added.

Parameters:

function - the function to apply to each table in this TableMap

Returns:

a new TableMap where each table has had function applied

transformTablesWithMap

TableMap transformTablesWithMap(TableMap otherMap,
                                BiFunction<Table,Table,Table> function)

Applies a BiFunction function on all tables in this TableMap and otherMap that have matching keys, producing a new TableMap which will update as new keys are added. Only applies the function to tables which exist in both maps.

Parameters:

otherMap - the other TableMap

function - the function to apply to each table in this TableMap, the tables in this map are the first argument the tables in the other map are the second argument.

Returns:

a new TableMap where each table has had function applied

asTableMap

default TableMap asTableMap()

Description copied from interface: TransformableTableMap

If you're a TableMap return this, otherwise if you're a Proxy return the underlying TableMap.

Specified by:

asTableMap in interface TransformableTableMap

deflate

default Inflatable<TableMap> deflate(@NotNull
                                     ExportedObjectClient client)

Specified by:

deflate in interface Deflatable<TableMap>