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

Interface ColumnLocation

All Superinterfaces:

LogOutputAppendable, NamedImplementation, StringUtils.StringKeyedObject

All Known Implementing Classes:

AbstractColumnLocation

public interface ColumnLocation
extends StringUtils.StringKeyedObject, NamedImplementation, LogOutputAppendable

Per-TableLocation, per-column key, state, and factory object.

Method Summary

Modifier and Type	Method	Description
default LogOutput	append(@NotNull LogOutput logOutput)
boolean	exists()	Check for existence of this ColumnLocation.
<METADATA_TYPE> METADATA_TYPE	getMetadata(@NotNull ColumnDefinition<?> columnDefinition)	Get the metadata object stored with this column, or null if no such data exists.
@NotNull String	getName()	Get the column name for this ColumnLocation.
default String	getStringRepresentation()
@NotNull TableLocation	getTableLocation()	Get the TableLocation enclosing this ColumnLocation.
ColumnRegionByte<Values>	makeColumnRegionByte(@NotNull ColumnDefinition<?> columnDefinition)
ColumnRegionChar<Values>	makeColumnRegionChar(@NotNull ColumnDefinition<?> columnDefinition)
ColumnRegionDouble<Values>	makeColumnRegionDouble(@NotNull ColumnDefinition<?> columnDefinition)
ColumnRegionFloat<Values>	makeColumnRegionFloat(@NotNull ColumnDefinition<?> columnDefinition)
ColumnRegionInt<Values>	makeColumnRegionInt(@NotNull ColumnDefinition<?> columnDefinition)
ColumnRegionLong<Values>	makeColumnRegionLong(@NotNull ColumnDefinition<?> columnDefinition)
<TYPE> ColumnRegionObject<TYPE,Values>	makeColumnRegionObject(@NotNull ColumnDefinition<TYPE> columnDefinition)
ColumnRegionShort<Values>	makeColumnRegionShort(@NotNull ColumnDefinition<?> columnDefinition)
default String	toStringHelper()

Methods inherited from interface io.deephaven.util.type.NamedImplementation

getImplementationName

Method Details

getTableLocation

@NotNull
@NotNull TableLocation getTableLocation()

Get the TableLocation enclosing this ColumnLocation.

Returns:

the TableLocation enclosing this ColumnLocation

getName

@NotNull
@NotNull String getName()

Get the column name for this ColumnLocation.

Returns:

the column name for this ColumnLocation

exists

boolean exists()

Check for existence of this ColumnLocation.

Returns:

True iff the ColumnLocation actually exists

getMetadata

@Nullable
<METADATA_TYPE> METADATA_TYPE getMetadata(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Get the metadata object stored with this column, or null if no such data exists.

This is typically a value to range map (grouping metadata). The value to range map, if non-null, is a map from unique (boxed) column values for this location to the associated ranges in which they occur. Ranges are either 2-element int[]s, or 2-element long[]s.

Returns:

The metadata stored with this column, or null if no such data exists

makeColumnRegionChar

ColumnRegionChar<Values> makeColumnRegionChar(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionChar for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain char data

makeColumnRegionByte

ColumnRegionByte<Values> makeColumnRegionByte(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionByte for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain byte data

makeColumnRegionShort

ColumnRegionShort<Values> makeColumnRegionShort(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionShort for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain short data

makeColumnRegionInt

ColumnRegionInt<Values> makeColumnRegionInt(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionInt for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain int data

makeColumnRegionLong

ColumnRegionLong<Values> makeColumnRegionLong(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionLong for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain long data

makeColumnRegionFloat

ColumnRegionFloat<Values> makeColumnRegionFloat(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionFloat for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain float data

makeColumnRegionDouble

ColumnRegionDouble<Values> makeColumnRegionDouble(@NotNull
 @NotNull ColumnDefinition<?> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionDouble for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain double data

makeColumnRegionObject

<TYPE> ColumnRegionObject<TYPE,Values> makeColumnRegionObject(@NotNull
 @NotNull ColumnDefinition<TYPE> columnDefinition)

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionObject for reading data from this ColumnLocation

Throws:

UnsupportedOperationException - If this ColumnLocation does not contain object data

getStringRepresentation

default String getStringRepresentation()

Specified by:

getStringRepresentation in interface StringUtils.StringKeyedObject

append

default LogOutput append(@NotNull
 @NotNull LogOutput logOutput)

Specified by:

append in interface LogOutputAppendable

toStringHelper

default String toStringHelper()