Package com.illumon.iris.db.v2.locations

Interface TableKey

All Superinterfaces:

com.fishlib.base.log.LogOutputAppendable, NamedImplementation

All Known Subinterfaces:

TableLocationProvider

All Known Implementing Classes:

AbstractTableLocationProvider, ReadOnlyLocalTableLocationProvider, RemoteTableDataService.TableLocationProviderImpl, SingleTableLocationProvider, StandaloneTableKey, TableLocationProvider.NullTableLocationProvider, TableLookupKey, TableLookupKey.Immutable, TableLookupKey.Reusable, WritableLocalTableLocationProvider

public interface TableKey
extends NamedImplementation, com.fishlib.base.log.LogOutputAppendable

Interface that specifies key fields for any table-keyed object (i.e. TableLocationProvider).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TableKey.KeyedObjectKeyImpl<VALUE_TYPE>
static final class	TableKey.SelfKeyedObjectKeyImpl<VALUE_TYPE extends TableKey>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NULL_NAME	Constant used to designate namespace or table name values for fully-standalone tables/locations, e.g.

Method Summary

Modifier and Type	Method	Description
default com.fishlib.base.log.LogOutput	append(com.fishlib.base.log.LogOutput logOutput)
static boolean	areEqual(TableKey key1, TableKey key2)
default TableIdentifier	asTableIdentifier()
static <VALUE_TYPE extends TableKey> io.deephaven.hash.KeyedObjectKey<TableKey,VALUE_TYPE>	getKeyedObjectKey()	Re-usable key object for TableKeys that disregards the implementation class.
CharSequence	getNamespace()
CharSequence	getTableName()
TableType	getTableType()
static int	hash(TableKey key)
default String	toStringDetailed()	Optional toString path with more implementation detail.
default String	toStringHelper()
default String	toStringSimple()
default void	writeTo(io.deephaven.enterprise.comm.impl.nio.WObjectWriter writer)

Methods inherited from interface com.illumon.util.type.NamedImplementation

getImplementationName

Field Details

NULL_NAME

static final String NULL_NAME

Constant used to designate namespace or table name values for fully-standalone tables/locations, e.g. for tables persisted or loaded outside of a Database/TableDataService framework.

See Also:

• Constant Field Values

Method Details

getNamespace

@NotNull
CharSequence getNamespace()

Returns:

The namespace enclosing this table

getTableName

@NotNull
CharSequence getTableName()

Returns:

The name of this table

getTableType

@NotNull
TableType getTableType()

Returns:

The type of this table (which generally dictates storage, metadata-availability, etc)

append

@FinalDefault
default com.fishlib.base.log.LogOutput append(@NotNull
 com.fishlib.base.log.LogOutput logOutput)

Specified by:

append in interface com.fishlib.base.log.LogOutputAppendable

toStringHelper

@FinalDefault
default String toStringHelper()

toStringDetailed

default String toStringDetailed()

Optional toString path with more implementation detail.

Returns:

detailed conversion to string

toStringSimple

default String toStringSimple()

hash

static int hash(@NotNull
 TableKey key)

areEqual

static boolean areEqual(@NotNull
 TableKey key1,
 @NotNull
 TableKey key2)

getKeyedObjectKey

static <VALUE_TYPE extends TableKey>
io.deephaven.hash.KeyedObjectKey<TableKey,VALUE_TYPE> getKeyedObjectKey()

Re-usable key object for TableKeys that disregards the implementation class.

writeTo

@FinalDefault
default void writeTo(@NotNull
 io.deephaven.enterprise.comm.impl.nio.WObjectWriter writer)
              throws IOException

Throws:

IOException

asTableIdentifier

@FinalDefault
default TableIdentifier asTableIdentifier()