Package io.deephaven.engine.table.impl.locations

Interface TableDataService

All Known Implementing Classes:

AbstractTableDataService, CompositeTableDataService, FilteredTableDataService, PythonTableDataService

public interface TableDataService

Service responsible for TableLocation discovery.

Method Summary

Modifier and Type	Method	Description
default String	describe()	Get a detailed description string.
default @Nullable String	getName()	Get an optional name for this service, or null if no name is defined.
@Nullable TableLocationProvider	getRawTableLocationProvider(@NotNull TableKey tableKey, @NotNull TableLocationKey tableLocationKey)	Request the single raw TableLocationProvider from this service that has the TableLocation for tableKey and tableLocationKey.
@NotNull TableLocationProvider	getTableLocationProvider(@NotNull TableKey tableKey)	Request a TableLocationProvider from this service.
void	reset()	Forget all state for subsequent requests for all tables.
void	reset(@NotNull TableKey tableKey)	Forget all state for subsequent requests for a single table.

Method Details

getTableLocationProvider

@NotNull
@NotNull TableLocationProvider getTableLocationProvider(@NotNull
 @NotNull TableKey tableKey)

Request a TableLocationProvider from this service.

Parameters:

tableKey - The TableKey to lookup

Returns:

A TableLocationProvider for the specified TableKey

getRawTableLocationProvider

@Nullable
@Nullable TableLocationProvider getRawTableLocationProvider(@NotNull
 @NotNull TableKey tableKey,
 @NotNull
 @NotNull TableLocationKey tableLocationKey)

Request the single raw TableLocationProvider from this service that has the TableLocation for tableKey and tableLocationKey. A raw TableLocationProvider does not compose multiple TableLocationProviders or delegate to other implementations.

Parameters:

tableKey - The TableKey to lookup

tableLocationKey - The TableLocationKey to lookup

Returns:

The raw TableLocationProvider that has the TableLocation for tableKey and tableLocationKey, or null if there is none

Throws:

TableDataException - If more than one TableLocationProvider has the TableLocation

reset

void reset()

Forget all state for subsequent requests for all tables.

reset

void reset(@NotNull
 @NotNull TableKey tableKey)

Forget all state for subsequent requests for a single table.

Parameters:

tableKey - TableKey to forget state for

getName

@Nullable
default @Nullable String getName()

Get an optional name for this service, or null if no name is defined.

Returns:

The service name, or null

describe

default String describe()

Get a detailed description string.

Returns:

A description string

ImplNote:

Defaults to Object.toString()