org.datavec.dataframe.table

Interface Relation

All Known Implementing Classes:

NumericSummaryTable, SubTable, Table, TemporaryView

public interface Relation

A tabular data structure like a table in a relational database, but not formally implementing the relational algebra

Method Summary

Modifier and Type	Method and Description
void	addColumn(Column... cols)
default BooleanColumn	booleanColumn(int columnIndex)
default BooleanColumn	booleanColumn(java.lang.String columnName)
default CategoryColumn	categoryColumn(int columnIndex)
default CategoryColumn	categoryColumn(java.lang.String columnName)
void	clear() Clears all the dat in the relation, leaving the structure intact
Column	column(int columnIndex) Returns the column at columnIndex (0-based)
default Column	column(java.lang.String columnName) Returns the column with the given columnName, ignoring case
int	columnCount() Returns the number of columns in the relation
int	columnIndex(Column col) Returns the index of the given column
default int	columnIndex(java.lang.String columnName) Returns the index of the column with the given columnName
java.util.List<java.lang.String>	columnNames()
java.util.List<Column>	columns() Returns a list of all the columns in the relation
default ColumnType[]	columnTypes() Returns an array of the column types of all columns in the relation, including duplicates as appropriate, and maintaining order
default int[]	colWidths() Returns an array of column widths for printing tables
default DateColumn	dateColumn(int columnIndex)
default DateColumn	dateColumn(java.lang.String columnName)
default DateTimeColumn	dateTimeColumn(int columnIndex)
default DateTimeColumn	dateTimeColumn(java.lang.String columnName)
Table	first(int nRows)
default FloatColumn	floatColumn(int columnIndex)
default FloatColumn	floatColumn(java.lang.String columnName)
java.lang.String	get(int c, int r) Returns a String representing the value found at column index c and row index r
default IntColumn	intColumn(int columnIndex)
default IntColumn	intColumn(java.lang.String columnName)
default boolean	isEmpty()
default LongColumn	longColumn(int columnIndex)
default LongColumn	longColumn(java.lang.String columnName)
java.lang.String	name() Returns the name of this relation
default NumericColumn	nCol(int columnIndex) Returns the column with the given name cast to a NumericColumn Shorthand for numericColumn()
default NumericColumn	nCol(java.lang.String columnName) Returns the column with the given name cast to a NumericColumn Shorthand for numericColumn()
default NumericColumn	numericColumn(int columnIndex)
default NumericColumn	numericColumn(java.lang.String columnName)
default java.lang.String	print()
default void	removeColumn(int columnIndex)
void	removeColumns(Column... columns) Removes the given columns from the receiver
default void	removeColumns(java.lang.String... columnName)
int	rowCount() Returns the number of rows in the relation
void	setName(java.lang.String name)
default java.lang.String	shape()
default ShortColumn	shortColumn(int columnIndex)
default ShortColumn	shortColumn(java.lang.String columnName)
default Table	structure()
default java.lang.String	summary()
default TimeColumn	timeColumn(int columnIndex)
default TimeColumn	timeColumn(java.lang.String columnName)

Method Detail

addColumn

void addColumn(Column... cols)

setName

void setName(java.lang.String name)

isEmpty

default boolean isEmpty()

shape

default java.lang.String shape()

removeColumn

default void removeColumn(int columnIndex)

removeColumns

void removeColumns(Column... columns)

Removes the given columns from the receiver

removeColumns

default void removeColumns(java.lang.String... columnName)

first

Table first(int nRows)

columnIndex

default int columnIndex(java.lang.String columnName)

Returns the index of the column with the given columnName

column

default Column column(java.lang.String columnName)

Returns the column with the given columnName, ignoring case

column

Column column(int columnIndex)

Returns the column at columnIndex (0-based)

Parameters:

columnIndex - an integer at least 0 and less than number of columns in the relation

Returns:

the column at the given index

columnCount

int columnCount()

Returns the number of columns in the relation

rowCount

int rowCount()

Returns the number of rows in the relation

columns

java.util.List<Column> columns()

Returns a list of all the columns in the relation

columnIndex

int columnIndex(Column col)

Returns the index of the given column

get

java.lang.String get(int c,
                     int r)

Returns a String representing the value found at column index c and row index r

name

java.lang.String name()

Returns the name of this relation

clear

void clear()

Clears all the dat in the relation, leaving the structure intact

columnNames

java.util.List<java.lang.String> columnNames()

columnTypes

default ColumnType[] columnTypes()

Returns an array of the column types of all columns in the relation, including duplicates as appropriate, and maintaining order

colWidths

default int[] colWidths()

Returns an array of column widths for printing tables

print

default java.lang.String print()

structure

default Table structure()

summary

default java.lang.String summary()

booleanColumn

default BooleanColumn booleanColumn(int columnIndex)

booleanColumn

default BooleanColumn booleanColumn(java.lang.String columnName)

numericColumn

default NumericColumn numericColumn(int columnIndex)

numericColumn

default NumericColumn numericColumn(java.lang.String columnName)

nCol

default NumericColumn nCol(java.lang.String columnName)

Returns the column with the given name cast to a NumericColumn Shorthand for numericColumn()

nCol

default NumericColumn nCol(int columnIndex)

Returns the column with the given name cast to a NumericColumn Shorthand for numericColumn()

floatColumn

default FloatColumn floatColumn(int columnIndex)

floatColumn

default FloatColumn floatColumn(java.lang.String columnName)

intColumn

default IntColumn intColumn(java.lang.String columnName)

intColumn

default IntColumn intColumn(int columnIndex)

shortColumn

default ShortColumn shortColumn(java.lang.String columnName)

shortColumn

default ShortColumn shortColumn(int columnIndex)

longColumn

default LongColumn longColumn(java.lang.String columnName)

longColumn

default LongColumn longColumn(int columnIndex)

dateColumn

default DateColumn dateColumn(int columnIndex)

dateColumn

default DateColumn dateColumn(java.lang.String columnName)

timeColumn

default TimeColumn timeColumn(java.lang.String columnName)

timeColumn

default TimeColumn timeColumn(int columnIndex)

categoryColumn

default CategoryColumn categoryColumn(java.lang.String columnName)

categoryColumn

default CategoryColumn categoryColumn(int columnIndex)

dateTimeColumn

default DateTimeColumn dateTimeColumn(int columnIndex)

dateTimeColumn

default DateTimeColumn dateTimeColumn(java.lang.String columnName)