DataFrame (DataFrame 0.7.6 API)

All Superinterfaces:

DataContainer<DataFrameHeader,DataRow>, Iterable<DataRow>, RowIterable<DataRow>

All Known Implementing Classes:

DataGroup, DataGrouping, DefaultDataFrame, JoinedDataFrame
```
public interface DataFrame
extends DataContainer<DataFrameHeader,DataRow>
```
Created by algru on 12.06.2017.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DataFrame`	`addBooleanColumn(String name)` Adds a new `BooleanColumn` to the dataframe.
`DataFrame`	`addByteColumn(String name)` Adds a new `ByteColumn` to the dataframe.
`<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.
`<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`	`addDoubleColumn(String name)` Adds a new `DoubleColumn` to the dataframe.
`DataFrame`	`addFloatColumn(String name)` Adds a new `FloatColumn` to the dataframe.
`DataFrame`	`addIndex(Index index)` Adds a new index to the dataframe
`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`	`addIntegerColumn(String name)` Adds a new `IntegerColumn` to the dataframe.
`DataFrame`	`addLongColumn(String name)` Adds a new `LongColumn` to the dataframe.
`DataFrame`	`addShortColumn(String name)` Adds a new `ShortColumn` to the dataframe.
`DataFrame`	`addStringColumn(String name)` Adds a new `StringColumn` to the dataframe.
`DataFrame`	`append(Comparable... values)` Appends a new row based on `Comparable` values.
`DataFrame`	`append(DataFrame dataFrame, int rowIndex)` Appends a new row based on `Comparable` values from another dataframe.
`DataFrame`	`append(DataRow row)` Appends a new data row.
`DataFrame`	`appendMatchingRow(DataRow row)` Appends a new data row.
`static DataFrameBuilder`	`builder()` Creates a new `DataFrameBuilder`
`void`	`clear()` Clears all columns
`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.
`static DataFrame`	`create()` Creates a new `DefaultDataFrame` instance
`static DataFrame`	`create(String name)` Creates a new `DefaultDataFrame` instance with a name
`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`	`filterSubset(int from, int to)` Sets this data frame to a subset of itself.
`static DataFrame`	`fromCSV(byte[] bytes, char separator, boolean header)` Loads a data frame from a byte array using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(byte[] bytes, char separator, String headerPrefix)` Loads a data frame from a byte array using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(File file, char separator, boolean header)` Loads a data frame from a file using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(File file, char separator, String headerPrefix)` Loads a data frame from a file string using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(InputStream is, char separator, boolean header)` Loads a data frame from a `InputStream` using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(InputStream is, char separator, String headerPrefix)` Loads a data frame from a `InputStream` using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(Reader reader, char separator, boolean header)` Loads a data frame from a `Reader` using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(Reader r, char separator, String headerPrefix)` Loads a data frame from a `Reader` using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(String content, char separator, boolean header)` Loads a data frame from a content string using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(String content, char separator, String headerPrefix)` Loads a data frame from a content string using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(String resource, ClassLoader classLoader, char separator, boolean header)` Loads a data frame from a URL array using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(String resource, ClassLoader classLoader, char separator, String headerPrefix)` Loads a data frame from a resource using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(URL url, char separator, boolean header)` Loads a data frame from a URL array using the CSV format (`CSVFormat`).
`static DataFrame`	`fromCSV(URL url, char separator, String headerPrefix)` Loads a data frame from a url using the CSV format (`CSVFormat`).
`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.
`<T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrameColumn<T,C>`	`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
`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.
`String`	`getName()` Returns the name of this dataframe
`<T extends Number & Comparable<T>,C extends NumberColumn<T,C>> NumberColumn<T,C>`	`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
`DataRows`	`getRows()` Returns all rows in this data frame
`DataRows`	`getRows(int from, int to)` Returns a list the list of rows between `from` and `to`.
`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.
`Comparable`	`getValue(int col, int row)` Returns a value as `Comparable` from the specified column and row
`int`	`getVersion()` Returns the version of this dataframe.
`DataGrouping`	`groupBy(String... column)` Groups this data frame using one or more columns
`DataFrame`	`head()` Returns the head (top rows) of the dataframe
`DataFrame`	`head(int size)` Returns the head (top rows) of the dataframe
`boolean`	`isCompatible(DataFrame input)` Returns `true` if the header of an input data frame equals the header of this data frame.
`boolean`	`isEmpty()` Returns true if the dataframe is empty (contains no rows)
`boolean`	`isIndexColumn(DataFrameColumn column)` Returns `true` if the input column is part of at least one index
`boolean`	`isNA(int col, int row)` Returns true if the value in the specified column and row is NA
`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`	`joinOuter(DataFrame dataFrame, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `OUTER JOIN` method.
`JoinedDataFrame`	`joinOuter(DataFrame dataFrame, String... joinColumns)` Joins this data frame with another data frame using the `OUTER JOIN` method.
`JoinedDataFrame`	`joinOuter(DataFrame dataFrame, String suffixA, String suffixB, JoinColumn... joinColumns)` Joins this data frame with another data frame using the `OUTER 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.
`static DataFrame`	`load(byte[] bytes)` Loads a data frame from a byte array using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(byte[] bytes, DataReader reader)` Loads a data frame from a byte array using a specified `DataReader`
`static DataFrame`	`load(byte[] bytes, ReadFormat readFormat)` Loads a data frame from a byte array using a specified `ReadFormat`.
`static DataFrame`	`load(DataIterator<?> dataIterator)` Loads a data frame from a `DataIterator`
`static DataFrame`	`load(DataIterator<?> dataIterator, FilterPredicate predicate)` Loads a data frame from a `DataIterator` and filters all rows using a specified predicate
`static DataFrame`	`load(File file)` Loads a data frame from a file.
`static DataFrame`	`load(File file, DataReader reader)` Loads a data frame from a file using a specified `DataReader`
`static DataFrame`	`load(File file, ReadFormat readFormat)` Loads a data frame from a file using a specified `ReadFormat`.
`static DataFrame`	`load(InputStream is)` Loads a data frame from a `InputStream` using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(InputStream is, DataReader reader)` Loads a data frame from a `InputStream` using a specified `DataReader`
`static DataFrame`	`load(InputStream is, ReadFormat readFormat)` Loads a data frame from a `InputStream` using a specified `ReadFormat`.
`static DataFrame`	`load(Reader reader)` Loads a data frame from a `Reader` using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(Reader r, DataReader reader)` Loads a data frame from a `Reader` using a specified `DataReader`
`static DataFrame`	`load(Reader reader, ReadFormat readFormat)` Loads a data frame from a `Reader` using a specified `ReadFormat`.
`static DataFrame`	`load(String content)` Loads a data frame from a content string using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(String resource, ClassLoader classLoader)` Loads a data frame from a resource using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(String resource, ClassLoader classLoader, DataReader reader)` Loads a data frame from a resource using a specified `DataReader`
`static DataFrame`	`load(String resource, ClassLoader classLoader, ReadFormat readFormat)` Loads a data frame from a resource using a specified `ReadFormat`
`static DataFrame`	`load(String content, DataReader reader)` Loads a data frame from a content String using a specified `DataReader`
`static DataFrame`	`load(String content, ReadFormat readFormat)` Loads a data frame from a content String using a specified `ReadFormat`.
`static DataFrame`	`load(URL url)` Loads a data frame from a URL using the default tab separated format (`TSVFormat`).
`static DataFrame`	`load(URL url, DataReader reader)` Loads a data frame from a URL using a specified `DataReader`
`static DataFrame`	`load(URL url, ReadFormat readFormat)` Loads a data frame from a URL array using a specified `ReadFormat`.
`default void`	`print()` Prints this dataframe to `System.out` using the default print format (`DataFrameWriter.DEFAULT_WRITE_FORMAT`).
`default void`	`print(DataWriter dataWriter)` Prints this dataframe to `System.out` using a specified `DataWriter`.
`default void`	`print(WriteFormat writeFormat)` Prints this dataframe to `System.out` using a specified `WriteFormat`.
`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`	`replaceColumn(DataFrameColumn existing, DataFrameColumn replacement)`
`DataFrame`	`replaceColumn(String existing, DataFrameColumn replacement)`
`DataFrame`	`reverse()` Reverses all columns
`Iterable<? extends DataRow>`	`rows()` Returns the indices of this data frame
`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.
`DataFrame`	`selectByIndex(String name, Comparable... values)` Returns a new dataframe containing data rows found using an index and the corresponding index values
`DataRow`	`selectByPrimaryKey(Comparable... keyValues)` Finds a data row using the primary key
`ColumnSelection`	`selectColumns(DataFrameColumn... columns)` Returns a `ColumnSelection` for the selected columns.
`ColumnSelection`	`selectColumns(String... columnNames)` Returns a `ColumnSelection` for the selected columns.
`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.
`DataRow`	`selectFirstRowByIndex(String name, Comparable... values)` Finds the first data row matching an index and the corresponding index values
`DataRows`	`selectRows(Collection<Integer> rowIndices)`
`DataRows`	`selectRows(FilterPredicate predicate)` Finds data rows using a `FilterPredicate`.
`DataRows`	`selectRows(String predicateString)` Finds data rows using a `FilterPredicate`.
`DataRows`	`selectRows(String colName, Comparable value)` Finds data rows from this data frame where a specified column value equals an input value.
`DataRows`	`selectRowsByIndex(String name, Comparable... values)` Finds matching data rows using an index and the corresponding index values
`DataFrame`	`selectSubset(int from, int to)` Creates a new data frame from a subset of this data frame.
`DataFrame`	`set(DataFrameHeader header)`
`DataFrame`	`set(DataRows rows)` Clears all rows in this data frame and sets new rows using the provided `DataRows`.
`void`	`setName(String name)` Sets the name of this dataframe
`DataFrame`	`setPrimaryKey(DataFrameColumn... cols)` Sets the primary key columns using column objects
`DataFrame`	`setPrimaryKey(String... colNames)` Sets the primary key columns using column names
`void`	`setValue(int col, int row, Comparable newValue)` Sets the value in the specified column and row
`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`	`tail()` Returns the tail (bottom rows) of the dataframe
`DataFrame`	`tail(int size)` Returns the tail (bottom rows) of the dataframe
`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.
`default void`	`write(File file)` Writes this dataframe to a file using the default write format (`DataFrameWriter.DEFAULT_WRITE_FORMAT`).
`default void`	`write(File file, boolean writeMetaFile)` Writes this dataframe to a file using the default write format (`DataFrameWriter.DEFAULT_WRITE_FORMAT`).
`default void`	`write(File file, DataWriter dataWriter)` Writes this dataframe to a file using a specified `DataWriter`.
`default void`	`write(File file, DataWriter dataWriter, boolean writeMetaFile)` Writes this dataframe to a file using a specified `DataWriter`.
`default void`	`write(File file, WriteFormat writeFormat)` Writes this dataframe to a file using a specified `WriteFormat`.
`default void`	`write(File file, WriteFormat writeFormat, boolean writeMetaFile)` Writes this dataframe to a file using a specified `WriteFormat`.
`default void`	`write(OutputStream outputStream)` Writes this dataframe to a `OutputStream` using the default write format (`DataFrameWriter.DEFAULT_WRITE_FORMAT`).
`default void`	`write(OutputStream outputStream, DataWriter dataWriter)` Writes this dataframe to a `OutputStream` using a specified `DataWriter`.
`default void`	`write(OutputStream outputStream, WriteFormat writeFormat)` Writes this dataframe to a `OutputStream` using a specified `WriteFormat`.
`default void`	`write(Writer writer)` Writes this dataframe to a `Writer` using the default write format (`DataFrameWriter.DEFAULT_WRITE_FORMAT`).
`default void`	`write(Writer writer, DataWriter dataWriter)` Writes this dataframe to a `Writer` using a specified `DataWriter`.
`default void`	`write(Writer writer, WriteFormat writeFormat)` Writes this dataframe to a `Writer` using a specified `WriteFormat`.
`default void`	`writeCSV(File file, char separator, boolean writeHeader)` Writes this dataframe to a file using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(File file, char separator, boolean writeHeader, boolean writeMetaFile)` Writes this dataframe to a file using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(File file, char separator, String headerPrefix)` Writes this dataframe to a file using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(File file, char separator, String headerPrefix, boolean writeMetaFile)` Writes this dataframe to a file using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(OutputStream outputStream, char separator, boolean writeHeader)` Writes this dataframe to a `OutputStream` using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(OutputStream outputStream, char separator, String headerPrefix)` Writes this dataframe to a `OutputStream` using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(Writer writer, char separator, boolean writeHeader)` Writes this dataframe to a `Writer` using the CSV file format (`CSVFormat`) and a specified separator.
`default void`	`writeCSV(Writer writer, char separator, String headerPrefix)` Writes this dataframe to a `Writer` using the CSV file format (`CSVFormat`) and a specified separator.

