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

Interface DeephavenFormatColumnLocation

All Superinterfaces:

ColumnLocation, com.fishlib.base.log.LogOutputAppendable, NamedImplementation, StringUtils.StringKeyedObject

All Known Implementing Classes:

LocalColumnLocation

public interface DeephavenFormatColumnLocation
extends ColumnLocation

ColumnLocation sub-interface for column locations stored in Deephaven's proprietary binary file format.

Method Summary

Modifier and Type	Method	Description
ByteOrder	getByteOrder()	Get the ByteOrder used by all FileDataBufferStores associated with this column location.
FileDataBufferStore	getColumnFileBufferStore(ColumnFileType columnFileType)	Get the FileDataBufferStore for buffers from this column location for the specified ColumnFileType.
default ColumnRegionByte<Attributes.Values>	makeColumnRegionByte(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionByte for the specified column definition.
default ColumnRegionChar<Attributes.Values>	makeColumnRegionChar(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionChar for the specified column definition.
default ColumnRegionDouble<Attributes.Values>	makeColumnRegionDouble(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionDouble for the specified column definition.
default ColumnRegionFloat<Attributes.Values>	makeColumnRegionFloat(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionFloat for the specified column definition.
default ColumnRegionInt<Attributes.Values>	makeColumnRegionInt(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionInt for the specified column definition.
default ColumnRegionLong<Attributes.Values>	makeColumnRegionLong(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionLong for the specified column definition.
default <TYPE> ColumnRegionObject<TYPE,Attributes.Values>	makeColumnRegionObject(com.illumon.dataobjects.ColumnDefinition<TYPE> columnDefinition, io.deephaven.util.codec.ObjectDecoder<?> decoder, SourceTableColumnInstructions instructions)	Create a ColumnRegionObject for the specified column definition.
default ColumnRegionShort<Attributes.Values>	makeColumnRegionShort(com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)	Create a ColumnRegionShort for the specified column definition.
boolean	symbolFileExists()	Check if the symbol table file exists.

Methods inherited from interface com.illumon.iris.db.v2.locations.ColumnLocation

append, cast, exists, getFormat, getName, getStringRepresentation, getTableLocation, toStringHelper

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

getImplementationName

Method Details

getByteOrder

ByteOrder getByteOrder()

Get the ByteOrder used by all FileDataBufferStores associated with this column location. Invoking this method is an error for any column location if ColumnLocation.exists() has not been invoked and returned true.

Returns:

The ByteOrder

getColumnFileBufferStore

@NotNull
FileDataBufferStore getColumnFileBufferStore(@NotNull
 ColumnFileType columnFileType)

Get the FileDataBufferStore for buffers from this column location for the specified ColumnFileType.

Parameters:

columnFileType - The ColumnFileType

Returns:

The buffer store for the specified column file type for this column location

symbolFileExists

boolean symbolFileExists()

Check if the symbol table file exists.

Returns:

true if the symbol data file exists.

makeColumnRegionByte

default ColumnRegionByte<Attributes.Values> makeColumnRegionByte(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionByte for the specified column definition.

Specified by:

makeColumnRegionByte in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionByte for reading data from this ColumnLocation

makeColumnRegionChar

default ColumnRegionChar<Attributes.Values> makeColumnRegionChar(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionChar for the specified column definition.

Specified by:

makeColumnRegionChar in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionChar for reading data from this ColumnLocation

makeColumnRegionShort

default ColumnRegionShort<Attributes.Values> makeColumnRegionShort(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionShort for the specified column definition.

Specified by:

makeColumnRegionShort in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionShort for reading data from this ColumnLocation

makeColumnRegionInt

default ColumnRegionInt<Attributes.Values> makeColumnRegionInt(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionInt for the specified column definition.

Specified by:

makeColumnRegionInt in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionInt for reading data from this ColumnLocation

makeColumnRegionLong

default ColumnRegionLong<Attributes.Values> makeColumnRegionLong(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionLong for the specified column definition.

Specified by:

makeColumnRegionLong in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionLong for reading data from this ColumnLocation

makeColumnRegionFloat

default ColumnRegionFloat<Attributes.Values> makeColumnRegionFloat(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionFloat for the specified column definition.

Specified by:

makeColumnRegionFloat in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionFloat for reading data from this ColumnLocation

makeColumnRegionDouble

default ColumnRegionDouble<Attributes.Values> makeColumnRegionDouble(@NotNull
 com.illumon.dataobjects.ColumnDefinition<?> columnDefinition)

Description copied from interface: ColumnLocation

Create a ColumnRegionDouble for the specified column definition.

Specified by:

makeColumnRegionDouble in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

Returns:

A ColumnRegionDouble for reading data from this ColumnLocation

makeColumnRegionObject

default <TYPE>
ColumnRegionObject<TYPE,Attributes.Values> makeColumnRegionObject(@NotNull
 com.illumon.dataobjects.ColumnDefinition<TYPE> columnDefinition,
 @NotNull
 io.deephaven.util.codec.ObjectDecoder<?> decoder,
 @NotNull
 SourceTableColumnInstructions instructions)

Description copied from interface: ColumnLocation

Create a ColumnRegionObject for the specified column definition.

Specified by:

makeColumnRegionObject in interface ColumnLocation

Parameters:

columnDefinition - The ColumnDefinition used to lookup type information

decoder - an ObjectDecoder for producing values from the stored bytes at this location.

Returns:

A ColumnRegionObject for reading data from this ColumnLocation