Table

java.lang.Object
- org.datavec.dataframe.api.Table

All Implemented Interfaces:

it.unimi.dsi.fastutil.ints.IntIterable, java.lang.Iterable<java.lang.Integer>, Relation

Direct Known Subclasses:

NumericSummaryTable, SubTable
```
public class Table
extends java.lang.Object
implements Relation, it.unimi.dsi.fastutil.ints.IntIterable
```
A table of data, consisting of some number of columns, each of which has the same number of rows. All the data in a column has the same type: integer, float, category, etc., but a table may contain an arbitrary number of columns of any type.
Tables are the main data-type and primary focus of Tablesaw.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Table(java.lang.String name, Column... columns)
Returns a new Table initialized with the given names and columns

Constructors
Modifier	Constructor and Description
`protected`	`Table(java.lang.String name, Column... columns)` Returns a new Table initialized with the given names and columns

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(Column... cols)` Adds the given column to this table
`void`	`addColumn(int index, Column column)` Adds the given column to this table at the given position in the column list
`void`	`append(Table tableToAppend)`
`void`	`clear()` Clears all the data from this table
`Column`	`column(int columnIndex)` Returns the column at the given index in the column list
`int`	`columnCount()` Returns the number of columns in the table
`int`	`columnIndex(Column column)` Returns the index of the given column (its position in the list of columns)
`int`	`columnIndex(java.lang.String columnName)` Returns the index of the column with the given name
`java.util.List<java.lang.String>`	`columnNames()` Returns a List of the names of all the columns in this table
`java.util.List<Column>`	`columns()` Returns the list of columns
`java.util.List<Column>`	`columns(java.lang.String... columnNames)` Returns only the columns whose names are given in the input array
`Count`	`count(java.lang.String numericColumnName)`
`Table`	`countBy(CategoryColumn column)`
`static Table`	`create(java.sql.ResultSet resultSet, java.lang.String tableName)` Returns a new Table with the given name, and containing the data in the given result set
`static Table`	`create(java.lang.String tableName)` Returns a new, empty table (without rows or columns) with the given name
`static Table`	`create(java.lang.String tableName, Column... columns)` Returns a new table with the given columns and given name
`static Table`	`create(TableMetadata metadata)` Returns a new, empty table constructed according to the given metadata
`static Table`	`createFromCsv(ColumnType[] types, java.lang.String csvFileName)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromCsv(ColumnType[] types, java.lang.String csvFileName, boolean header)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromCsv(ColumnType[] types, java.lang.String csvFileName, boolean header, char delimiter)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromCsv(java.lang.String csvFileName)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromCsv(java.lang.String csvFileName, boolean header)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromCsv(java.lang.String csvFileName, boolean header, char delimiter)` Returns a new table constructed from a character delimited (aka CSV) text file
`static Table`	`createFromStream(ColumnType[] types, boolean header, char delimiter, java.io.InputStream stream, java.lang.String tableName)` Returns a new table constructed from a character delimited (aka CSV) text file
`Table`	`drop(int... rows)` Returns a table with the given rows dropped
`Table`	`drop(it.unimi.dsi.fastutil.ints.IntArrayList rows)` Returns a table with the given rows dropped
`Table`	`emptyCopy()` Returns a table with the same columns as this table, but no data
`Table`	`emptyCopy(int rowSize)` Returns a table with the same columns as this table, but no data, initialized to the given row size
`void`	`exportToCsv(java.lang.String fileNameWithPath)` Exports this table as a CSV file with the name (and path) of the given file
`Table`	`first(int nRows)` Returns a new table containing the first `nrows` of data in this table
`Table`	`fullCopy()` Returns a table with the same columns as this table, but no data
`java.lang.String`	`get(int c, int r)` Returns a string representation of the value at the given row and column indexes
`it.unimi.dsi.fastutil.ints.IntComparator`	`getComparator(Sort key)` Returns a comparator that can be used to sort the records in this table according to the given sort key
`static Sort`	`getSort(java.lang.String... columnNames)` Returns an object that can be used to sort this table in the order specified for by the given column names
`it.unimi.dsi.fastutil.ints.IntIterator`	`iterator()`
`Table`	`last(int nRows)` Returns a new table containing the last `nrows` of data in this table
`Maximum`	`max(java.lang.String numericColumnName)`
`Mean`	`mean(java.lang.String numericColumnName)`
`Median`	`median(java.lang.String numericColumnName)`
`Minimum`	`minimum(java.lang.String numericColumnName)`
`java.lang.String`	`name()` Returns the name of the table
`java.lang.String`	`printHtml()`
`static Table`	`readTable(java.lang.String tableNameAndPath)`
`double`	`reduce(java.lang.String numericColumnName, NumericReduceFunction function)` Returns the result of applying the given function to the specified column
`void`	`removeColumns(Column... columns)` Removes the given columns
`void`	`retainColumns(Column... columns)` Removes the given columns
`void`	`retainColumns(java.lang.String... columnNames)`
`int`	`rowCount()` Returns the number of rows in the table
`int[]`	`rows()` Returns an array of ints of the same number of rows as the table
`Table`	`sample(double proportion)` Returns a table consisting of randomly selected records from this table.
`Table[]`	`sampleSplit(double table1Proportion)` Splits the table into two, randomly assigning records to each according to the proportion given in trainingProportion
`java.lang.String`	`save(java.lang.String folder)`
`Projection`	`select(java.lang.String... columnName)`
`BooleanColumn`	`selectIntoColumn(java.lang.String newColumnName, Filter filter)`
`BooleanColumn`	`selectIntoColumn(java.lang.String newColumnName, Selection selection)`
`Table`	`selectWhere(Filter filter)`
`Table`	`selectWhere(Selection selection)`
`void`	`setName(java.lang.String name)` Sets the name of the table
`Table`	`sortAscendingOn(java.lang.String... columnNames)` Returns a copy of this table sorted in the order of the given column names, in ascending order
`Table`	`sortDescendingOn(java.lang.String... columnNames)` Returns a copy of this table sorted on the given column names, applied in order, descending
`Table`	`sortOn(it.unimi.dsi.fastutil.ints.IntComparator rowComparator)` Returns a copy of this table sorted using the given comparator
`Table`	`sortOn(Sort key)`
`Table`	`sortOn(java.lang.String... columnNames)` Returns a copy of this table sorted on the given column names, applied in order,
`ViewGroup`	`splitOn(Column... columns)`
`StandardDeviation`	`stdDev(java.lang.String numericColumnName)`
`Table`	`structure()`
`Sum`	`sum(java.lang.String numericColumnName)`
`SummaryFunction`	`summarize(java.lang.String numericColumnName, NumericReduceFunction function)`
`java.lang.String`	`toString()` Joins together this table and another table on the given column names.
`Table`	`uniqueRecords()` Returns the unique records in this table Note: Uses a lot of memory for a sort
`Variance`	`variance(java.lang.String numericColumnName)`

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

Methods inherited from interface org.datavec.dataframe.table.Relation
booleanColumn, booleanColumn, categoryColumn, categoryColumn, column, columnTypes, colWidths, dateColumn, dateColumn, dateTimeColumn, dateTimeColumn, floatColumn, floatColumn, intColumn, intColumn, isEmpty, longColumn, longColumn, nCol, nCol, numericColumn, numericColumn, print, removeColumn, removeColumns, shape, shortColumn, shortColumn, summary, timeColumn, timeColumn

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Table
```
protected Table(java.lang.String name,
                Column... columns)