Methods inherited from interface de.unknownreality.dataframe.common.DataContainer
map

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

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this dataframe
    
    Returns:
    
    name
  - setName
```
void setName(String name)
```
    Sets the name of this dataframe
    
    Parameters:
    
    name - dataframe name
  - getVersion
```
int getVersion()
```
    Returns the version of this dataframe. The version is automatically increased on each function that alters the dataframe (sort,...)
    
    Returns:
    
    version
  - setPrimaryKey
```
DataFrame setPrimaryKey(String... colNames)
```
    Sets the primary key columns using column names
    
    Parameters:
    
    colNames - primary key columns
    
    Returns:
    
    self for method chaining
  - setPrimaryKey
```
DataFrame setPrimaryKey(DataFrameColumn... cols)
```
    Sets the primary key columns using column objects
    
    Parameters:
    
    cols - primary key columns
    
    Returns:
    
    self for method chaining
  - removePrimaryKey
```
DataFrame removePrimaryKey()
```
    Removes the current primary key
    
    Returns:
    
    self for method chaining
  - removeIndex
```
DataFrame removeIndex(String name)
```
    Removes the index with the specified name
    
    Parameters:
    
    name - name of index
    
    Returns:
    
    self for method chaining
  - renameColumn
```
DataFrame renameColumn(String name,
                       String newName)
```
    Renames a column
    
    Parameters:
    
    name - current column name
    
    newName - new column name
    
    Returns:
    
    self for method chaining
  - selectColumns
