TableTools

java.lang.Object
- com.illumon.iris.db.tables.utils.TableTools

```
public class TableTools
extends Object
```
Tools for users to manipulate tables.

Field Summary

Fields
Modifier and Type Field and Description

static String NULL_STRING

Fields
Modifier and Type	Field and Description
`static String`	`NULL_STRING`

Constructor Summary

Constructors
Constructor and Description

TableTools()

Constructors
Constructor and Description
`TableTools()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ColumnHolder`	`byteCol(String name, byte... data)` Returns a ColumnHolder of type byte that can be used when creating in-memory tables.
`static ColumnHolder`	`charCol(String name, char... data)` Returns a ColumnHolder of type char that can be used when creating in-memory tables.
`static <T> ColumnHolder`	`col(String name, T... data)` Returns a ColumnHolder that can be used when creating in-memory tables.
`static ColumnSource<Byte>`	`colSource(byte... values)` Creates an in-memory column of type byte for a collection of values.
`static ColumnSource<Character>`	`colSource(char... values)` Creates an in-memory column of type char for a collection of values.
`static <T> ColumnSource<T>`	`colSource(Class<T> clazz, Collection<T> values)` Creates an in-memory column of the specified type for a collection of values.
`static ColumnSource<Double>`	`colSource(double... values)` Creates an in-memory column of type double for a collection of values.
`static ColumnSource<Float>`	`colSource(float... values)` Creates an in-memory column of type float for a collection of values.
`static ColumnSource<Integer>`	`colSource(int... values)` Creates an in-memory column of type int for a collection of values.
`static ColumnSource<Long>`	`colSource(long... values)` Creates an in-memory column of type long for a collection of values.
`static ColumnSource<Short>`	`colSource(short... values)` Creates an in-memory column of type short for a collection of values.
`static String`	`diff(Table actualResult, Table expectedResult, long maxDiffLines)` Computes the difference of two tables for use in verification.
`static String`	`diff(Table actualResult, Table expectedResult, long maxDiffLines, EnumSet<TableDiff.DiffItems> itemsToSkip)` Computes the difference of two tables for use in verification.
`static JFrame`	`display(Table source, boolean shutdownProcessOnClose, Map<String,Format> formatters, String... columns)` Deprecated.
`static JFrame`	`display(Table source, boolean shutdownProcessOnClose, String... columns)` Deprecated.
`static JFrame`	`display(Table source, Map<String,Format> formatters, String... columns)` Deprecated.
`static JFrame`	`display(Table source, String... columns)` Deprecated.
`static ColumnHolder`	`doubleCol(String name, double... data)` Returns a ColumnHolder of type double that can be used when creating in-memory tables.
`static Table`	`emptyTable(long size)` Returns a new empty Iris Table with no columns, but with defined number of rows.
`static Table`	`emptyTable(long size, TableDefinition tableDefinition)` Returns a new empty Iris Table with columns based on the specified TableDefinition.
`static ColumnHolder`	`floatCol(String name, float... data)` Returns a ColumnHolder of type float that can be used when creating in-memory tables.
`static Object`	`getKey(ColumnSource[] groupByColumnSources, long row)` Returns a SmartKey for the specified row from a set of ColumnSources.
`static Object`	`getPrevKey(ColumnSource[] groupByColumnSources, long row)` Returns a SmartKey for the row previous to the specified row from a set of ColumnSources.
`static String`	`html(Table source)` Returns a printout of a table formatted as HTML.
`static ColumnHolder`	`intCol(String name, int... data)` Returns a ColumnHolder of type int that can be used when creating in-memory tables.
`static ColumnHolder`	`longCol(String name, long... data)` Returns a ColumnHolder of type long that can be used when creating in-memory tables.
`static Table`	`merge(Collection<Table> tables)` Concatenates multiple Iris Tables into a single Table.
`static Table`	`merge(List<Table> theList)` Concatenates multiple Iris Tables into a single Table.
`static Table`	`merge(Table... tables)` Concatenates multiple Iris Tables into a single Table.
`static Table`	`mergeSorted(String keyColumn, Collection<Table> tables)` Concatenates multiple sorted Iris Tables into a single Table sorted by the specified key column.
`static Table`	`mergeSorted(String keyColumn, Table... tables)` Concatenates multiple sorted Iris Tables into a single Table sorted by the specified key column.
`static DynamicTable`	`newTable(ColumnHolder... columnHolders)` Creates a new DynamicTable from one or more ColumnHolders.
`static DynamicTable`	`newTable(long size, List<String> names, List<ColumnSource> columnSources)` Creates a new DynamicTable from one or more ColumnSources.
`static DynamicTable`	`newTable(long size, Map<String,ColumnSource> columns)` Creates a new DynamicTable from a Map of one or more ColumnSources.
`static DynamicTable`	`newTable(TableDefinition definition)` Creates a new empty DynamicTable from a TableDefinition.
`static <T> ColumnSource`	`objColSource(T... values)` Creates an in-memory column of the specified type for a collection of values
`static Table`	`readBin(String namespace, String tableName, File... sourceFiles)` Loads a binary log file as an in-memory DB table.
`static Table`	`readBin(String namespace, String tableName, File sourceDirectory, String sourceFileNameGlob)` Loads a binary log file as an in-memory DB table.
`static Table`	`readBin(String namespace, String tableName, String... sourceFiles)` Loads a binary log file as an in-memory DB table.
`static Table`	`readBin(String namespace, String tableName, TableDefinition tableDefinition, File... sourceFiles)` Loads a binary log file as an in-memory DB table.
`static Table`	`readBin(String namespace, String tableName, TableType tableType, File... sourceFiles)` Loads a binary log file as an in-memory DB table.
`static Table`	`readBin(TableKey key, File... sourceFiles)`
`static Table`	`readCsv(File file)` Returns a memory table created from importing CSV data.
`static Table`	`readCsv(File file, StatusCallback progress)` Returns a memory table created from importing CSV data.
`static Table`	`readCsv(File file, String format, StatusCallback progress)` Returns a memory table created from importing CSV data.
`static DynamicTable`	`readCsv(InputStream is)` Returns a memory table created from importing CSV data.
`static Table`	`readCsv(String filePath)` Returns a memory table created from importing CSV data.
`static Table`	`readCsv(String filePath, String format)` Returns a memory table created from importing CSV data.
`static Table`	`readCsv(String filePath, String format, StatusCallback progress)` Returns a memory table created from importing CSV data.
`static Table`	`readHeaderlessCsv(File file, String format, StatusCallback progress, Collection<String> header)` Returns a memory table created from importing CSV data.
`static Table`	`readHeaderlessCsv(String filePath)` Returns a memory table created from importing CSV data.
`static Table`	`readHeaderlessCsv(String filePath, Collection<String> header)` Returns a memory table created from importing CSV data.
`static Table`	`readHeaderlessCsv(String filePath, String... header)` Returns a memory table created from importing CSV data.
`static Table`	`readHeaderlessCsv(String filePath, String format, StatusCallback progress, Collection<String> header)` Returns a memory table created from importing CSV data.
`static Table`	`roundDecimalColumns(Table table)` Produce a new table with all the columns of this table, in the same order, but with all `double` and `float` columns rounded to `long`s.
`static Table`	`roundDecimalColumns(Table table, String... columns)` Produce a new table with all the columns of this table, in the same order, but with the specified columns rounded to `long`s.
`static Table`	`roundDecimalColumnsExcept(Table table, String... columnsNotToRound)` Produce a new table with all the columns of this table, in the same order, but with all `double` and `float` columns rounded to `long`s, except for the specified `columnsNotToRound`.
`static ColumnHolder`	`shortCol(String name, short... data)` Returns a ColumnHolder of type short that can be used when creating in-memory tables.
`static void`	`show(Table source, DBTimeZone timeZone, String... columns)` Prints the first few rows of a table to standard output, adjusted to the specified time zone.
`static void`	`show(Table source, long maxRowCount, DBTimeZone timeZone, PrintStream out, String... columns)` Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone.
`static void`	`show(Table source, long maxRowCount, DBTimeZone timeZone, String... columns)` Prints the first specified number of rows of a table to standard output, adjusted relative to the specified time zone.
`static void`	`show(Table source, long maxRowCount, DBTimeZone timeZone, String delimiter, PrintStream out, boolean showIndex, String... columns)` Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone, with a specified delimiter between values, and optionally with details of the index and record positions that provided the values.
`static void`	`show(Table source, long maxRowCount, String... columns)` Prints the first specified number of rows of a table to standard output.
`static void`	`show(Table source, String... columns)` Prints the first few rows of a table to standard output.
`static void`	`showCommaDelimited(Table source, long maxRowCount, String... columns)` Prints the first specified number of rows of a table to standard output, with commas between the values.
`static void`	`showCommaDelimited(Table source, String... columns)` Prints the first few rows of a table to standard output, with commas between values.
`static void`	`showWithIndex(Table source, long maxRowCount, DBTimeZone timeZone, PrintStream out, String... columns)` Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone, and also prints the details of the index and record positions that provided the values.
`static void`	`showWithIndex(Table source, long maxRowCount, String... columns)` Prints the first specified number of rows of a table to standard output, and also prints the details of the index and record positions that provided the values.
`static void`	`showWithIndex(Table source, String... columns)` Prints the first few rows of a table to standard output, and also prints the details of the index and record positions that provided the values.
`static String`	`string(Table t, DBTimeZone timeZone, String... columns)` Returns the first few rows of a table as a pipe-delimited string, adjusted relative to the specified time zone.
`static String`	`string(Table t, int size, DBTimeZone timeZone, String... columns)` Returns the first specified number of rows of a table as a pipe-delimited string, adjusted relative to the specified time zone.
`static String`	`string(Table t, int size, String... columns)` Returns the first specified number of rows of a table as a pipe-delimited string.
`static String`	`string(Table t, String... columns)` Returns the first few rows of a table as a pipe-delimited string.
`static void`	`writeCsv(String sourcePath, String destPath, DBTimeZone timeZone, String... columns)` Writes a DB table out as a CSV file.
`static void`	`writeCsv(String sourcePath, String destPath, String... columns)` Writes a DB table out as a CSV file.
`static void`	`writeCsv(Table[] sources, String destPath, boolean compressed, DBTimeZone timeZone, String separator, String... columns)` Writes a set of DB tables out as a CSV file.
`static void`	`writeCsv(Table source, boolean compressed, String destPath, String... columns)` Writes a DB table out as a CSV file.
`static void`	`writeCsv(Table source, String destPath, boolean compressed, DBTimeZone timeZone, String... columns)` Writes a DB table out as a CSV file.
`static void`	`writeCsv(Table source, String destPath, String... columns)` Writes a DB table out as a CSV file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL_STRING
```
public static final String NULL_STRING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TableTools
```
public TableTools()
```
- Method Detail
  - show
```
public static void show(Table source,
                        String... columns)
