Package io.deephaven.enterprise.inputtables

Class ColumnSpec

java.lang.Object

io.deephaven.enterprise.inputtables.ColumnSpec

@Immutable
public abstract class ColumnSpec
extends Object

Representation of input table column specification.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ColumnSpec.Builder	Builder to help create a ColumnSpec.

Constructor Summary

Constructors

Constructor	Description
ColumnSpec()

Method Summary

Modifier and Type	Method	Description
static ColumnSpec.Builder	builder()	Creates and returns a builder for a ColumnSpec.
abstract Class<?>	dataType()	Gets the data type of the column.
abstract Set<Object>	enumValues()	Gets the enum values for the column.
abstract boolean	isKey()	Gets whether the column is a keyed column.
abstract String	name()	Gets the name of the column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ColumnSpec

public ColumnSpec()

Method Details

name

public abstract String name()

Gets the name of the column.

Returns:

the name of the column

dataType

public abstract Class<?> dataType()

Gets the data type of the column. Supported types are Boolean, String, Instant, and all primitive types except boolean.

Returns:

the data type of the column

isKey

public abstract boolean isKey()

Gets whether the column is a keyed column.

Returns:

whether the column is a keyed column

enumValues

@NaturalOrder
public abstract Set<Object> enumValues()

Gets the enum values for the column. For primitive types, the values must be the non-null, boxed equivalents (for example, an int dataType() must have non-null Integer); for object types, the values must satisfy dataType.isInstance(object).

Returns:

the enum values for the column

builder

@NotNull
public static ColumnSpec.Builder builder()

Creates and returns a builder for a ColumnSpec.

Returns:

a builder for a ColumnSpec