```
ColumnSelection selectColumns(String... columnNames)
```
    Returns a ColumnSelection for the selected columns. The rows can be filtered using ColumnSelection.where(java.lang.String, java.lang.Comparable).
    
    Parameters:
    
    columnNames - selected columns
    
    Returns:
    
    ColumnSelection for row selection
  - selectColumns
```
ColumnSelection selectColumns(DataFrameColumn... columns)
```
    Returns a ColumnSelection for the selected columns. The rows can be filtered using ColumnSelection.where(java.lang.String, java.lang.Comparable).
    
    Parameters:
    
    columns - selected columns
    
    Returns:
    
    ColumnSelection for row selection
  - addColumn
```
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
```
<T extends Comparable<T>> DataFrame addColumn(Class<T> type,
                                              String name)
```
    Creates a column for a specified column value type.
    
    Type Parameters:
    
    T - type of column values
    
    Parameters:
    
    type - class of column values
    
    name - column name
    
    Returns:
    
    self for method chaining
  - addColumn
```
<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
```
<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
```
<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.
    
    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)
  - addBooleanColumn
```
DataFrame addBooleanColumn(String name)
```
    Adds a new BooleanColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addByteColumn
```
DataFrame addByteColumn(String name)
```
    Adds a new ByteColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addDoubleColumn