```
    Prints the first few rows of a table to standard output.
    
    Parameters:
    
    source - an Deephaven table object
    
    columns - varargs of column names to display
  - showWithIndex
```
public static void showWithIndex(Table source,
                                 String... columns)
```
    Prints the first few rows of a table to standard output, and also prints the details of the index and record positions that provided the values.
    
    Parameters:
    
    source - an Deephaven table object
    
    columns - varargs of column names to display
  - showCommaDelimited
```
public static void showCommaDelimited(Table source,
                                      String... columns)
```
    Prints the first few rows of a table to standard output, with commas between values.
    
    Parameters:
    
    source - an Deephaven table object
    
    columns - varargs of column names to display
  - show
```
public static void show(Table source,
                        DBTimeZone timeZone,
                        String... columns)
```
    Prints the first few rows of a table to standard output, adjusted to the specified time zone.
    
    Parameters:
    
    source - an Deephaven table object
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - varargs of column names to display
  - show
```
public static void show(Table source,
                        long maxRowCount,
                        String... columns)
```
    Prints the first specified number of rows of a table to standard output.
    
    Parameters:
    
    source - an Deephaven table object
    
    maxRowCount - the number of rows to return
    
    columns - varargs of column names to display
  - showWithIndex
```
public static void showWithIndex(Table source,
                                 long maxRowCount,
                                 String... columns)
