Table (tablesaw-core 0.11.0 API)

java.lang.Object
- tech.tablesaw.table.Relation
- - tech.tablesaw.api.Table

All Implemented Interfaces:

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

Direct Known Subclasses:

NumericSummaryTable, SubTable
```
public class Table
extends Relation
implements 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(String name, Column... columns)
Returns a new Table initialized with the given names and columns

Constructors
Modifier	Constructor and Description
`protected`	`Table(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
`Table`	`addColumn(Column... cols)` Adds the given column to this table
`Table`	`addColumn(int index, Column column)` Adds the given column to this table at the given position in the column list
`double`	`agg(String numericColumnName, AggregateFunction function)` Returns the result of applying the given aggregate function to the specified column
`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(String columnName)` Returns the index of the column with the given name
`List<String>`	`columnNames()` Returns a List of the names of all the columns in this table
`List<Column>`	`columns()` Returns the list of columns
`List<Column>`	`columns(String... columnNames)` Returns only the columns whose names are given in the input array
`SummaryFunction`	`count(String numericColumnName)`
`Table`	`countBy(CategoryColumn column)`
`static Table`	`create(String tableName)` Returns a new, empty table (without rows or columns) with the given name
`static Table`	`create(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
`Table`	`dropRows(Collection<Integer> rows)` Returns a table with the given rows dropped
`Table`	`dropRows(int start, int end)` 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
`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
`String`	`get(int r, int c)` Returns a string representation of the value at the given row and column indexes
`Column`	`getAndRemoveColumn(int columnIndex)` Removes the given column from this table and returns it
`Column`	`getAndRemoveColumn(String columnName)` Removes the given column from this table and returns it
`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
`int`	`getFirst(Column column, String value)` Returns the first row for which the column `columnName` contains `value`, or null if there are no matches TODO(lwhite) This is a toy implementation badly in need of rewrite for performance.
`static Sort`	`getSort(String... columnNames)` Returns an object that can be used to sort this table in the order specified for by the given column names
`ViewGroup`	`groupBy(Column... columns)` The first stage of a split-apply-combine operation
`ViewGroup`	`groupBy(String... columns)` The first stage of a split-apply-combine operation
`it.unimi.dsi.fastutil.ints.IntIterator`	`iterator()`
`Table`	`last(int nRows)` Returns a new table containing the last `nrows` of data in this table
`SummaryFunction`	`max(String numericColumnName)`
`SummaryFunction`	`mean(String numericColumnName)`
`SummaryFunction`	`median(String numericColumnName)`
`SummaryFunction`	`min(String numericColumnName)`
`String`	`name()` Returns the name of the table
`String`	`printHtml()`
`static DataFrameReader`	`read()`
`static Table`	`readTable(String tableNameAndPath)`
`Table`	`removeColumns(Column... columns)` Removes the given columns
`void`	`retainColumns(Column... columns)` Removes the given columns from this table
`void`	`retainColumns(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
`String`	`save(String folder)`
`Projection`	`select(String... columnName)`
`BooleanColumn`	`selectIntoColumn(String newColumnName, Filter filter)`
`BooleanColumn`	`selectIntoColumn(String newColumnName, Selection selection)`
`Table`	`selectRows(Collection<Integer> rows)` Returns a table with the given rows selected
`Table`	`selectRows(int start, int end)` Returns a table with the given rows selected
`Table`	`selectWhere(Filter filter)`
`Table`	`selectWhere(Selection selection)`
`Table`	`setName(String name)` Sets the name of the table
`Table`	`sortAscendingOn(String... columnNames)` Returns a copy of this table sorted in the order of the given column names, in ascending order
`Table`	`sortDescendingOn(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(String... columnNames)` Returns a copy of this table sorted on the given column names, applied in order,
`ViewGroup`	`splitOn(Column... columns)` Synonymous with groupBy The first stage of a split-apply-combine operation
`ViewGroup`	`splitOn(String... columns)` Synonymous with groupBy The first stage of a split-apply-combine operation
`SummaryFunction`	`stdDev(String numericColumnName)`
`Table`	`structure()`
`SummaryFunction`	`sum(String numericColumnName)`
`SummaryFunction`	`summarize(String numericColumnName, AggregateFunction function)`
`Table`	`uniqueRecords()` Returns the unique records in this table Note: Uses a lot of memory for a sort
`SummaryFunction`	`variance(String numericColumnName)`
`DataFrameWriter`	`write()`

Methods inherited from class tech.tablesaw.table.Relation
booleanColumn, booleanColumn, categoryColumn, categoryColumn, column, columnTypes, colWidths, dateColumn, dateColumn, dateTimeColumn, dateTimeColumn, doubleColumn, doubleColumn, floatColumn, floatColumn, intColumn, intColumn, isEmpty, longColumn, longColumn, nCol, nCol, numericColumn, numericColumn, print, print, removeColumn, removeColumns, shape, shortColumn, shortColumn, summary, timeColumn, timeColumn, toString

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

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

- Constructor Detail
  - Table
```
protected Table(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(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(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()}
  - getSort
```
public static Sort getSort(String... columnNames)
```
    Returns an object that can be used to sort this table in the order specified for by the given column names
  - readTable
```
public static Table readTable(String tableNameAndPath)
```
  - read
```
public static DataFrameReader read()
```
  - write
```
public DataFrameWriter write()
```
  - addColumn
```
public Table addColumn(Column... cols)
```
    Adds the given column to this table
    
    Specified by:
    
    addColumn in class Relation
  - addColumn
```
public Table 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 Table setName(String name)
```
    Sets the name of the table
    
    Specified by:
    
    setName in class Relation
  - column
```
public Column column(int columnIndex)
```
    Returns the column at the given index in the column list
    
    Specified by:
    
    column in class 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 class Relation
  - rowCount
```
public int rowCount()
```
    Returns the number of rows in the table
    
    Specified by:
    
    rowCount in class Relation
  - columns
```
public List<Column> columns()
```
    Returns the list of columns
    
    Specified by:
    
    columns in class Relation
  - columns
```
public List<Column> columns(String... columnNames)
```
    Returns only the columns whose names are given in the input array
  - columnIndex
```
public int columnIndex(String columnName)
```
    Returns the index of the column with the given name
    
    Overrides:
    
    columnIndex in class Relation
    
    Throws:
    
    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 class Relation
    
    Throws:
    
    IllegalArgumentException - if the column is not present in this table
  - name
```
public String name()
```
    Returns the name of the table
    
    Specified by:
    
    name in class Relation
  - columnNames
```
public List<String> columnNames()
```
    Returns a List of the names of all the columns in this table
    
    Specified by:
    
    columnNames in class Relation
  - get
```
public String get(int r,
                  int c)
```
    Returns a string representation of the value at the given row and column indexes
    
    Specified by:
    
    get in class Relation
    
    Parameters:
    
    r - the row index, 0 based
    
    c - the column index, 0 based
  - fullCopy
```
public Table fullCopy()
```
    Returns a table with the same columns as this table
  - 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 class Relation
  - first
```
public Table first(int nRows)
```
    Returns a new table containing the first nrows of data in this table
    
    Specified by:
    
    first in class Relation
  - last
```
public Table last(int nRows)
```
    Returns a new table containing the last nrows of data in this table
  - sortOn
```
public Table sortOn(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(String... columnNames)
```
    Returns a copy of this table sorted in the order of the given column names, in ascending order
  - sortDescendingOn
```
public Table sortDescendingOn(String... columnNames)
```
    Returns a copy of this table sorted on the given column names, applied in order, descending
  - 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(String newColumnName,
                                      Selection selection)
```
  - selectWhere
```
public Table selectWhere(Filter filter)
```
  - selectIntoColumn
```
public BooleanColumn selectIntoColumn(String newColumnName,
                                      Filter filter)
```
  - groupBy
```
public ViewGroup groupBy(String... columns)
```
    The first stage of a split-apply-combine operation
  - groupBy
```
public ViewGroup groupBy(Column... columns)
```
    The first stage of a split-apply-combine operation
  - splitOn
```
public ViewGroup splitOn(String... columns)
```
    Synonymous with groupBy The first stage of a split-apply-combine operation
  - splitOn
```
public ViewGroup splitOn(Column... columns)
```
    Synonymous with groupBy The first stage of a split-apply-combine operation
  - printHtml
```
public String printHtml()
```
  - structure
```
public Table structure()
```
    Overrides:
    
    structure in class Relation
  - selectRows
```
public Table selectRows(Collection<Integer> rows)
```
    Returns a table with the given rows selected
    
    Parameters:
    
    rows - the rows to select
    
    Returns:
    
    the table with the selected rows
  - selectRows
```
public Table selectRows(int start,
                        int end)
```
    Returns a table with the given rows selected
    
    Parameters:
    
    start - the first row to select
    
    end - the last row to select
    
    Returns:
    
    the table with the selected rows
  - dropRows
```
public Table dropRows(Collection<Integer> rows)
```
    Returns a table with the given rows dropped
    
    Parameters:
    
    rows - the rows to drop
    
    Returns:
    
    the table with the dropped rows
  - dropRows
```
public Table dropRows(int start,
                      int end)
```
    Returns a table with the given rows dropped
    
    Parameters:
    
    start - the first row to drop
    
    end - the last row 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(String... columnName)
```
  - removeColumns
```
public Table removeColumns(Column... columns)
```
    Removes the given columns
    
    Specified by:
    
    removeColumns in class Relation
  - getAndRemoveColumn
```
public Column getAndRemoveColumn(String columnName)
```
    Removes the given column from this table and returns it
    
    Throws:
    
    IllegalStateException - if the given columnName does not match the name of a column in the table
  - getAndRemoveColumn
```
public Column getAndRemoveColumn(int columnIndex)
```
    Removes the given column from this table and returns it
    
    Throws:
    
    IndexOutOfBoundsException - if the given columnIndex does not match any column in the table
  - retainColumns
```
public void retainColumns(Column... columns)
```
    Removes the given columns from this table
  - retainColumns
```
public void retainColumns(String... columnNames)
```
  - sum
```
public SummaryFunction sum(String numericColumnName)
```
  - mean
```
public SummaryFunction mean(String numericColumnName)
```
  - median
```
public SummaryFunction median(String numericColumnName)
```
  - variance
```
public SummaryFunction variance(String numericColumnName)
```
  - stdDev
```
public SummaryFunction stdDev(String numericColumnName)
```
  - count
```
public SummaryFunction count(String numericColumnName)
```
  - max
```
public SummaryFunction max(String numericColumnName)
```
  - min
```
public SummaryFunction min(String numericColumnName)
```
  - append
```
public void append(Table tableToAppend)
```
  - save
```
public String save(String folder)
```
  - agg
```
public double agg(String numericColumnName,
                  AggregateFunction function)
```
    Returns the result of applying the given aggregate function to the specified column
    
    Parameters:
    
    numericColumnName - The name of a numeric (integer, float, etc.) column in this table
    
    function - An aggregation function
    
    Returns:
    
    the function result
    
    Throws:
    
    IllegalArgumentException - if numericColumnName doesn't name a numeric column in this table
  - summarize
```
public SummaryFunction summarize(String numericColumnName,
                                 AggregateFunction function)
```
  - countBy
```
public Table countBy(CategoryColumn column)
```
  - getFirst
```
public int getFirst(Column column,
                    String value)
```
    Returns the first row for which the column columnName contains value, or null if there are no matches TODO(lwhite) This is a toy implementation badly in need of rewrite for performance.
  - 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 Iterable<Integer>

Class Table

Constructor Summary

Method Summary

Methods inherited from class tech.tablesaw.table.Relation

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Table

Method Detail

create

create

create

getSort

readTable

read

write

addColumn

addColumn

setName

column

columnCount

rowCount

columns

columns

columnIndex

columnIndex

name

columnNames

get

fullCopy

emptyCopy

emptyCopy

sampleSplit

sample

clear

first

last

sortOn

sortAscendingOn

sortDescendingOn

sortOn

getComparator

sortOn

rows

selectWhere

selectIntoColumn

selectWhere

selectIntoColumn

groupBy

groupBy

splitOn

splitOn

printHtml

structure

selectRows

selectRows

dropRows

dropRows

uniqueRecords

select

removeColumns

getAndRemoveColumn

getAndRemoveColumn

retainColumns

retainColumns

sum

mean

median

variance

stdDev

count

max

min

append

save

agg

summarize

countBy

getFirst

iterator