```
DataFrame addDoubleColumn(String name)
```
    Adds a new DoubleColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addFloatColumn
```
DataFrame addFloatColumn(String name)
```
    Adds a new FloatColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addIntegerColumn
```
DataFrame addIntegerColumn(String name)
```
    Adds a new IntegerColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addLongColumn
```
DataFrame addLongColumn(String name)
```
    Adds a new LongColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addShortColumn
```
DataFrame addShortColumn(String name)
```
    Adds a new ShortColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addStringColumn
```
DataFrame addStringColumn(String name)
```
    Adds a new StringColumn to the dataframe.
    
    Parameters:
    
    name - name of the column
    
    Returns:
    
    self for method chaining
  - addColumns
```
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
```
DataFrame addColumns(DataFrameColumn... columns)
```
    Adds an array of columns to this data frame
    
    Parameters:
    
    columns - columns to add
    
    Returns:
    
    self for method chaining
  - replaceColumn
```
DataFrame replaceColumn(DataFrameColumn existing,
                        DataFrameColumn replacement)
```
  - replaceColumn
```
DataFrame replaceColumn(String existing,
                        DataFrameColumn replacement)
```
  - append
```
DataFrame append(DataFrame dataFrame,
                 int rowIndex)
```
    Appends a new row based on Comparable values from another dataframe.
    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.
    
    Parameters:
    
    dataFrame - other dataframe
    
    rowIndex - row in other dataframe
    
    Returns:
    
    self for method chaining
  - append
```
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
```
DataFrame append(DataRow row)
```
    Appends a new data row. Only row values matching a dataframe column are appended
    
    Parameters:
    
    row - row containing the new values
    
    Returns:
    
    self for method chaining
  - appendMatchingRow
```
DataFrame appendMatchingRow(DataRow row)
```
    Appends a new data row. The row must contain a value for all dataframe columns. The order of the row values must match the column order in the dataframe.
    
    Parameters:
    
    row - row containing the new values
    
    Returns:
    
    self for method chaining
  - update
```
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
```
DataFrame set(DataFrameHeader header)
```
  - set
```
DataFrame set(DataRows rows)
```
    Clears all rows in this data frame and sets new rows using the provided DataRows.
    
    Parameters:
    
    rows - new collection of rows
    
    Returns:
    
    self for method chaining
  - removeColumn
```
DataFrame removeColumn(String header)
```
    Removes a column from this data frame
    
    Parameters:
    
    header - column header name
    
    Returns:
    
    self for method chaining
  - removeColumn
```
DataFrame removeColumn(DataFrameColumn column)
```
    Removes a column from this data frame
    
    Parameters:
    
    column - column to remove
    
    Returns:
    
    self for method chaining
  - sort
```
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
```
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
```
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
```
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
```
DataFrame shuffle()
```
    Shuffles all rows
    
    Returns:
    
    self for method chaining
  - select
```
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
```
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
```
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
```
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
```
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
```
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)
  - filter
```
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
```
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
  - selectRows
```
DataRows selectRows(String colName,
                    Comparable value)
