Package io.deephaven.enterprise.inputtables

Interface ColumnSpec

@Immutable public interface ColumnSpec
Representation of input table column specification.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ColumnSpec.Builder
    Builder to help create a ColumnSpec.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Set<Class<?>>
    ALLOWED_DATA_TYPES
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ColumnSpec.Builder
    builder()
    Creates and returns a builder for a ColumnSpec.
    default void
    check()
    Upon building, checks validity of the column spec.
    Class<?>
    dataType()
    Gets the data type of the column.
    Set<Object>
    enumValues()
    Gets the enum values for the column.
    boolean
    isKey()
    Gets whether the column is a keyed column.
    String
    name()
    Gets the name of the column.

  • Field Details

    • ALLOWED_DATA_TYPES

      static final Set<Class<?>> ALLOWED_DATA_TYPES

  • Method Details

    • name

      @NotNull String name()
      Gets the name of the column.
      Returns:
      the name of the column

    • dataType

      @NotNull Class<?> dataType()
      Gets the data type of the column.
      Returns:
      the data type of the column

    • isKey

      boolean isKey()
      Gets whether the column is a keyed column.
      Returns:
      whether the column is a keyed column

    • enumValues

      @NaturalOrder @NotNull Set<Object> enumValues()
      Gets the enum values for the column.
      Returns:
      the enum values for the column

    • check

      @Check default void check()
      Upon building, checks validity of the column spec.

    • builder

      @NotNull static ColumnSpec.Builder builder()
      Creates and returns a builder for a ColumnSpec.
      Returns:
      a builder for a ColumnSpec