```
    Prints the first specified number of rows of a table to standard output, and also prints the details of the index and record positions that provided the values.
    
    Parameters:
    
    source - an Deephaven table object
    
    maxRowCount - the number of rows to return
    
    columns - varargs of column names to display
  - showCommaDelimited
```
public static void showCommaDelimited(Table source,
                                      long maxRowCount,
                                      String... columns)
```
    Prints the first specified number of rows of a table to standard output, with commas between the values.
    
    Parameters:
    
    source - an Iris table object
    
    maxRowCount - the number of rows to return
    
    columns - varargs of column names to display
  - show
```
public static void show(Table source,
                        long maxRowCount,
                        DBTimeZone timeZone,
                        String... columns)
```
    Prints the first specified number of rows of a table to standard output, adjusted relative to the specified time zone.
    
    Parameters:
    
    source - an Iris table object
    
    maxRowCount - the number of rows to return
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - varargs of column names to display
  - show
```
public static void show(Table source,
                        long maxRowCount,
                        DBTimeZone timeZone,
                        PrintStream out,
                        String... columns)
```
    Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone.
    
    Parameters:
    
    source - an Iris table object
    
    maxRowCount - the number of rows to return
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    out - a PrintStream destination to which to print the data
    
    columns - varargs of column names to display
  - showWithIndex
```
public static void showWithIndex(Table source,
                                 long maxRowCount,
                                 DBTimeZone timeZone,
                                 PrintStream out,
                                 String... columns)
