deephaven.InputTableTools.TableInputHandler

TableInputHandler methods for assisting in LiveInputTable construction.

Note that methods c and cKey take one or more optional attributes arguments. Each attribute is constructed to limit allowable values for the column. Providing more than one attribute limits the allowable values for the column to the union of the attributes.

An attribute is constructed by:
>>> attribute = TableInputHandler.ColumnConfigAttribute(value1, value2, value3)
or
>>> attribute = TableInputHandler.ColumnConfigAttribute(values)

where values is a list, tuple, numpy.ndarray, or boxed java array of allowable values.

Note that in calling
>>> TableInputHandler.c(name, type, *attributes)

The type of the entries in attributes MUST be compatible with type and the boxed version. To ensure this compatibility for primitive values, provide the values for the attribute by converting a numpy array of appropriate type in the following way:

  • `type`=’double’, values = deephaven.convertToJavaArray(<numpy array of dtype=float64>, boxed=True)

  • `type`=’float’, values = deephaven.convertToJavaArray(<numpy array of dtype=float32>, boxed=True)

  • `type`=’long’, values = deephaven.convertToJavaArray(<numpy array of dtype=int64>, boxed=True)

  • `type`=’int’, values = deephaven.convertToJavaArray(<numpy array of dtype=int32>, boxed=True)

  • `type`=’short’, values = deephaven.convertToJavaArray(<numpy array of dtype=int16>, boxed=True)

  • `type`=’byte’, values = deephaven.convertToJavaArray(<numpy array of dtype=int8>, boxed=True)

ColumnConfigAttribute(*args)

Create an allowable set of items to select from for the particular column.

c(name, type, *attributes)

Creates a column configuration for a “normal” input table column.

Parameters

  • name – (java.lang.String) - column name

  • type – (java.lang.Class) - column type

  • attributes – (com.illumon.iris.db.util.config.TableInputHandler.ColumnConfigAttribute…) - column attributes

Returns

(com.illumon.iris.db.util.config.TableInputHandler.ColumnConfig) column configuration

cKey(name, type, *attributes)

Creates a column configuration for a “key” input table column.

Parameters

  • name – (java.lang.String) - column name

  • type – (java.lang.Class) - column type

  • attributes – (com.illumon.iris.db.util.config.TableInputHandler.ColumnConfigAttribute…) - column attributes

Returns

(com.illumon.iris.db.util.config.TableInputHandler.ColumnConfig) column configuration

getRestrictedColumnNames()

Gets the set of special column names that may not be used with input tables.

Returns

(java.util.Set<java.lang.String>) the set of special column names that may not be used with input tables.