```
    Returns a new Table initialized with the given names and columns
    
    Parameters:
    
    name - The name of the table
    
    columns - One or more columns, all of which must have either the same length or size 0
- Method Detail
  - create
```
public static Table create(java.lang.String tableName)
```
    Returns a new, empty table (without rows or columns) with the given name
  - create
```
public static Table create(TableMetadata metadata)
```
    Returns a new, empty table constructed according to the given metadata
  - create
```
public static Table create(java.lang.String tableName,
                           Column... columns)
```
    Returns a new table with the given columns and given name
    
    Parameters:
    
    columns - One or more columns, all of the same @code{column.size()}
  - addColumn
```
public void addColumn(Column... cols)
```
    Adds the given column to this table
    
    Specified by:
    
    addColumn in interface Relation
  - addColumn
```
public void addColumn(int index,
                      Column column)
```
    Adds the given column to this table at the given position in the column list
    
    Parameters:
    
    index - Zero-based index into the column list
    
    column - Column to be added
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the table
    
    Specified by:
    
    setName in interface Relation
  - column
```
public Column column(int columnIndex)
```
    Returns the column at the given index in the column list
    
    Specified by:
    
    column in interface Relation
    
    Parameters:
    
    columnIndex - an integer at least 0 and less than number of columns in the table
    
    Returns:
    
    the column at the given index
  - columnCount
```
public int columnCount()
```
    Returns the number of columns in the table
    
    Specified by:
    
    columnCount in interface Relation
  - rowCount
```
public int rowCount()
```
    Returns the number of rows in the table
    
    Specified by:
    
    rowCount in interface Relation
  - columns
```
public java.util.List<Column> columns()
```
    Returns the list of columns
    
    Specified by:
    
    columns in interface Relation
  - columns
```
public java.util.List<Column> columns(java.lang.String... columnNames)
```
    Returns only the columns whose names are given in the input array
  - columnIndex
```
public int columnIndex(java.lang.String columnName)
```
    Returns the index of the column with the given name
    
    Specified by:
    
    columnIndex in interface Relation
    
    Throws:
    
    java.lang.IllegalArgumentException - if the input string is not the name of any column in the table
  - columnIndex
```
public int columnIndex(Column column)
```
    Returns the index of the given column (its position in the list of columns)
    
    Specified by:
    
    columnIndex in interface Relation
    
    Throws:
    
    java.lang.IllegalArgumentException - if the column is not present in this table
  - name
```
public java.lang.String name()
```
    Returns the name of the table
    
    Specified by:
    
    name in interface Relation
  - columnNames
```
public java.util.List<java.lang.String> columnNames()
```
    Returns a List of the names of all the columns in this table
    
    Specified by:
    
    columnNames in interface Relation
  - get
```
public java.lang.String get(int c,
                            int r)