```
    Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone, and also prints the details of the index and record positions that provided the values.
    
    Parameters:
    
    source - an Iris table object
    
    maxRowCount - the number of rows to return
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    out - a PrintStream destination to which to print the data
    
    columns - varargs of column names to display
  - show
```
public static void show(Table source,
                        long maxRowCount,
                        DBTimeZone timeZone,
                        String delimiter,
                        PrintStream out,
                        boolean showIndex,
                        String... columns)
```
    Prints the first specified number of rows of a table to a specfied output, adjusted relative to the specified time zone, with a specified delimiter between values, and optionally with details of the index and record positions that provided the values.
    
    Parameters:
    
    source - an Iris table object
    
    maxRowCount - the number of rows to return
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    delimiter - a String value to use between printed values
    
    out - a PrintStream destination to which to print the data
    
    showIndex - a boolean indicating whether to also print index details
    
    columns - varargs of column names to display
  - display
```
@Deprecated
public static JFrame display(Table source,
                                         String... columns)
```
    Deprecated.
  - display
```
@Deprecated
public static JFrame display(Table source,
                                         boolean shutdownProcessOnClose,
                                         String... columns)
```
    Deprecated.
  - display
```
@Deprecated
public static JFrame display(Table source,
                                         Map<String,Format> formatters,
                                         String... columns)
```
    Deprecated.
  - display
```
@Deprecated
public static JFrame display(Table source,
                                         boolean shutdownProcessOnClose,
                                         Map<String,Format> formatters,
                                         String... columns)
```
    Deprecated.
  - string
```
public static String string(Table t,
                            String... columns)
                     throws IOException
```
    Returns the first few rows of a table as a pipe-delimited string.
    
    Parameters:
    
    t - an Iris table object
    
    columns - varargs of columns to include in the result
    
    Returns:
    
    a String
    
    Throws:
    
    IOException - if the table files can't be read
  - string
```
public static String string(Table t,
                            int size,
                            String... columns)
                     throws IOException
```
    Returns the first specified number of rows of a table as a pipe-delimited string.
    
    Parameters:
    
    t - an Iris table object
    
    size - the number of rows to return
    
    columns - varargs of columns to include in the result
    
    Returns:
    
    a String
    
    Throws:
    
    IOException - if the table files can't be read
  - string
```
public static String string(Table t,
                            DBTimeZone timeZone,
                            String... columns)
                     throws IOException
```
    Returns the first few rows of a table as a pipe-delimited string, adjusted relative to the specified time zone.
    
    Parameters:
    
    t - an Iris table object
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - varargs of columns to include in the result
    
    Returns:
    
    a String
    
    Throws:
    
    IOException - if the table files can't be read
  - string
```
public static String string(Table t,
                            int size,
                            DBTimeZone timeZone,
                            String... columns)
                     throws IOException
```
    Returns the first specified number of rows of a table as a pipe-delimited string, adjusted relative to the specified time zone.
    
    Parameters:
    
    t - an Iris table object
    
    size - the number of rows to return
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - varargs of columns to include in the result
    
    Returns:
    
    a String
    
    Throws:
    
    IOException - if the table files can't be read
  - html
```
public static String html(Table source)
```
    Returns a printout of a table formatted as HTML. Limit use to small tables to avoid running out of memory.
    
    Parameters:
    
    source - an Iris table object
    
    Returns:
    
    a String of the table printout formatted as HTML
  - diff
```
public static String diff(Table actualResult,
                          Table expectedResult,
                          long maxDiffLines)
```
    Computes the difference of two tables for use in verification.
    
    Parameters:
    
    actualResult - first Iris table object to compare
    
    expectedResult - second Iris table object to compare
    
    maxDiffLines - stop comparing after this many differences are found
    
    Returns:
    
    String report of the detected differences
  - diff
```
public static String diff(Table actualResult,
                          Table expectedResult,
                          long maxDiffLines,
                          EnumSet<TableDiff.DiffItems> itemsToSkip)
```
    Computes the difference of two tables for use in verification.
    
    Parameters:
    
    actualResult - first Iris table object to compare
    
    expectedResult - second Iris table object to compare
    
    maxDiffLines - stop comparing after this many differences are found
    
    itemsToSkip - EnumSet of checks not to perform, such as checking column order, or exact match of double values
    
    Returns:
    
    String report of the detected differences
  - readBin
```
public static Table readBin(@NotNull
                            String namespace,
                            @NotNull
                            String tableName,
                            @NotNull
                            File sourceDirectory,
                            @NotNull
                            String sourceFileNameGlob)