```
    Finds data rows from this data frame where a specified column value equals an input value.
    
    Parameters:
    
    colName - column name
    
    value - input value
    
    Returns:
    
    list of found data rows
  - selectRows
```
DataRows selectRows(String predicateString)
```
    Finds data rows using a FilterPredicate.
    
    Parameters:
    
    predicateString - input predicate string
    
    Returns:
    
    list of found data rows
  - selectRows
```
DataRows selectRows(FilterPredicate predicate)
```
    Finds data rows using a FilterPredicate.
    
    Parameters:
    
    predicate - input predicate
    
    Returns:
    
    list of found data rows
  - transform
```
DataFrame transform(DataFrameTransform transformer)
```
    Converts this dataframe into another dataframe using a specified transformer
    
    Parameters:
    
    transformer - the applied transformer
    
    Returns:
    
    resulting dataframe
  - selectByPrimaryKey
```
DataRow selectByPrimaryKey(Comparable... keyValues)
```
    Finds a data row using the primary key
    
    Parameters:
    
    keyValues - input key values
    
    Returns:
    
    found data row
  - reverse
```
DataFrame reverse()
```
    Reverses all columns
    
    Returns:
    
    self for method chaining
  - addIndex
```
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
```
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
  - addIndex
```
DataFrame addIndex(Index index)
```
    Adds a new index to the dataframe
    
    Parameters:
    
    index - index to add
    
    Returns:
    
    self for method chaining
  - size
```
int size()
```
    Returns the number of rows in this data frame
    
    Returns:
    
    number of rows
  - isEmpty
```
boolean isEmpty()
```
    Returns true if the dataframe is empty (contains no rows)
    
    Returns:
    
    true if the dataframe is empty
  - subset
```
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
  - filterSubset