```
    Returns a string representation of the value at the given row and column indexes
    
    Specified by:
    
    get in interface Relation
    
    Parameters:
    
    c - the column index, 0 based
    
    r - the row index, 0 based
  - fullCopy
```
public Table fullCopy()
```
    Returns a table with the same columns as this table, but no data
  - emptyCopy
```
public Table emptyCopy()
```
    Returns a table with the same columns as this table, but no data
  - emptyCopy
```
public Table emptyCopy(int rowSize)
```
    Returns a table with the same columns as this table, but no data, initialized to the given row size
  - sampleSplit
```
public Table[] sampleSplit(double table1Proportion)
```
    Splits the table into two, randomly assigning records to each according to the proportion given in trainingProportion
    
    Parameters:
    
    table1Proportion - The proportion to go in the first table
    
    Returns:
    
    An array two tables, with the first table having the proportion specified in the method parameter, and the second table having the balance of the rows
  - sample
```
public Table sample(double proportion)
```
    Returns a table consisting of randomly selected records from this table. The sample size is based on the given proportion
    
    Parameters:
    
    proportion - The proportion to go in the sample
  - clear
```
public void clear()
```
    Clears all the data from this table
    
    Specified by:
    
    clear in interface Relation
  - first
```
public Table first(int nRows)
```
    Returns a new table containing the first nrows of data in this table
    
    Specified by:
    
    first in interface Relation
  - last
```
public Table last(int nRows)
```
    Returns a new table containing the last nrows of data in this table
  - sortOn
```
public Table sortOn(java.lang.String... columnNames)
```
    Returns a copy of this table sorted on the given column names, applied in order,
    if column name starts with - then sort that column descending otherwise sort ascending
  - sortAscendingOn
```
public Table sortAscendingOn(java.lang.String... columnNames)
```
    Returns a copy of this table sorted in the order of the given column names, in ascending order
  - sortDescendingOn
```
public Table sortDescendingOn(java.lang.String... columnNames)
```
    Returns a copy of this table sorted on the given column names, applied in order, descending
  - getSort
```
public static Sort getSort(java.lang.String... columnNames)
```
    Returns an object that can be used to sort this table in the order specified for by the given column names
  - sortOn
```
public Table sortOn(Sort key)
```
  - getComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator getComparator(Sort key)
```
    Returns a comparator that can be used to sort the records in this table according to the given sort key
  - sortOn