```
    Loads a binary log file as an in-memory DB table. Requires access to the listener class that matches the file to be loaded.
    
    Parameters:
    
    namespace - namespace to search for the Listener needed to import the data
    
    tableName - table name to find for the Listener needed to import the data
    
    sourceDirectory - file system path of the log file
    
    sourceFileNameGlob - file pattern to use to find log file(s) to import
    
    Returns:
    
    an Iris table object
  - readBin
```
public static Table readBin(@NotNull
                            String namespace,
                            @NotNull
                            String tableName,
                            String... sourceFiles)
```
    Loads a binary log file as an in-memory DB table. Requires access to the listener class that matches the file to be loaded.
    
    Parameters:
    
    namespace - namespace to search for the Listener needed to import the data
    
    tableName - table name to find for the Listener needed to import the data
    
    sourceFiles - list of names of files to import
    
    Returns:
    
    an Iris table object
  - readBin
```
public static Table readBin(@NotNull
                            String namespace,
                            @NotNull
                            String tableName,
                            File... sourceFiles)
```
    Loads a binary log file as an in-memory DB table. Requires access to the listener class that matches the file to be loaded.
    
    Parameters:
    
    namespace - namespace to search for the Listener needed to import the data
    
    tableName - table name to find for the Listener needed to import the data
    
    sourceFiles - list of File objects to import
    
    Returns:
    
    an Iris table object
  - readBin
```
public static Table readBin(@NotNull
                            String namespace,
                            @NotNull
                            String tableName,
                            @NotNull
                            TableType tableType,
                            File... sourceFiles)
```
    Loads a binary log file as an in-memory DB table. Requires access to the listener class that matches the file to be loaded.
    
    Parameters:
    
    namespace - namespace to search for the Listener needed to import the data
    
    tableName - table name to find for the Listener needed to import the data
    
    tableType - table type this table definition
    
    sourceFiles - list of File objects to import
    
    Returns:
    
    an Iris table object
  - readBin
```
public static Table readBin(@NotNull
                            String namespace,
                            @NotNull
                            String tableName,
                            TableDefinition tableDefinition,
                            File... sourceFiles)
```
    Loads a binary log file as an in-memory DB table. Requires access to the listener class that matches the file to be loaded.
    
    Parameters:
    
    namespace - namespace to search for the Listener needed to import the data
    
    tableName - table name to find for the Listener needed to import the data
    
    tableDefinition - use this table definition rather than looking one up
    
    sourceFiles - list of File objects to import
    
    Returns:
    
    an Iris table object
  - readBin
```
public static Table readBin(@NotNull
                            TableKey key,
                            File... sourceFiles)
```
  - readCsv
```
public static DynamicTable readCsv(InputStream is)
                            throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    is - an InputStream providing access to the CSV data.
    
    Returns:
    
    an Iris DynamicTable object
    
    Throws:
    
    IOException - if the InputStream cannot be read
  - readCsv
```
public static Table readCsv(String filePath)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readCsv
```
public static Table readCsv(String filePath,
                            String format)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    format - an Apache Commons CSV format name to be used to parse the CSV
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readCsv
```
public static Table readCsv(String filePath,
                            String format,
                            StatusCallback progress)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    format - an Apache Commons CSV format name to be used to parse the CSV
    
    progress - a StatusCallback object that can be used to log progress details or update a progress bar. If passed explicitly as null, a StatusCallback instance will be created to log progress to the current logger.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readCsv
```
public static Table readCsv(File file)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    file - a file object providing access to the CSV file to be read
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readCsv
```
public static Table readCsv(File file,
                            StatusCallback progress)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    file - a file object providing access to the CSV file to be read
    
    progress - a StatusCallback object that can be used to log progress details or update a progress bar. If passed explicitly as null, a StatusCallback instance will be created to log progress to the current logger.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readCsv
```
public static Table readCsv(File file,
                            String format,
                            StatusCallback progress)
                     throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    file - a file object providing access to the CSV file to be read
    
    format - an Apache Commons CSV format name to be used to parse the CSV
    
    progress - a StatusCallback object that can be used to log progress details or update a progress bar. If passed explicitly as null, a StatusCallback instance will be created to log progress to the current logger.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readHeaderlessCsv
```
public static Table readHeaderlessCsv(String filePath)
                               throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readHeaderlessCsv
```
public static Table readHeaderlessCsv(String filePath,
                                      Collection<String> header)
                               throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    header - Column names to use for the resultant table.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readHeaderlessCsv
