DataFrame (DataFrame 0.6.1 API)

java.lang.Object
- de.unknownreality.dataframe.DataFrame

All Implemented Interfaces:

DataContainer<DataFrameHeader,DataRow>, RowIterator<DataRow>, Iterable<DataRow>

Direct Known Subclasses:

DataGroup, JoinedDataFrame
```
public class DataFrame
extends Object
implements DataContainer<DataFrameHeader,DataRow>
```
Created by Alex on 09.03.2016.

Field Summary

Fields
Modifier and Type Field and Description

static String PRIMARY_INDEX_NAME

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

Constructor Summary

Constructors
Constructor and Description
`DataFrame()`
`DataFrame(DataFrameHeader header, Collection<DataRow> rows)` Creates a new data frame using a data frame header and a collections of data rows

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrame`	`addColumn(Class<C> type, String name, ColumnAppender<T> appender)` Creates and adds a column to this data frame based on a provided column class.
`<T extends Comparable<T>> DataFrame`	`addColumn(Class<T> type, String name)` Creates a column for a specified column value type using the default `ColumnTypeMap`.
`<T extends Comparable<T>> DataFrame`	`addColumn(Class<T> type, String name, ColumnTypeMap columnTypeMap)` Creates a column for a specified column value type using the provided `ColumnTypeMap`.
`<T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrame`	`addColumn(Class<T> type, String name, ColumnTypeMap columnTypeMap, ColumnAppender<T> appender)` Creates and adds a new column based on a specified column value type and a `ColumnTypeMap`.
`DataFrame`	`addColumn(DataFrameColumn column)` Adds a column to the data frame.
`DataFrame`	`addColumns(Collection<DataFrameColumn> columns)` Adds a collection of columns to this data frame
`DataFrame`	`addColumns(DataFrameColumn... columns)` Adds an array of columns to this data frame
`DataFrame`	`addIndex(String indexName, DataFrameColumn... columns)` Adds a new index based on one or multiple index columns.
`DataFrame`	`addIndex(String indexName, String... columnNames)` Adds a new index based on one or multiple index columns.
`DataFrame`	`append(Comparable... values)` Appends a new row based on `Comparable` values.
`DataFrame`	`append(DataRow row)` Appends a new data row.
`DataFrame`	`concat(Collection<DataFrame> dataFrames)` Appends the rows from a collection of data frames to this data frame.
`DataFrame`	`concat(DataFrame... dataFrames)` Appends the rows from an array of data frames to this data frame.
`DataFrame`	`concat(DataFrame other)` Concatenates two data frames.
`boolean`	`containsColumn(DataFrameColumn column)` Returns `true` if this data frame contains the input column
`DataFrame`	`copy()` Returns a copy of this data frame.
`DataFrame`	`createSubset(int from, int to)` Creates a new data frame from a subset of this data frame.
`boolean`	`equals(Object o)`
`DataFrame`	`filter(FilterPredicate predicate)` Filters data rows that are not valid according to an input predicate.
`DataFrame`	`filter(String predicateString)` Filters data rows that are not valid according to an input predicate.
`DataFrame`	`find(FilterPredicate predicate)` Deprecated. use `select(FilterPredicate)` instead.
`DataFrame`	`find(String colName, Comparable value)` Deprecated. use `select(String,Comparable)` instead.
`List<DataRow>`	`findByIndex(String name, Comparable... values)` Finds matching data rows using an index and the corresponding index values
`DataRow`	`findByPrimaryKey(Comparable... keyValues)` Finds a data row using the primary key
`DataRow`	`findFirst(FilterPredicate predicate)` Deprecated. use `selectFirst(FilterPredicate)` instead.
`DataRow`	`findFirst(String colName, Comparable value)` Deprecated. use `selectFirst(String,Comparable)` instead.
`DataRow`	`findFirstByIndex(String name, Comparable... values)` Finds the first data row matching an index and the corresponding index values
`List<DataRow>`	`findRows(FilterPredicate predicate)` Deprecated. use `selectRows(FilterPredicate)` instead.
`BooleanColumn`	`getBooleanColumn(String name)` Returns a `BooleanColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`ByteColumn`	`getByteColumn(String name)` Returns a `ByteColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`DataFrameColumn`	`getColumn(String name)` Returns a column based on its name
`<T extends DataFrameColumn> T`	`getColumn(String name, Class<T> cl)` Returns a column as a specified column type.
`Collection<String>`	`getColumnNames()` Returns a collection of the column names in this data frame
`Collection<DataFrameColumn>`	`getColumns()` Returns a collection of all columns in this data frame
`DoubleColumn`	`getDoubleColumn(String name)` Returns a `DoubleColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`FloatColumn`	`getFloatColumn(String name)` Returns a `FloatColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`DataFrameHeader`	`getHeader()` Returns the header of this data frame
`protected Indices`	`getIndices()` Returns the indices of this data frame
`IntegerColumn`	`getIntegerColumn(String name)` Returns a `IntegerColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`LongColumn`	`getLongColumn(String name)` Returns a `LongColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`NumberColumn`	`getNumberColumn(String name)` Returns a `NumberColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`DataRow`	`getRow(int i)` Returns the data row at a specified index
`List<DataRow>`	`getRows()` Returns all rows in this data frame
`List<DataRow>`	`getRows(int from, int to)` Returns a list the list of rows between `from` and `to`.
`Comparable[]`	`getRowValues(int i)` Returns the values of a row at a specified index
`ShortColumn`	`getShortColumn(String name)` Returns a `ShortColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`StringColumn`	`getStringColumn(String name)` Returns a `StringColumn` If the column is not found or has the wrong type a `DataFrameRuntimeException` is thrown.
`DataGrouping`	`groupBy(String... column)` Groups this data frame using one or more columns
`boolean`	`isCompatible(DataFrame input)` Returns `true` if the header of an input data frame equals the header of this data frame.
`boolean`	`isIndexColumn(DataFrameColumn column)` Returns `true` if the input column is part of at least one index
`Iterator<DataRow>`	`iterator()` Returns an iterator over the rows in this data frame.
`JoinedDataFrame`	`joinInner(DataFrame dataFrame, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `INNER JOIN` method.
`JoinedDataFrame`	`joinInner(DataFrame dataFrame, String... joinColumns)` Joins this data frame with another data frame using the `INNER JOIN` method.
`JoinedDataFrame`	`joinInner(DataFrame dataFrame, String suffixA, String suffixB, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `INNER JOIN` method.
`JoinedDataFrame`	`joinLeft(DataFrame dataFrame, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `LEFT JOIN` method.
`JoinedDataFrame`	`joinLeft(DataFrame dataFrame, String... joinColumns)` Joins this data frame with another data frame using the `LEFT JOIN` method.
`JoinedDataFrame`	`joinLeft(DataFrame dataFrame, String suffixA, String suffixB, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `LEFT JOIN` method.
`JoinedDataFrame`	`joinRight(DataFrame dataFrame, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `LEFT JOIN` method.
`JoinedDataFrame`	`joinRight(DataFrame dataFrame, String... joinColumns)` Joins this data frame with another data frame using the `RIGHT JOIN` method.
`JoinedDataFrame`	`joinRight(DataFrame dataFrame, String suffixA, String suffixB, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `RIGHT JOIN` method.
`<T> List<T>`	`map(Class<T> cl)` Maps this data container to a list of entities.
`protected void`	`notifyColumnChanged(DataFrameColumn column)` Notifies this data frame about a changed column.
`protected void`	`notifyColumnValueChanged(DataFrameColumn column, int index, Comparable value)` Notifies this data frame about a changed value in a column.
`DataFrame`	`removeColumn(DataFrameColumn column)` Removes a column from this data frame
`DataFrame`	`removeColumn(String header)` Removes a column from this data frame
`DataFrame`	`removeIndex(String name)` Removes the index with the specified name
`DataFrame`	`removePrimaryKey()` Removes the current primary key
`DataFrame`	`renameColumn(String name, String newName)` Renames a column
`DataFrame`	`reverse()` Reverses all columns
`DataFrame`	`select(FilterPredicate predicate)` Returns a new data frame based on filtered rows from this data frame.
`DataFrame`	`select(String predicateString)` Returns a new data frame based on filtered rows from this data frame.
`DataFrame`	`select(String colName, Comparable value)` Returns a new data frame with all rows from this data frame where a specified column value equals an input value.
`DataRow`	`selectFirst(FilterPredicate predicate)` Returns the first found data row from this data frame matching an input predicate.
`DataRow`	`selectFirst(String predicateString)` Returns the first found data row from this data frame matching an input predicate.
`DataRow`	`selectFirst(String colName, Comparable value)` Returns the first found data row from this data frame where a specified column value equals an input value.
`List<DataRow>`	`selectRows(FilterPredicate predicate)` Finds data rows using a `FilterPredicate`.
`List<DataRow>`	`selectRows(String predicateString)` Finds data rows using a `FilterPredicate`.
`DataFrame`	`set(Collection<DataRow> rows)` Clears all rows in this data frame and sets new rows using the provided `DataRow` collection.
`DataFrame`	`set(DataFrameHeader header, Collection<DataRow> rows)` Removes all columns and rows from this data frame.
`DataFrame`	`setPrimaryKey(DataFrameColumn... cols)` Sets the primary key columns using column objects
`DataFrame`	`setPrimaryKey(String... colNames)` Sets the primary key columns using column names
`DataFrame`	`shuffle()` Shuffles all rows
`int`	`size()` Returns the number of rows in this data frame
`DataFrame`	`sort(Comparator<DataRow> comp)` Sorts the rows in this data frame using a custom `Comparator`
`DataFrame`	`sort(SortColumn... columns)` Sorts the rows in this data frame by one or more `SortColumn`
`DataFrame`	`sort(String name)` Sorts the rows in this data frame using one column and the default sort direction (`ascending`)
`DataFrame`	`sort(String name, SortColumn.Direction dir)` Sorts the rows in this data frame using one column and sort direction.
`DataFrame`	`subset(int from, int to)` Sets this data frame to a subset of itself.
`DataFrame`	`transform(DataFrameTransform transformer)` Converts this dataframe into another dataframe using a specified transformer
`DataFrame`	`update(DataRow dataRow)` Persists the updated values of a data row.

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

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

- Field Detail
  - PRIMARY_INDEX_NAME
```
public static final String PRIMARY_INDEX_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataFrame
```
public DataFrame()
```
  - DataFrame
```
public DataFrame(DataFrameHeader header,
                 Collection<DataRow> rows)
```
    Creates a new data frame using a data frame header and a collections of data rows
    
    Parameters:
    
    header - data frame header
    
    rows - collections of data rows
- Method Detail
  - setPrimaryKey
```
public DataFrame setPrimaryKey(String... colNames)
```
    Sets the primary key columns using column names
    
    Parameters:
    
    colNames - primary key columns
    
    Returns:
    
    self for method chaining
  - setPrimaryKey
```
public DataFrame setPrimaryKey(DataFrameColumn... cols)
```
    Sets the primary key columns using column objects
    
    Parameters:
    
    cols - primary key columns
    
    Returns:
    
    self for method chaining
  - removePrimaryKey
```
public DataFrame removePrimaryKey()
```
    Removes the current primary key
    
    Returns:
    
    self for method chaining
  - removeIndex
```
public DataFrame removeIndex(String name)
```
    Removes the index with the specified name
    
    Parameters:
    
    name - name of index
    
    Returns:
    
    self for method chaining
  - renameColumn
```
public DataFrame renameColumn(String name,
                              String newName)
```
    Renames a column
    
    Parameters:
    
    name - current column name
    
    newName - new column name
    
    Returns:
    
    self for method chaining
  - addColumn
```
public DataFrame addColumn(DataFrameColumn column)
```
    Adds a column to the data frame. If the column is already part of another data frame a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    column - column to add
    
    Returns:
    
    self for method chaining
  - addColumn
```
public <T extends Comparable<T>> DataFrame addColumn(Class<T> type,
                                                     String name)
```
    Creates a column for a specified column value type using the default ColumnTypeMap.
    
    Type Parameters:
    
    T - type of column values
    
    Parameters:
    
    type - class of column values
    
    name - column name
    
    Returns:
    
    self for method chaining
  - addColumn
```
public <T extends Comparable<T>> DataFrame addColumn(Class<T> type,
                                                     String name,
                                                     ColumnTypeMap columnTypeMap)
```
    Creates a column for a specified column value type using the provided ColumnTypeMap.
    
    Type Parameters:
    
    T - type of column values
    
    Parameters:
    
    type - class of column values
    
    name - column name
    
    columnTypeMap - provided column type map
    
    Returns:
    
    self for method chaining
    
    See Also:
    
    addColumn(Class, String, ColumnAppender)
  - addColumn
```
public <T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrame addColumn(Class<T> type,
                                                                                    String name,
                                                                                    ColumnTypeMap columnTypeMap,
                                                                                    ColumnAppender<T> appender)
```
    Creates and adds a new column based on a specified column value type and a ColumnTypeMap.
    
    Type Parameters:
    
    T - type of column values
    
    C - type of created column
    
    Parameters:
    
    type - column value value type
    
    name - name of new column
    
    columnTypeMap - column type map (value type / column class mapper)
    
    appender - column appender (value generator)
    
    Returns:
    
    self for method chaining
    
    See Also:
    
    addColumn(Class, String, ColumnAppender)
  - addColumn
```
public <T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrame addColumn(Class<C> type,
                                                                                    String name,
                                                                                    ColumnAppender<T> appender)
```
    Creates and adds a column to this data frame based on a provided column class. The values in the created column are generated by a ColumnAppender. If no column appender is specified, the column is filled with NA values. If the column can not be created or added a DataFrameRuntimeException is thrown.
    
    Type Parameters:
    
    T - type of column values
    
    C - type of created column
    
    Parameters:
    
    type - class of created column
    
    name - name of created column
    
    appender - column appender (value generator)
    
    Returns:
    
    self for method chaining
    
    See Also:
    
    addColumn(DataFrameColumn)
  - addColumns
```
public DataFrame addColumns(Collection<DataFrameColumn> columns)
```
    Adds a collection of columns to this data frame
    
    Parameters:
    
    columns - columns to add
    
    Returns:
    
    self for method chaining
  - addColumns
```
public DataFrame addColumns(DataFrameColumn... columns)
```
    Adds an array of columns to this data frame
    
    Parameters:
    
    columns - columns to add
    
    Returns:
    
    self for method chaining
  - append
```
public DataFrame append(Comparable... values)
```
    Appends a new row based on Comparable values.
    There must be exactly one value for each column.
    
    The object types have to match the column types.
    If the wrong number of values or a wrong type is found a DataFrameRuntimeException is thrown.
    If the data frame contains:
    StringColumn,DoubleColumn,IntegerColumn
    The only correct call to this method is:
    append(String, Double, Integer)
    
    empty column values must be provided as null or NA
    
    Parameters:
    
    values - values for the appended row
    
    Returns:
    
    self for method chaining
  - append
```
public DataFrame append(DataRow row)
```
    Appends a new data row. NA is added for all columns with no value in the provided row.
    
    Parameters:
    
    row - row containing the new values
    
    Returns:
    
    self for method chaining
  - update
```
public DataFrame update(DataRow dataRow)
```
    Persists the updated values of a data row. null values are ignored. Use NA instead-
    
    Parameters:
    
    dataRow - data row with updated values
    
    Returns:
    
    self for method chaining
  - set
```
public DataFrame set(Collection<DataRow> rows)
```
    Clears all rows in this data frame and sets new rows using the provided DataRow collection.
    
    Parameters:
    
    rows - new collection of rows
    
    Returns:
    
    self for method chaining
  - set
```
public DataFrame set(DataFrameHeader header,
                     Collection<DataRow> rows)
```
    Removes all columns and rows from this data frame. New columns are created using the specified data frame header an populated with the provided data rows.
    
    Parameters:
    
    header - new header
    
    rows - new rows
    
    Returns:
    
    self for method chaining
  - removeColumn
```
public DataFrame removeColumn(String header)
```
    Removes a column from this data frame
    
    Parameters:
    
    header - column header name
    
    Returns:
    
    self for method chaining
  - removeColumn
```
public DataFrame removeColumn(DataFrameColumn column)
```
    Removes a column from this data frame
    
    Parameters:
    
    column - column to remove
    
    Returns:
    
    self for method chaining
  - sort
```
public DataFrame sort(SortColumn... columns)
```
    Sorts the rows in this data frame by one or more SortColumn
    
    Parameters:
    
    columns - sort columns
    
    Returns:
    
    self for method chaining
  - sort
```
public DataFrame sort(Comparator<DataRow> comp)
```
    Sorts the rows in this data frame using a custom Comparator
    
    Parameters:
    
    comp - comparator used to sort the rows
    
    Returns:
    
    self for method chaining
  - sort
```
public DataFrame sort(String name)
```
    Sorts the rows in this data frame using one column and the default sort direction (ascending)
    
    Parameters:
    
    name - sort column
    
    Returns:
    
    self for method chaining
  - sort
```
public DataFrame sort(String name,
                      SortColumn.Direction dir)
```
    Sorts the rows in this data frame using one column and sort direction.
    
    Parameters:
    
    name - sort column
    
    dir - sort direction
    
    Returns:
    
    self for method chaining
  - shuffle
```
public DataFrame shuffle()
```
    Shuffles all rows
    
    Returns:
    
    self for method chaining
  - select
```
public DataFrame select(String colName,
                        Comparable value)
```
    Returns a new data frame with all rows from this data frame where a specified column value equals an input value.
    
    Parameters:
    
    colName - column name
    
    value - input value
    
    Returns:
    
    new data frame including the found rows
  - selectFirst
```
public DataRow selectFirst(String colName,
                           Comparable value)
```
    Returns the first found data row from this data frame where a specified column value equals an input value.
    
    Parameters:
    
    colName - column name
    
    value - input value
    
    Returns:
    
    first found data row
  - selectFirst
```
public DataRow selectFirst(String predicateString)
```
    Returns the first found data row from this data frame matching an input predicate.
    
    Parameters:
    
    predicateString - input predicate string
    
    Returns:
    
    first found data row
    
    See Also:
    
    select(FilterPredicate)
  - selectFirst
```
public DataRow selectFirst(FilterPredicate predicate)
```
    Returns the first found data row from this data frame matching an input predicate.
    
    Parameters:
    
    predicate - input predicate
    
    Returns:
    
    first found data row
    
    See Also:
    
    select(FilterPredicate)
  - select
```
public DataFrame select(FilterPredicate predicate)
```
    Returns a new data frame based on filtered rows from this data frame.
    Rows that are valid according to the input predicate remain in the new data frame.
    
    if(predicate.valid(row)) -> add(row)
    
    Parameters:
    
    predicate - filter predicate
    
    Returns:
    
    new data frame including the found row
    
    See Also:
    
    filter(FilterPredicate)
  - select
```
public DataFrame select(String predicateString)
```
    Returns a new data frame based on filtered rows from this data frame.
    Rows that are valid according to the input predicate remain in the new data frame.
    The predicate is compiled from the input string.
    
    if(predicate.valid(row)) -> add(row)
    
    Parameters:
    
    predicateString - predicate string
    
    Returns:
    
    new data frame including the found row
    
    See Also:
    
    select(FilterPredicate)
  - find
```
@Deprecated
public DataFrame find(String colName,
                                   Comparable value)
```
    Deprecated. use select(String,Comparable) instead.
    
    Returns a new data frame with all rows from this data frame where a specified column value equals an input value.
    
    Parameters:
    
    colName - column name
    
    value - input value
    
    Returns:
    
    new data frame including the found rows
  - findFirst
```
@Deprecated
public DataRow findFirst(String colName,
                                      Comparable value)
```
    Deprecated. use selectFirst(String,Comparable) instead.
    
    Returns the first found data row from this data frame where a specified column value equals an input value.
    
    Parameters:
    
    colName - column name
    
    value - input value
    
    Returns:
    
    first found data row
  - findFirst
```
@Deprecated
public DataRow findFirst(FilterPredicate predicate)
```
    Deprecated. use selectFirst(FilterPredicate) instead.
    
    Returns the first found data row from this data frame matching an input predicate.
    
    Parameters:
    
    predicate - input predicate
    
    Returns:
    
    first found data row
  - filter
```
public DataFrame filter(String predicateString)
```
    Filters data rows that are not valid according to an input predicate.
    Data rows are filtered by their column values.
    If a data row is filtered if it is not valid according to the predicate.
    The filtered data rows are removed from this data frame.
    
    if(!predicate.valid(row)) -> remove(row)
    
    Parameters:
    
    predicateString - filter predicate string
    
    Returns:
    
    self for method chaining
  - filter
```
public DataFrame filter(FilterPredicate predicate)
```
    Filters data rows that are not valid according to an input predicate.
    Data rows are filtered by their column values.
    If a data row is filtered if it is not valid according to the predicate.
    The filtered data rows are removed from this data frame.
    
    if(!predicate.valid(row)) -> remove(row)
    
    Parameters:
    
    predicate - filter predicate
    
    Returns:
    
    self for method chaining
  - find
```
@Deprecated
public DataFrame find(FilterPredicate predicate)
```
    Deprecated. use select(FilterPredicate) instead.
    
    Returns a new data frame based on filtered rows from this data frame.
    Rows that are valid according to the input predicate remain in the new data frame.
    
    if(predicate.valid(row)) -> add(row)
    
    Parameters:
    
    predicate - filter predicate
    
    Returns:
    
    new data frame including the found row
    
    See Also:
    
    filter(FilterPredicate)
  - selectRows
```
public List<DataRow> selectRows(String predicateString)
```
    Finds data rows using a FilterPredicate.
    
    Parameters:
    
    predicateString - input predicate string
    
    Returns:
    
    list of found data rows
  - selectRows
```
public List<DataRow> selectRows(FilterPredicate predicate)
```
    Finds data rows using a FilterPredicate.
    
    Parameters:
    
    predicate - input predicate
    
    Returns:
    
    list of found data rows
  - findRows
```
@Deprecated
public List<DataRow> findRows(FilterPredicate predicate)
```
    Deprecated. use selectRows(FilterPredicate) instead.
    
    Finds data rows using a FilterPredicate.
    
    Parameters:
    
    predicate - input predicate
  - transform
```
public DataFrame transform(DataFrameTransform transformer)
```
    Converts this dataframe into another dataframe using a specified transformer
    
    Parameters:
    
    transformer - the applied transformer
    
    Returns:
    
    resulting dataframe
  - findByPrimaryKey
```
public DataRow findByPrimaryKey(Comparable... keyValues)
```
    Finds a data row using the primary key
    
    Parameters:
    
    keyValues - input key values
    
    Returns:
    
    found data row
  - reverse
```
public DataFrame reverse()
```
    Reverses all columns
    
    Returns:
    
    self for method chaining
  - addIndex
```
public DataFrame addIndex(String indexName,
                          String... columnNames)
```
    Adds a new index based on one or multiple index columns.
    Values in index columns must be unique for all rows
    
    Parameters:
    
    indexName - name of new index
    
    columnNames - index columns
    
    Returns:
    
    self for method chaining
  - addIndex
```
public DataFrame addIndex(String indexName,
                          DataFrameColumn... columns)
```
    Adds a new index based on one or multiple index columns.
    Values in index columns must be unique for all rows
    
    Parameters:
    
    indexName - name of new index
    
    columns - index columns
    
    Returns:
    
    self for method chaining
  - size
```
public int size()
```
    Returns the number of rows in this data frame
    
    Returns:
    
    number of rows
  - subset
```
public DataFrame subset(int from,
                        int to)
```
    Sets this data frame to a subset of itself. Only rows between from and to remain in this data frame
    
    Parameters:
    
    from - lowest remaining row index
    
    to - highest remaining row index
    
    Returns:
    
    self for method chaining
  - createSubset
```
public DataFrame createSubset(int from,
                              int to)
```
    Creates a new data frame from a subset of this data frame. Rows between from and to are added to the new data frame.
    
    Parameters:
    
    from - lowest row index
    
    to - highest row index
    
    Returns:
    
    created subset data frame
  - getRows
```
public List<DataRow> getRows(int from,
                             int to)
```
    Returns a list the list of rows between from and to.
    
    Parameters:
    
    from - lowest row index
    
    to - highest row index
    
    Returns:
    
    list of rows between from and to
  - getRows
```
public List<DataRow> getRows()
```
    Returns all rows in this data frame
    
    Returns:
    
    list of all rows
  - getHeader
```
public DataFrameHeader getHeader()
```
    Returns the header of this data frame
    
    Specified by:
    
    getHeader in interface DataContainer<DataFrameHeader,DataRow>
    
    Returns:
    
    data frame header
  - concat
```
public DataFrame concat(DataFrame other)
```
    Concatenates two data frames. The rows from the other data frame are appended to this data frame. Throws a DataFrameRuntimeException if the data frames are not compatible.
    
    Parameters:
    
    other - other data frame
    
    Returns:
    
    self for method chaining
  - concat
```
public DataFrame concat(Collection<DataFrame> dataFrames)
```
    Appends the rows from a collection of data frames to this data frame. Throws a DataFrameRuntimeException if the data frames are not compatible.
    
    Parameters:
    
    dataFrames - other data frames
    
    Returns:
    
    self for method chaining
  - concat
```
public DataFrame concat(DataFrame... dataFrames)
```
    Appends the rows from an array of data frames to this data frame. Throws a DataFrameRuntimeException if the data frames are not compatible.
    
    Parameters:
    
    dataFrames - other data frames
    
    Returns:
    
    self for method chaining
  - isCompatible
```
public boolean isCompatible(DataFrame input)
```
    Returns true if the header of an input data frame equals the header of this data frame.
    
    Parameters:
    
    input - input data frame
    
    Returns:
    
    true if the other data frame is compatible with this data frame.
    
    See Also:
    
    BasicTypeHeader.equals(Object)
  - getRow
```
public DataRow getRow(int i)
```
    Returns the data row at a specified index
    
    Parameters:
    
    i - index of data row
    
    Returns:
    
    data row at specified index
  - getRowValues
```
public Comparable[] getRowValues(int i)
```
    Returns the values of a row at a specified index
    
    Parameters:
    
    i - index of data row
    
    Returns:
    
    values in data row
  - getColumnNames
```
public Collection<String> getColumnNames()
```
    Returns a collection of the column names in this data frame
    
    Returns:
    
    column names
  - getColumn
```
public DataFrameColumn getColumn(String name)
```
    Returns a column based on its name
    
    Parameters:
    
    name - column name
    
    Returns:
    
    column
  - getColumn
```
public <T extends DataFrameColumn> T getColumn(String name,
                                               Class<T> cl)
```
    Returns a column as a specified column type. If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Type Parameters:
    
    T - type of column
    
    Parameters:
    
    name - column name
    
    cl - class of column
    
    Returns:
    
    found column
  - getNumberColumn
```
public NumberColumn getNumberColumn(String name)
```
    Returns a NumberColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getStringColumn
```
public StringColumn getStringColumn(String name)
```
    Returns a StringColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getDoubleColumn
```
public DoubleColumn getDoubleColumn(String name)
```
    Returns a DoubleColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getIntegerColumn
```
public IntegerColumn getIntegerColumn(String name)
```
    Returns a IntegerColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getFloatColumn
```
public FloatColumn getFloatColumn(String name)
```
    Returns a FloatColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getBooleanColumn
```
public BooleanColumn getBooleanColumn(String name)
```
    Returns a BooleanColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getByteColumn
```
public ByteColumn getByteColumn(String name)
```
    Returns a ByteColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getLongColumn
```
public LongColumn getLongColumn(String name)
```
    Returns a LongColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getShortColumn
```
public ShortColumn getShortColumn(String name)
```
    Returns a ShortColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - groupBy
```
public DataGrouping groupBy(String... column)
```
    Groups this data frame using one or more columns
    
    Parameters:
    
    column - group columns
    
    Returns:
    
    data grouping
    
    See Also:
    
    GroupUtil.groupBy(DataFrame, String...)
  - joinLeft
```
public JoinedDataFrame joinLeft(DataFrame dataFrame,
                                String... joinColumns)
```
    Joins this data frame with another data frame using the LEFT JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.leftJoin(DataFrame, DataFrame, JoinColumn...)
  - joinLeft
```
public JoinedDataFrame joinLeft(DataFrame dataFrame,
                                JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the LEFT JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.leftJoin(DataFrame, DataFrame, JoinColumn...)
  - joinLeft
```
public JoinedDataFrame joinLeft(DataFrame dataFrame,
                                String suffixA,
                                String suffixB,
                                JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the LEFT JOIN method. Column names are altered using the provided suffixes.
    
    Parameters:
    
    dataFrame - other data frame
    
    suffixA - suffixes for columns from this data frame
    
    suffixB - suffixes for columns from the other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.leftJoin(DataFrame, DataFrame, String, String, JoinColumn...)
  - joinRight
```
public JoinedDataFrame joinRight(DataFrame dataFrame,
                                 String... joinColumns)
```
    Joins this data frame with another data frame using the RIGHT JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.rightJoin(DataFrame, DataFrame, JoinColumn...)
  - joinRight
```
public JoinedDataFrame joinRight(DataFrame dataFrame,
                                 JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the LEFT JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.leftJoin(DataFrame, DataFrame, JoinColumn...)
  - joinRight
```
public JoinedDataFrame joinRight(DataFrame dataFrame,
                                 String suffixA,
                                 String suffixB,
                                 JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the RIGHT JOIN method. Column names are altered using the provided suffixes.
    
    Parameters:
    
    dataFrame - other data frame
    
    suffixA - suffixes for columns from this data frame
    
    suffixB - suffixes for columns from the other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.rightJoin(DataFrame, DataFrame, String, String, JoinColumn...)
  - joinInner
```
public JoinedDataFrame joinInner(DataFrame dataFrame,
                                 String... joinColumns)
```
    Joins this data frame with another data frame using the INNER JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.innerJoin(DataFrame, DataFrame, JoinColumn...)
  - joinInner
```
public JoinedDataFrame joinInner(DataFrame dataFrame,
                                 JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the INNER JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.innerJoin(DataFrame, DataFrame, JoinColumn...)
  - joinInner
```
public JoinedDataFrame joinInner(DataFrame dataFrame,
                                 String suffixA,
                                 String suffixB,
                                 JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the INNER JOIN method. Column names are altered using the provided suffixes.
    
    Parameters:
    
    dataFrame - other data frame
    
    suffixA - suffixes for columns from this data frame
    
    suffixB - suffixes for columns from the other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.innerJoin(DataFrame, DataFrame, String, String, JoinColumn...)
  - copy
```
public DataFrame copy()
```
    Returns a copy of this data frame. Header, columns, rows and indices are copied.
    
    Returns:
    
    copy of data frame
  - containsColumn
```
public boolean containsColumn(DataFrameColumn column)
```
    Returns true if this data frame contains the input column
    
    Parameters:
    
    column - input column
    
    Returns:
    
    true if this data frame contains the input column
  - notifyColumnValueChanged
```
protected void notifyColumnValueChanged(DataFrameColumn column,
                                        int index,
                                        Comparable value)
```
    Notifies this data frame about a changed value in a column. Used to update indices.
    
    Parameters:
    
    column - changed column
    
    index - changed index
    
    value - new value
  - notifyColumnChanged
```
protected void notifyColumnChanged(DataFrameColumn column)
```
    Notifies this data frame about a changed column. Used to update indices.
    
    Parameters:
    
    column - changed column
  - isIndexColumn
```
public boolean isIndexColumn(DataFrameColumn column)
```
    Returns true if the input column is part of at least one index
    
    Parameters:
    
    column - input column
    
    Returns:
    
    true if column is part of index
  - findByIndex
```
public List<DataRow> findByIndex(String name,
                                 Comparable... values)
```
    Finds matching data rows using an index and the corresponding index values
    
    Parameters:
    
    name - name of index
    
    values - index values
    
    Returns:
    
    rows found
  - findFirstByIndex
```
public DataRow findFirstByIndex(String name,
                                Comparable... values)
```
    Finds the first data row matching an index and the corresponding index values
    
    Parameters:
    
    name - name of index
    
    values - index values
    
    Returns:
    
    rows found
  - getColumns
```
public Collection<DataFrameColumn> getColumns()
```
    Returns a collection of all columns in this data frame
    
    Returns:
    
    collection of columns
  - getIndices
```
protected Indices getIndices()
```
    Returns the indices of this data frame
    
    Returns:
    
    data frame indices
  - map
```
public <T> List<T> map(Class<T> cl)
```
    Description copied from interface: DataContainer
    
    Maps this data container to a list of entities.
    
    Specified by:
    
    map in interface DataContainer<DataFrameHeader,DataRow>
    
    Type Parameters:
    
    T - type of entities
    
    Parameters:
    
    cl - class of resulting entities
    
    Returns:
    
    list of mapped entities
    
    See Also:
    
    DataMapper.map(DataContainer, Class)
  - iterator
```
public Iterator<DataRow> iterator()
```
    Returns an iterator over the rows in this data frame. Iterator.remove() is not supported.
    
    Specified by:
    
    iterator in interface Iterable<DataRow>
    
    Returns:
    
    row iterator
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object

Class DataFrame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

PRIMARY_INDEX_NAME

Constructor Detail

DataFrame

DataFrame

Method Detail

setPrimaryKey

setPrimaryKey

removePrimaryKey

removeIndex

renameColumn

addColumn

addColumn

addColumn

addColumn

addColumn

addColumns

addColumns

append

append

update

set

set

removeColumn

removeColumn

sort

sort

sort

sort

shuffle

select

selectFirst

selectFirst

selectFirst

select

select

find

findFirst

findFirst

filter

filter

find

selectRows

selectRows

findRows

transform

findByPrimaryKey

reverse

addIndex

addIndex

size

subset

createSubset

getRows

getRows

getHeader

concat

concat

concat

isCompatible

getRow

getRowValues

getColumnNames

getColumn

getColumn

getNumberColumn

getStringColumn

getDoubleColumn

getIntegerColumn

getFloatColumn

getBooleanColumn

getByteColumn

getLongColumn

getShortColumn