```
public Table sortOn(it.unimi.dsi.fastutil.ints.IntComparator rowComparator)
```
    Returns a copy of this table sorted using the given comparator
  - rows
```
public int[] rows()
```
    Returns an array of ints of the same number of rows as the table
  - selectWhere
```
public Table selectWhere(Selection selection)
```
  - selectIntoColumn
```
public BooleanColumn selectIntoColumn(java.lang.String newColumnName,
                                      Selection selection)
```
  - selectWhere
```
public Table selectWhere(Filter filter)
```
  - selectIntoColumn
```
public BooleanColumn selectIntoColumn(java.lang.String newColumnName,
                                      Filter filter)
```
  - splitOn
```
public ViewGroup splitOn(Column... columns)
```
  - printHtml
```
public java.lang.String printHtml()
```
  - structure
```
public Table structure()
```
    Specified by:
    
    structure in interface Relation
  - drop
```
public Table drop(it.unimi.dsi.fastutil.ints.IntArrayList rows)
```
    Returns a table with the given rows dropped
    
    Parameters:
    
    rows - the rows to drop
    
    Returns:
    
    the table with the dropped rows
  - drop
```
public Table drop(int... rows)
```
    Returns a table with the given rows dropped
    
    Parameters:
    
    rows - the rows to drop
    
    Returns:
    
    the table with the dropped rows
  - uniqueRecords
```
public Table uniqueRecords()
```
    Returns the unique records in this table Note: Uses a lot of memory for a sort
  - select
```
public Projection select(java.lang.String... columnName)
```
  - removeColumns
```
public void removeColumns(Column... columns)
```
    Removes the given columns
    
    Specified by:
    
    removeColumns in interface Relation
  - retainColumns
```
public void retainColumns(Column... columns)
```
    Removes the given columns
  - retainColumns
```
public void retainColumns(java.lang.String... columnNames)
```
  - sum
```
public Sum sum(java.lang.String numericColumnName)
```
  - mean
```
public Mean mean(java.lang.String numericColumnName)
```
  - median
```
public Median median(java.lang.String numericColumnName)
```
  - variance
```
public Variance variance(java.lang.String numericColumnName)
```
  - stdDev
```
public StandardDeviation stdDev(java.lang.String numericColumnName)
```
  - count
```
public Count count(java.lang.String numericColumnName)
```
  - max
```
public Maximum max(java.lang.String numericColumnName)
```
  - minimum
```
public Minimum minimum(java.lang.String numericColumnName)
```
  - append
```
public void append(Table tableToAppend)
```
  - exportToCsv
```
public void exportToCsv(java.lang.String fileNameWithPath)
```
    Exports this table as a CSV file with the name (and path) of the given file
    
    Parameters:
    
    fileNameWithPath - The name of the file to save to. By default, it writes to the working directory, but you can specify a different folder by providing the path (e.g. mydata/myfile.csv)
  - save
```
public java.lang.String save(java.lang.String folder)
```
  - readTable
```
public static Table readTable(java.lang.String tableNameAndPath)
```
  - reduce
```
public double reduce(java.lang.String numericColumnName,
                     NumericReduceFunction function)
```
    Returns the result of applying the given function to the specified column
    
    Parameters:
    
    numericColumnName - The name of a numeric (integer, float, etc.) column in this table
    
    function - A numeric reduce function
    
    Returns:
    
    the function result
    
    Throws:
    
    java.lang.IllegalArgumentException - if numericColumnName doesn't name a numeric column in this table
  - summarize
```
public SummaryFunction summarize(java.lang.String numericColumnName,
                                 NumericReduceFunction function)
```
  - countBy
```
public Table countBy(CategoryColumn column)
```
  - createFromCsv
```
public static Table createFromCsv(java.lang.String csvFileName)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    It is assumed that the file is truly comma-separated, and that the file has a one-line header, which is used to populate the column names
    
    Parameters:
    
    csvFileName - The name of the file to import
    
    Throws:
    
    java.io.IOException
  - createFromCsv
```
public static Table createFromCsv(java.lang.String csvFileName,
                                  boolean header)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    It is assumed that the file is truly comma-separated, and that the file has a one-line header, which is used to populate the column names
    
    Parameters:
    
    csvFileName - The name of the file to import
    
    header - True if the file has a single header row. False if it has no header row. Multi-line headers are not supported
    
    Throws:
    
    java.io.IOException
  - createFromCsv