```
public static Table readHeaderlessCsv(String filePath,
                                      String... header)
                               throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    header - Column names to use for the resultant table.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readHeaderlessCsv
```
public static Table readHeaderlessCsv(String filePath,
                                      String format,
                                      StatusCallback progress,
                                      Collection<String> header)
                               throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    filePath - the fully-qualified path to a CSV file to be read
    
    format - an Apache Commons CSV format name to be used to parse the CSV
    
    progress - a StatusCallback object that can be used to log progress details or update a progress bar. If passed explicitly as null, a StatusCallback instance will be created to log progress to the current logger.
    
    header - Column names to use for the resultant table.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - readHeaderlessCsv
```
public static Table readHeaderlessCsv(File file,
                                      String format,
                                      StatusCallback progress,
                                      @Nullable
                                      Collection<String> header)
                               throws IOException
```
    Returns a memory table created from importing CSV data. The first row must be column names. Column data types are inferred from the data.
    
    Parameters:
    
    file - a file object providing access to the CSV file to be read
    
    format - an Apache Commons CSV format name to be used to parse the CSV
    
    progress - a StatusCallback object that can be used to log progress details or update a progress bar. If passed explicitly as null, a StatusCallback instance will be created to log progress to the current logger.
    
    header - Column names to use for the resultant table, or null if column names should be automatically generated.
    
    Returns:
    
    an Iris Table object
    
    Throws:
    
    IOException - if the file cannot be read
  - writeCsv
```
public static void writeCsv(String sourcePath,
                            String destPath,
                            String... columns)
                     throws IOException
```
    Writes a DB table out as a CSV file.
    
    Parameters:
    
    sourcePath - path to the table files to be exported
    
    destPath - path to the CSV file to be written
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if source files cannot be read or target file cannot be written
  - writeCsv
```
public static void writeCsv(String sourcePath,
                            String destPath,
                            DBTimeZone timeZone,
                            String... columns)
                     throws IOException
```
    Writes a DB table out as a CSV file.
    
    Parameters:
    
    sourcePath - path to the table files to be exported
    
    destPath - path to the CSV file to be written
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if source files cannot be read or target file cannot be written
  - writeCsv
```
public static void writeCsv(Table source,
                            boolean compressed,
                            String destPath,
                            String... columns)
                     throws IOException
```
    Writes a DB table out as a CSV file.
    
    Parameters:
    
    source - an Iris table object to be exported
    
    destPath - path to the CSV file to be written
    
    compressed - whether to compress (bz2) the file being written
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if the target file cannot be written
  - writeCsv
```
public static void writeCsv(Table source,
                            String destPath,
                            String... columns)
                     throws IOException
```
    Writes a DB table out as a CSV file.
    
    Parameters:
    
    source - an Iris table object to be exported
    
    destPath - path to the CSV file to be written
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if the target file cannot be written
  - writeCsv
```
public static void writeCsv(Table source,
                            String destPath,
                            boolean compressed,
                            DBTimeZone timeZone,
                            String... columns)
                     throws IOException
```
    Writes a DB table out as a CSV file.
    
    Parameters:
    
    source - an Iris table object to be exported
    
    destPath - path to the CSV file to be written
    
    compressed - whether to zip the file being written
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if the target file cannot be written
  - writeCsv
```
public static void writeCsv(Table[] sources,
                            String destPath,
                            boolean compressed,
                            DBTimeZone timeZone,
                            String separator,
                            String... columns)
                     throws IOException
```
    Writes a set of DB tables out as a CSV file.
    
    Parameters:
    
    sources - an array of Iris table objects to be exported
    
    destPath - path to the CSV file to be written
    
    compressed - whether to compress (bz2) the file being written
    
    timeZone - a DBTimeZone constant relative to which DBDateTime data should be adjusted
    
    separator - a String (normally a single character) to be used as the field delimiter
    
    columns - a list of columns to include in the export
    
    Throws:
    
    IOException - if the target file cannot be written
  - colSource
```
public static <T> ColumnSource<T> colSource(Class<T> clazz,
                                            Collection<T> values)
```
    Creates an in-memory column of the specified type for a collection of values.
    
    Type Parameters:
    
    T - the type to use for the new column
    
    Parameters:
    
    clazz - the class to use for the new column
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - objColSource
```
public static <T> ColumnSource objColSource(T... values)
```
    Creates an in-memory column of the specified type for a collection of values
    
    Type Parameters:
    
    T - the type to use for the new column
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Long> colSource(long... values)
```
    Creates an in-memory column of type long for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Integer> colSource(int... values)
```
    Creates an in-memory column of type int for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Short> colSource(short... values)