```
DataFrame filterSubset(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
  - selectSubset
```
DataFrame selectSubset(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
```
DataRows 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
```
DataRows getRows()
```
    Returns all rows in this data frame
    
    Returns:
    
    list of all rows
  - getHeader
```
DataFrameHeader getHeader()
```
    Returns the header of this data frame
    
    Specified by:
    
    getHeader in interface DataContainer<DataFrameHeader,DataRow>
    
    Returns:
    
    data frame header
  - concat
```
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
```
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
```
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
```
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
```
DataRow getRow(int i)
```
    Returns the data row at a specified index
    
    Parameters:
    
    i - index of data row
    
    Returns:
    
    data row at specified index
  - getColumnNames
```
Collection<String> getColumnNames()
```
    Returns a collection of the column names in this data frame
    
    Returns:
    
    column names
  - getColumn
```
<T extends Comparable<T>,C extends DataFrameColumn<T,C>> DataFrameColumn<T,C> getColumn(String name)
```
    Returns a column based on its name
    
    Type Parameters:
    
    T - value type of the column
    
    C - column type
    
    Parameters:
    
    name - column name
    
    Returns:
    
    column
  - getColumn
```
<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
```
<T extends Number & Comparable<T>,C extends NumberColumn<T,C>> NumberColumn<T,C> getNumberColumn(String name)
```
    Returns a NumberColumn If the column is not found or has the wrong type a DataFrameRuntimeException is thrown.
    
    Type Parameters:
    
    T - value type of the column
    
    C - column type
    
    Parameters:
    
    name - column name
    
    Returns:
    
    found column
  - getStringColumn
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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
```
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...)
  - joinOuter
```
JoinedDataFrame joinOuter(DataFrame dataFrame,
                          String... joinColumns)
```
    Joins this data frame with another data frame using the OUTER JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.innerJoin(DataFrame, DataFrame, JoinColumn...)
  - joinOuter
```
JoinedDataFrame joinOuter(DataFrame dataFrame,
                          JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the OUTER JOIN method.
    
    Parameters:
    
    dataFrame - other data frame
    
    joinColumns - join columns
    
    Returns:
    
    joined data frame
    
    See Also:
    
    JoinUtil.innerJoin(DataFrame, DataFrame, JoinColumn...)
  - joinOuter
```
JoinedDataFrame joinOuter(DataFrame dataFrame,
                          String suffixA,
                          String suffixB,
                          JoinColumn... joinColumns)
```
    Joins this data frame with another data frame using the OUTER 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
```
DataFrame copy()
```
    Returns a copy of this data frame. Header, columns, rows and indices are copied.
    
    Returns:
    
    copy of data frame
  - containsColumn
```
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
  - isIndexColumn
```
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
  - selectRowsByIndex
```
DataRows selectRowsByIndex(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
  - selectRows
```
DataRows selectRows(Collection<Integer> rowIndices)
```
  - selectFirstRowByIndex
```
DataRow selectFirstRowByIndex(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
  - selectByIndex
```
DataFrame selectByIndex(String name,
                        Comparable... values)
```
    Returns a new dataframe containing data rows found using an index and the corresponding index values
    
    Parameters:
    
    name - name of index
    
    values - index values
    
    Returns:
    
    dataframe containing found rows
  - getColumns
```
Collection<DataFrameColumn> getColumns()
```
    Returns a collection of all columns in this data frame
    
    Returns:
    
    collection of columns
  - rows
```
Iterable<? extends DataRow> rows()
```
    Returns the indices of this data frame
    
    Returns:
    
    data frame indices
  - create
```
static DataFrame create()
```
    Creates a new DefaultDataFrame instance
    
    Returns:
    
    new dataframe
  - create
```
static DataFrame create(String name)
```
    Creates a new DefaultDataFrame instance with a name
    
    Parameters:
    
    name - dataframe name
    
    Returns:
    
    new dataframe
  - builder
```
static DataFrameBuilder builder()
```
    Creates a new DataFrameBuilder
    
    Returns:
    
    dataframe builder
  - load
```
static DataFrame load(File file)
```
    Loads a data frame from a file. The matching data frame meta file must be present. file+'.dfm'
    
    Parameters:
    
    file - data frame file
    
    Returns:
    
    loaded data frame
  - load
```
static DataFrame load(String content)
```
    Loads a data frame from a content string using the default tab separated format (TSVFormat).
    
    Parameters:
    
    content - content string
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(String resource,
                      ClassLoader classLoader)
```
    Loads a data frame from a resource using the default tab separated format (TSVFormat).
    
    Parameters:
    
    resource - resource path
    
    classLoader - class loader used to find the resource
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(URL url)
```
    Loads a data frame from a URL using the default tab separated format (TSVFormat).
    
    Parameters:
    
    url - input url
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(byte[] bytes)
```
    Loads a data frame from a byte array using the default tab separated format (TSVFormat).
    
    Parameters:
    
    bytes - input byte array
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(InputStream is)
```
    Loads a data frame from a InputStream using the default tab separated format (TSVFormat).
    
    Parameters:
    
    is - input stream
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(Reader reader)
```
    Loads a data frame from a Reader using the default tab separated format (TSVFormat).
    
    Parameters:
    
    reader - input reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(File file,
                      ReadFormat readFormat)
```
    Loads a data frame from a file using a specified ReadFormat.
    
    Parameters:
    
    file - input file
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(String content,
                      ReadFormat readFormat)
```
    Loads a data frame from a content String using a specified ReadFormat.
    
    Parameters:
    
    content - content string
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(String resource,
                      ClassLoader classLoader,
                      ReadFormat readFormat)
```
    Loads a data frame from a resource using a specified ReadFormat
    
    Parameters:
    
    resource - resource path
    
    classLoader - ClassLoader used to find the resource
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(URL url,
                      ReadFormat readFormat)
```
    Loads a data frame from a URL array using a specified ReadFormat.
    
    Parameters:
    
    url - input url
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(byte[] bytes,
                      ReadFormat readFormat)
```
    Loads a data frame from a byte array using a specified ReadFormat.
    
    Parameters:
    
    bytes - input byte array
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(InputStream is,
                      ReadFormat readFormat)
```
    Loads a data frame from a InputStream using a specified ReadFormat.
    
    Parameters:
    
    is - input stream
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(Reader reader,
                      ReadFormat readFormat)
```
    Loads a data frame from a Reader using a specified ReadFormat.
    
    Parameters:
    
    reader - input stream
    
    readFormat - read format
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(File file,
                      DataReader reader)
```
    Loads a data frame from a file using a specified DataReader
    
    Parameters:
    
    file - input file
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(String content,
                      DataReader reader)
```
    Loads a data frame from a content String using a specified DataReader
    
    Parameters:
    
    content - content string
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(String resource,
                      ClassLoader classLoader,
                      DataReader reader)
```
    Loads a data frame from a resource using a specified DataReader
    
    Parameters:
    
    resource - resource path
    
    classLoader - ClassLoader used to find the resource
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(URL url,
                      DataReader reader)
```
    Loads a data frame from a URL using a specified DataReader
    
    Parameters:
    
    url - input url
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(byte[] bytes,
                      DataReader reader)
```
    Loads a data frame from a byte array using a specified DataReader
    
    Parameters:
    
    bytes - input byte array
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(InputStream is,
                      DataReader reader)
```
    Loads a data frame from a InputStream using a specified DataReader
    
    Parameters:
    
    is - input
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(Reader r,
                      DataReader reader)
```
    Loads a data frame from a Reader using a specified DataReader
    
    Parameters:
    
    r - input reader
    
    reader - data reader
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(DataIterator<?> dataIterator)
```
    Loads a data frame from a DataIterator
    
    Parameters:
    
    dataIterator - data iterator
    
    Returns:
    
    resulting dataframe
  - load
```
static DataFrame load(DataIterator<?> dataIterator,
                      FilterPredicate predicate)
```
    Loads a data frame from a DataIterator and filters all rows using a specified predicate
    
    Parameters:
    
    dataIterator - data iterator
    
    predicate - filter predicate
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(File file,
                         char separator,
                         boolean header)
```
    Loads a data frame from a file using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    file - input file
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(String content,
                         char separator,
                         boolean header)
```
    Loads a data frame from a content string using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    content - content string
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(String resource,
                         ClassLoader classLoader,
                         char separator,
                         boolean header)
```
    Loads a data frame from a URL array using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    resource - resource path
    
    classLoader - class loader used to find the resource
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(URL url,
                         char separator,
                         boolean header)
```
    Loads a data frame from a URL array using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    url - input url
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(byte[] bytes,
                         char separator,
                         boolean header)
```
    Loads a data frame from a byte array using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    bytes - input byte array
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(InputStream is,
                         char separator,
                         boolean header)
```
    Loads a data frame from a InputStream using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    is - input stream
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(Reader reader,
                         char separator,
                         boolean header)
```
    Loads a data frame from a Reader using the CSV format (CSVFormat). The column separator can be specified. If the CSV contains no header, the columns are named V1, V2,...
    
    Parameters:
    
    reader - input reader
    
    separator - column separator
    
    header - specifies wether the csv contains a header or not
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(File file,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a file string using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    file - input file
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(String content,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a content string using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    content - content string
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(String resource,
                         ClassLoader classLoader,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a resource using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    resource - resource path
    
    classLoader - class loader used to find the resource
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(URL url,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a url using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    url - input url
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(byte[] bytes,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a byte array using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    bytes - input byte array
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(InputStream is,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a InputStream using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    is - input stream
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - fromCSV
```
static DataFrame fromCSV(Reader r,
                         char separator,
                         String headerPrefix)
```
    Loads a data frame from a Reader using the CSV format (CSVFormat). The column separator can be specified. If the header starts with a certain prefix it can be specified, otherwise the prefix should be set to "" or null
    
    Parameters:
    
    r - input reader
    
    separator - column separator
    
    headerPrefix - header prefix
    
    Returns:
    
    resulting dataframe
  - write
```
default void write(File file,
                   DataWriter dataWriter)
```
    Writes this dataframe to a file using a specified DataWriter. If there is a matching DataReader for the DataWriter, a meta file is written automatically
    
    Parameters:
    
    file - target file
    
    dataWriter - data writer used to write the dataframe
  - write
```
default void write(File file,
                   DataWriter dataWriter,
                   boolean writeMetaFile)
```
    Writes this dataframe to a file using a specified DataWriter. If there is a matching ReadFormat for the DataWriter, a meta file is written if specified.
    
    Parameters:
    
    file - target file
    
    writeMetaFile - defines whether a meta file should be created
    
    dataWriter - data writer used to write the dataframe
  - write
```
default void write(Writer writer,
                   DataWriter dataWriter)
```
    Writes this dataframe to a Writer using a specified DataWriter.
    
    Parameters:
    
    writer - target writer
    
    dataWriter - data writer used to write the dataframe
  - write
```
default void write(OutputStream outputStream,
                   DataWriter dataWriter)
```
    Writes this dataframe to a OutputStream using a specified DataWriter.
    
    Parameters:
    
    outputStream - target OutputStream
    
    dataWriter - data writer used to write the dataframe
  - write
```
default void write(File file,
                   WriteFormat writeFormat)
```
    Writes this dataframe to a file using a specified WriteFormat. If there is a matching ReadFormat for the WriteFormat, a meta file is written automatically
    
    Parameters:
    
    file - target file
    
    writeFormat - defines the output format used to write the dataframe
  - write
```
default void write(File file,
                   WriteFormat writeFormat,
                   boolean writeMetaFile)
```
    Writes this dataframe to a file using a specified WriteFormat. If there is a matching ReadFormat for the WriteFormat, a meta file is written if specified
    
    Parameters:
    
    file - target file
    
    writeFormat - defines the output format used to write the dataframe
    
    writeMetaFile - defines whether a meta file should be created
  - write
```
default void write(Writer writer,
                   WriteFormat writeFormat)
```
    Writes this dataframe to a Writer using a specified WriteFormat.
    
    Parameters:
    
    writer - target writer
    
    writeFormat - data writer used to write the dataframe
  - write
```
default void write(OutputStream outputStream,
                   WriteFormat writeFormat)
```
    Writes this dataframe to a OutputStream using a specified WriteFormat.
    
    Parameters:
    
    outputStream - target OutputStream
    
    writeFormat - data writer used to write the dataframe
  - write
```
default void write(File file)
```
    Writes this dataframe to a file using the default write format (DataFrameWriter.DEFAULT_WRITE_FORMAT). A meta file is written automatically.
    
    Parameters:
    
    file - target file
  - write
```
default void write(File file,
                   boolean writeMetaFile)
```
    Writes this dataframe to a file using the default write format (DataFrameWriter.DEFAULT_WRITE_FORMAT). A meta file is written if specified.
    
    Parameters:
    
    file - target file
    
    writeMetaFile - defines whether a meta file should be created
  - write
```
default void write(Writer writer)
```
    Writes this dataframe to a Writer using the default write format (DataFrameWriter.DEFAULT_WRITE_FORMAT).
    
    Parameters:
    
    writer - target writer
  - write
```
default void write(OutputStream outputStream)
```
    Writes this dataframe to a OutputStream using the default write format (DataFrameWriter.DEFAULT_WRITE_FORMAT).
    
    Parameters:
    
    outputStream - target outputStream
  - writeCSV
```
default void writeCSV(File file,
                      char separator,
                      boolean writeHeader)
```
    Writes this dataframe to a file using the CSV file format (CSVFormat) and a specified separator. A header is written if specified. A meta file is written automatically.
    
    Parameters:
    
    file - target file
    
    separator - separator char
    
    writeHeader - defines whether the header should be written to the file
  - writeCSV
```
default void writeCSV(File file,
                      char separator,
                      boolean writeHeader,
                      boolean writeMetaFile)
```
    Writes this dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.
    
    Parameters:
    
    file - target file
    
    separator - separator char
    
    writeHeader - defines whether the header should be written to the file
    
    writeMetaFile - defines whether a meta file should be written
  - writeCSV
```
default void writeCSV(Writer writer,
                      char separator,
                      boolean writeHeader)
```
    Writes this dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.
    
    Parameters:
    
    writer - target writer
    
    separator - separator char
    
    writeHeader - defines whether the header should be written to the file
  - writeCSV
```
default void writeCSV(OutputStream outputStream,
                      char separator,
                      boolean writeHeader)
```
    Writes this dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.
    
    Parameters:
    
    outputStream - target OutputStream
    
    separator - separator char
    
    writeHeader - defines whether the header should be written to the file
  - writeCSV
```
default void writeCSV(File file,
                      char separator,
                      String headerPrefix)
```
    Writes this dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added. A meta file is written automatically.
    
    Parameters:
    
    file - target file
    
    separator - separator char
    
    headerPrefix - header prefix
  - writeCSV
```
default void writeCSV(File file,
                      char separator,
                      String headerPrefix,
                      boolean writeMetaFile)
```
    Writes this dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added. A meta file is written if specified.
    
    Parameters:
    
    file - target file
    
    separator - separator char
    
    headerPrefix - header prefix
    
    writeMetaFile - defines whether a meta file should be written
  - writeCSV
```
default void writeCSV(Writer writer,
                      char separator,
                      String headerPrefix)
```
    Writes this dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added.
    
    Parameters:
    
    writer - target writer
    
    separator - separator char
    
    headerPrefix - header prefix
  - writeCSV
```
default void writeCSV(OutputStream outputStream,
                      char separator,
                      String headerPrefix)
```
    Writes this dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added.
    
    Parameters:
    
    outputStream - target OutputStream
    
    separator - separator char
    
    headerPrefix - header prefix
  - print
```
default void print()
```
    Prints this dataframe to System.out using the default print format (DataFrameWriter.DEFAULT_WRITE_FORMAT).
  - print
```
default void print(DataWriter dataWriter)
```
    Prints this dataframe to System.out using a specified DataWriter.
    
    Parameters:
    
    dataWriter - data writer used to print the dataframe
  - print
```
default void print(WriteFormat writeFormat)
```
    Prints this dataframe to System.out using a specified WriteFormat.
    
    Parameters:
    
    writeFormat - write format used to print the dataframe
  - getValue
```
Comparable getValue(int col,
                    int row)
```
    Returns a value as Comparable from the specified column and row
    
    Parameters:
    
    col - column
    
    row - row
    
    Returns:
    
    value
  - setValue
```
void setValue(int col,
              int row,
              Comparable newValue)
```
    Sets the value in the specified column and row
    
    Parameters:
    
    col - column
    
    row - row
    
    newValue - new value
  - isNA
```
boolean isNA(int col,
             int row)
```
    Returns true if the value in the specified column and row is NA
    
    Parameters:
    
    col - column
    
    row - row
    
    Returns:
    
    true if value is NA
  - head
```
DataFrame head(int size)
```
    Returns the head (top rows) of the dataframe
    
    Parameters:
    
    size - number of rows
    
    Returns:
    
    head dataframe
  - head
```
DataFrame head()
```
    Returns the head (top rows) of the dataframe
    
    Returns:
    
    head dataframe
  - tail
```
DataFrame tail(int size)
```
    Returns the tail (bottom rows) of the dataframe
    
    Parameters:
    
    size - number of rows
    
    Returns:
    
    head dataframe
  - tail
```
DataFrame tail()
```
    Returns the tail (bottom rows) of the dataframe
    
    Returns:
    
    head dataframe
  - clear
```
void clear()
```
    Clears all columns

Interface DataFrame

Method Summary

Methods inherited from interface de.unknownreality.dataframe.common.DataContainer

Methods inherited from interface java.lang.Iterable

Method Detail

getName

setName

getVersion

setPrimaryKey

setPrimaryKey

removePrimaryKey

removeIndex

renameColumn

selectColumns

selectColumns

addColumn

addColumn

addColumn

addColumn

addColumn

addBooleanColumn

addByteColumn

addDoubleColumn

addFloatColumn

addIntegerColumn

addLongColumn

addShortColumn

addStringColumn

addColumns

addColumns

replaceColumn

replaceColumn

append

append

append

appendMatchingRow

update

set

set

removeColumn

removeColumn

sort

sort

sort

sort

shuffle

select

selectFirst

selectFirst

selectFirst

select

select

filter

filter

selectRows

selectRows

selectRows

transform

selectByPrimaryKey

reverse

addIndex

addIndex

addIndex

size

isEmpty

subset

filterSubset

selectSubset

getRows

getRows

getHeader

concat

concat

concat

isCompatible

getRow

getColumnNames

getColumn

getColumn

getNumberColumn