```
public static Table createFromCsv(java.lang.String csvFileName,
                                  boolean header,
                                  char delimiter)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    It is assumed that the file is truly comma-separated, and that the file has a one-line header, which is used to populate the column names
    
    Parameters:
    
    csvFileName - The name of the file to import
    
    header - True if the file has a single header row. False if it has no header row. Multi-line headers are not supported
    
    delimiter - a char that divides the columns in the source file, often a comma or tab
    
    Throws:
    
    java.io.IOException
  - createFromCsv
```
public static Table createFromCsv(ColumnType[] types,
                                  java.lang.String csvFileName)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    It is assumed that the file is truly comma-separated, and that the file has a one-line header, which is used to populate the column names
    
    Parameters:
    
    types - The column types
    
    csvFileName - The name of the file to import
    
    Throws:
    
    java.io.IOException
  - createFromCsv
```
public static Table createFromCsv(ColumnType[] types,
                                  java.lang.String csvFileName,
                                  boolean header)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    It is assumed that the file is truly comma-separated
    
    Parameters:
    
    types - The column types
    
    header - True if the file has a single header row. False if it has no header row. Multi-line headers are not supported
    
    csvFileName - the name of the file to import
    
    Throws:
    
    java.io.IOException
  - createFromCsv
```
public static Table createFromCsv(ColumnType[] types,
                                  java.lang.String csvFileName,
                                  boolean header,
                                  char delimiter)
                           throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    
    Parameters:
    
    types - The column types
    
    header - true if the file has a single header row. False if it has no header row. Multi-line headers are not supported
    
    delimiter - a char that divides the columns in the source file, often a comma or tab
    
    csvFileName - the name of the file to import
    
    Throws:
    
    java.io.IOException
  - createFromStream
```
public static Table createFromStream(ColumnType[] types,
                                     boolean header,
                                     char delimiter,
                                     java.io.InputStream stream,
                                     java.lang.String tableName)
                              throws java.io.IOException
```
    Returns a new table constructed from a character delimited (aka CSV) text file
    
    Parameters:
    
    types - The column types
    
    header - true if the file has a single header row. False if it has no header row. Multi-line headers are not supported
    
    delimiter - a char that divides the columns in the source file, often a comma or tab
    
    stream - an InputStream from a file, URL, etc.
    
    tableName - the name of the resulting table
    
    Throws:
    
    java.io.IOException
  - create
```
public static Table create(java.sql.ResultSet resultSet,
                           java.lang.String tableName)
                    throws java.sql.SQLException
```
    Returns a new Table with the given name, and containing the data in the given result set
    
    Throws:
    
    java.sql.SQLException
  - toString
```
public java.lang.String toString()
```
    Joins together this table and another table on the given column names. All the records of this table are included
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A new table derived from combining this table with other table
  - iterator
```
public it.unimi.dsi.fastutil.ints.IntIterator iterator()
```
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.ints.IntIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Integer>

Class Table

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.datavec.dataframe.table.Relation

Methods inherited from interface java.lang.Iterable

Constructor Detail

Table

Method Detail

create

create

create

addColumn

addColumn

setName

column

columnCount

rowCount

columns

columns

columnIndex

columnIndex

name

columnNames

get

fullCopy

emptyCopy

emptyCopy

sampleSplit

sample

clear

first

last

sortOn

sortAscendingOn

sortDescendingOn

getSort

sortOn

getComparator

sortOn

rows

selectWhere

selectIntoColumn

selectWhere

selectIntoColumn

splitOn

printHtml

structure

drop

drop

uniqueRecords

select

removeColumns

retainColumns

retainColumns

sum

mean

median

variance

stdDev

count

max

minimum

append

exportToCsv

save

readTable

reduce

summarize

countBy

createFromCsv

createFromCsv

createFromCsv

createFromCsv

createFromCsv

createFromCsv

createFromStream

create

toString

iterator