```
    Creates an in-memory column of type short for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Byte> colSource(byte... values)
```
    Creates an in-memory column of type byte for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Character> colSource(char... values)
```
    Creates an in-memory column of type char for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Double> colSource(double... values)
```
    Creates an in-memory column of type double for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - colSource
```
public static ColumnSource<Float> colSource(float... values)
```
    Creates an in-memory column of type float for a collection of values.
    
    Parameters:
    
    values - a collection of values to populate the new column
    
    Returns:
    
    an Iris ColumnSource object
  - getKey
```
public static Object getKey(ColumnSource[] groupByColumnSources,
                            long row)
```
    Returns a SmartKey for the specified row from a set of ColumnSources.
    
    Parameters:
    
    groupByColumnSources - a set of ColumnSources from which to retrieve the data
    
    row - the row number for which to retrieve data
    
    Returns:
    
    an Iris SmartKey object
  - getPrevKey
```
public static Object getPrevKey(ColumnSource[] groupByColumnSources,
                                long row)
```
    Returns a SmartKey for the row previous to the specified row from a set of ColumnSources.
    
    Parameters:
    
    groupByColumnSources - a set of ColumnSources from which to retrieve the data
    
    row - the row number for which to retrieve the previous row's data
    
    Returns:
    
    an Iris SmartKey object
  - col
```
public static <T> ColumnHolder col(String name,
                                   T... data)
```
    Returns a ColumnHolder that can be used when creating in-memory tables.
    
    Type Parameters:
    
    T - the type of the column
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - longCol
```
public static ColumnHolder longCol(String name,
                                   long... data)
```
    Returns a ColumnHolder of type long that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - intCol
```
public static ColumnHolder intCol(String name,
                                  int... data)
```
    Returns a ColumnHolder of type int that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - shortCol
```
public static ColumnHolder shortCol(String name,
                                    short... data)
```
    Returns a ColumnHolder of type short that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - byteCol
```
public static ColumnHolder byteCol(String name,
                                   byte... data)
```
    Returns a ColumnHolder of type byte that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - charCol
```
public static ColumnHolder charCol(String name,
                                   char... data)
```
    Returns a ColumnHolder of type char that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - doubleCol
```
public static ColumnHolder doubleCol(String name,
                                     double... data)
```
    Returns a ColumnHolder of type double that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - floatCol
```
public static ColumnHolder floatCol(String name,
                                    float... data)
```
    Returns a ColumnHolder of type float that can be used when creating in-memory tables.
    
    Parameters:
    
    name - name of the column
    
    data - a list of values for the column
    
    Returns:
    
    an Iris ColumnHolder object
  - emptyTable
```
public static Table emptyTable(long size)
```
    Returns a new empty Iris Table with no columns, but with defined number of rows.
    
    Parameters:
    
    size - the number of rows to allocate space for
    
    Returns:
    
    an Iris Table object
  - emptyTable
```
public static Table emptyTable(long size,
                               TableDefinition tableDefinition)
```
    Returns a new empty Iris Table with columns based on the specified TableDefinition.
    
    Parameters:
    
    size - the number of rows to allocate space for
    
    tableDefinition - the TableDefinition (column names and properties) to use for the new table
    
    Returns:
    
    an Iris Table object
  - newTable
```
public static DynamicTable newTable(long size,
                                    List<String> names,
                                    List<ColumnSource> columnSources)
```
    Creates a new DynamicTable from one or more ColumnSources.
    
    Parameters:
    
    size - the number of rows to allocate
    
    names - a List of column names
    
    columnSources - a List of the ColumnSource(s)
    
    Returns:
    
    an Iris DynamicTable object
  - newTable
```
public static DynamicTable newTable(long size,
                                    Map<String,ColumnSource> columns)
```
    Creates a new DynamicTable from a Map of one or more ColumnSources.
    
    Parameters:
    
    size - the number of rows to allocate
    
    columns - a Map of column names and ColumnSources
    
    Returns:
    
    an Iris DynamicTable object
  - newTable
```
public static DynamicTable newTable(TableDefinition definition)
```
    Creates a new empty DynamicTable from a TableDefinition.
    
    Parameters:
    
    definition - the TableDefinition (column names and properties) to use for the new table
    
    Returns:
    
    an Iris DynamicTable object
  - newTable
```
public static DynamicTable newTable(ColumnHolder... columnHolders)
```
    Creates a new DynamicTable from one or more ColumnHolders.
    
    Parameters:
    
    columnHolders - a list of ColumnHolders from which to create the table
    
    Returns:
    
    an Iris DynamicTable object
  - merge
```
public static Table merge(List<Table> theList)
```
    Concatenates multiple Iris Tables into a single Table.
    For historical tables, the resultant table will have rows from the same table together; in the order they are specified as inputs.
    
    For ticking tables, the original result will be similarly ordered; however as tables grow the new rows for each table may be appended to the end of the result and intermixed. To ensure input order; you must annotate each table with a column indicating the source and then sort the result based on that column.
    
    Parameters:
    
    theList - a List of Tables to be concatenated
    
    Returns:
    
    an Iris table object
  - merge
```
public static Table merge(Collection<Table> tables)
```
    Concatenates multiple Iris Tables into a single Table.
    For historical tables, the resultant table will have rows from the same table together; in the order they are specified as inputs.
    
    For ticking tables, the original result will be similarly ordered; however as tables grow the new rows for each table may be appended to the end of the result and intermixed. To ensure input order; you must annotate each table with a column indicating the source and then sort the result based on that column.
    
    Parameters:
    
    tables - a Collection of Tables to be concatenated
    
    Returns:
    
    an Iris table object
  - merge
```
public static Table merge(Table... tables)
```
    Concatenates multiple Iris Tables into a single Table.
    For historical tables, the resultant table will have rows from the same table together; in the order they are specified as inputs.
    
    For ticking tables, the original result will be similarly ordered; however as tables grow the new rows for each table may be appended to the end of the result and intermixed. To ensure input order; you must annotate each table with a column indicating the source and then sort the result based on that column.
    
    Parameters:
    
    tables - a list of Tables to be concatenated
    
    Returns:
    
    an Iris table object
  - mergeSorted
```
public static Table mergeSorted(String keyColumn,
                                Table... tables)
```
    Concatenates multiple sorted Iris Tables into a single Table sorted by the specified key column. The input tables must each individually be sorted by keyColumn, otherwise results are undefined.
    
    Parameters:
    
    tables - sorted Tables to be concatenated
    
    keyColumn - the column to use when sorting the concatenated results
    
    Returns:
    
    an Iris table object
  - mergeSorted
```
public static Table mergeSorted(String keyColumn,
                                Collection<Table> tables)
```
    Concatenates multiple sorted Iris Tables into a single Table sorted by the specified key column. The input tables must each individually be sorted by keyColumn, otherwise results are undefined.
    
    Parameters:
    
    tables - a Collection of sorted Tables to be concatenated
    
    keyColumn - the column to use when sorting the concatenated results
    
    Returns:
    
    an Iris table object
  - roundDecimalColumns
```
public static Table roundDecimalColumns(Table table)
```
    Produce a new table with all the columns of this table, in the same order, but with all double and float columns rounded to longs.
    
    Returns:
    
    The new Table, with columns modified as explained above
  - roundDecimalColumnsExcept
```
public static Table roundDecimalColumnsExcept(Table table,
                                              String... columnsNotToRound)
```
    Produce a new table with all the columns of this table, in the same order, but with all double and float columns rounded to longs, except for the specified columnsNotToRound.
    
    Parameters:
    
    columnsNotToRound - The names of the double and float columns not to round to longs
    
    Returns:
    
    The new Table, with columns modified as explained above
  - roundDecimalColumns
```
public static Table roundDecimalColumns(Table table,
                                        String... columns)
```
    Produce a new table with all the columns of this table, in the same order, but with the specified columns rounded to longs. The given columns must be double or float columns.
    
    Parameters:
    
    columns - The names of the double and float columns to round
    
    Returns:
    
    The new Table, with columns modified as explained above
    
    Throws:
    
    IllegalArgumentException - If columns is null, or if one of the specified columns is neither a double column nor a float column.

Class TableTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_STRING

Constructor Detail

TableTools

Method Detail

show

showWithIndex

showCommaDelimited

show

show

showWithIndex

showCommaDelimited

show

show

showWithIndex

show

display

display

display

display

string

string

string

string

html

diff

diff

readBin

readBin

readBin

readBin

readBin

readBin

readCsv

readCsv

readCsv

readCsv

readCsv

readCsv

readCsv

readHeaderlessCsv

readHeaderlessCsv

readHeaderlessCsv

readHeaderlessCsv

readHeaderlessCsv

writeCsv

writeCsv

writeCsv

writeCsv

writeCsv

writeCsv

colSource

objColSource

colSource

colSource

colSource

colSource

colSource

colSource

colSource

getKey

getPrevKey

col

longCol

intCol

shortCol

byteCol

charCol

doubleCol

floatCol

emptyTable

emptyTable

newTable

newTable

newTable