DataFrameColumn (DataFrame 0.6.1 API)

java.lang.Object
- de.unknownreality.dataframe.DataFrameColumn<T,C>

All Implemented Interfaces:: Iterable<T>

Direct Known Subclasses:: BasicColumn

public abstract class DataFrameColumn<T extends Comparable<T>,C extends DataFrameColumn<T,C>>
extends Object
implements Iterable<T>

Created by Alex on 11.03.2016.

Field Summary

Fields
Modifier and Type Field and Description

static String ERROR_APPENDING

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

Constructor Summary

Constructors
Constructor and Description

DataFrameColumn()

Constructors
Constructor and Description
`DataFrameColumn()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`append(Object value)` Append a value at the end of this column.
`boolean`	`append(Row<?,?> row, int index)` A new value is appended at the end of this column using `doAppend(Comparable)`.
`<H> boolean`	`append(Row<?,H> row, H headerName)` A new value is appended at the end of this column using `doAppend(Comparable)`.
`boolean`	`append(T value)` A new value is appended at the end of this column using `doAppend(Comparable)`.
`boolean`	`appendAll(Collection<? extends T> c)` Appends all values of in a collection to this column.
`boolean`	`appendNA()` Appends a `NA value` to the end of this column.
`abstract void`	`clear()` Clears this column.
`abstract boolean`	`contains(T o)` Returns `true` if the specified value exists in this column.
`abstract boolean`	`containsAll(Collection<?> c)` Returns `true` if all values of a specified collection are present in this column.
`abstract C`	`copy()` Creates a copy of this column
`protected abstract boolean`	`doAppend(T value)` Used by `append(Comparable)` to append a value to this column.
`protected abstract boolean`	`doAppendAll(Collection<? extends T> c)` Used by `appendAll(Collection)`} to append a collection of values.
`protected abstract boolean`	`doAppendNA()` Used by `appendNA()` to append NA at the end of this column.
`protected abstract void`	`doMap(MapFunction<T> mapFunction)` Used by `map(MapFunction)`.
`protected abstract void`	`doReverse()` Used by `reverse()` to reverse the order of this column
`protected abstract void`	`doSet(int index, T value)` Used by `set(int, Comparable)` to set a value at a specified index
`protected abstract void`	`doSetNA(int index)` Used by `setNA(int)` to set a specified index to `NA`.
`protected abstract void`	`doSort()` Used by `sort()` to sort the column values by their natural ordering
`protected abstract void`	`doSort(Comparator<T> comparator)` Used by `sort(Comparator)` to sort the values in this column
`protected void`	`endDataFrameAppend()` Internal method used by the parent data frame to disable appending.
`abstract T`	`get(int index)` Returns the value at a specified index
`DataFrame`	`getDataFrame()` Returns the parent `data frame`
`String`	`getName()` Returns the name of this column
`abstract Parser<T>`	`getParser()` Returns a `Parser` for the type of the values in this column.
`protected abstract C`	`getThis()` Used to return the right column type for
`abstract Class<T>`	`getType()` Returns the type of the values in this column.
`abstract T`	`getValueFromRow(Row<?,?> row, int headerIdex)`
`abstract <H> T`	`getValueFromRow(Row<?,H> row, H headerName)`
`abstract boolean`	`isEmpty()` Returns `true` if this column contains no values.
`abstract boolean`	`isNA(int index)` Returns `true` if the value at the specified index equals `NA`.
`C`	`map(MapFunction<T> mapFunction)` A map function is applied to the values in this column.
`void`	`notifyDataFrameColumnChanged()` Notifies the parent `data frame` that this column changed.
`void`	`notifyDataFrameValueChanged(int index)` Notifies the parent `data frame` about a value change at a specified index.
`C`	`reverse()` Reverses the order of the column values Calls`notifyDataFrameColumnChanged()` to ensure data frame index consistency
`C`	`set(int index, T value)` Sets a value at a specified index.
`protected void`	`setDataFrame(DataFrame dataFrame)` Used internally by the data frame.
`C`	`setNA(int index)` Sets the value at a specified index to `NA`.
`void`	`setName(String name)` Sets the name of this column.
`abstract int`	`size()` Returns the number of values in this column.
`C`	`sort()` Sorts the column values by their natural ordering Calls `notifyDataFrameValueChanged(int)` to ensure data frame index consistency
`C`	`sort(Comparator<T> comparator)` Sorts values in the column using a provided comparator Calls `notifyDataFrameValueChanged(int)` to ensure data frame index consistency
`protected void`	`startDataFrameAppend()` Internal method used by the parent data frame to enable appending.
`abstract Comparable[]`	`toArray()` Returns an `Comparable` array that contains all values of this column.
`abstract T[]`	`toArray(T[] a)` Copies the values of this column to a specified array of the same type.
`Double`	`toDouble(int index)` Returns the double value at a specified index.
`DataFrame`	`transform(ColumnDataFrameTransform<C> transformer)` Used to apply transformations on a column
`<R extends DataFrameColumn<?,R>> R`	`transform(ColumnTransform<C,R> transformer)` Used to apply transformations on a column
`void`	`validateAppend()` Throws an `exception` if appending is currently not allowed.

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

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

- Field Detail
  - ERROR_APPENDING
```
public static final String ERROR_APPENDING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataFrameColumn
```
public DataFrameColumn()
```
- Method Detail
  - getThis
```
protected abstract C getThis()
```
    Used to return the right column type for
    
    Returns:
    
    self
  - transform
```
public <R extends DataFrameColumn<?,R>> R transform(ColumnTransform<C,R> transformer)
```
    Used to apply transformations on a column
    
    Type Parameters:
    
    R - type of resulting column
    
    Parameters:
    
    transformer - column transformer
    
    Returns:
    
    resulting column
  - transform
```
public DataFrame transform(ColumnDataFrameTransform<C> transformer)
```
    Used to apply transformations on a column
    
    Parameters:
    
    transformer - column transformer
    
    Returns:
    
    resulting column
  - doSort
```
protected abstract void doSort(Comparator<T> comparator)
```
    Used by sort(Comparator) to sort the values in this column
    
    Parameters:
    
    comparator - sort comparator
    
    See Also:
    
    sort()
  - sort
```
public final C sort(Comparator<T> comparator)
```
    Sorts values in the column using a provided comparator
    Calls notifyDataFrameValueChanged(int) to ensure data frame index consistency
    
    Parameters:
    
    comparator - the comparator used to sort the column values
    
    Returns:
    
    self for method chaining
  - doSort
```
protected abstract void doSort()
```
    Used by sort() to sort the column values by their natural ordering
    
    See Also:
    
    sort()
  - sort
```
public final C sort()
```
    Sorts the column values by their natural ordering
    Calls notifyDataFrameValueChanged(int) to ensure data frame index consistency
    
    Returns:
    
    self for method chaining
  - toDouble
```
public Double toDouble(int index)
```
    Returns the double value at a specified index. If no double value is found, the value is parsed to double If the value could not be parsed Double.NaN is returned
    
    Parameters:
    
    index - index of value
    
    Returns:
    
    double value
  - getName
```
public String getName()
```
    Returns the name of this column
    
    Returns:
    
    name of this column
  - setName
```
public void setName(String name)
```
    Sets the name of this column.
    
    Parameters:
    
    name - new name of this column
  - getParser
```
public abstract Parser<T> getParser()
```
    Returns a Parser for the type of the values in this column.
    
    Returns:
    
    parser for the value type in this column
  - getType
```
public abstract Class<T> getType()
```
    Returns the type of the values in this column. The type needs to extend Comparable
    
    Returns:
    
    type of the values in this column
  - doSet
```
protected abstract void doSet(int index,
                              T value)
```
    Used by set(int, Comparable) to set a value at a specified index
    
    Parameters:
    
    index - index of the new value
    
    value - value to be doSet
    
    See Also:
    
    set(int, Comparable)
  - set
```
public final C set(int index,
                   T value)
```
    Sets a value at a specified index.
    Calls notifyDataFrameValueChanged(int) to ensure data frame index consistency
    
    Parameters:
    
    index - index of the new value
    
    value - value to be doSet
    
    Returns:
    
    self for method chaining
  - doMap
```
protected abstract void doMap(MapFunction<T> mapFunction)
```
    Used by map(MapFunction). A map function is applied to the values in this column.
    
    Parameters:
    
    mapFunction - function applied to each value
    
    See Also:
    
    map(MapFunction)
  - map
```
public final C map(MapFunction<T> mapFunction)
```
    A map function is applied to the values in this column. MapFunction.map(Object) is called for each value.
    CallsnotifyDataFrameColumnChanged() to ensure data frame index consistency
    
    Parameters:
    
    mapFunction - The function applied to each value
    
    Returns:
    
    self for method chaining
  - doReverse
```
protected abstract void doReverse()
```
    Used by reverse() to reverse the order of this column
  - reverse
```
public final C reverse()
```
    Reverses the order of the column values
    CallsnotifyDataFrameColumnChanged() to ensure data frame index consistency
    
    Returns:
    
    self for method chaining
  - get
```
public abstract T get(int index)
```
    Returns the value at a specified index
    
    Parameters:
    
    index - Index of the returned value
    
    Returns:
    
    Value at the specified index
  - copy
```
public abstract C copy()
```
    Creates a copy of this column
    
    Returns:
    
    The copy of this column
  - clear
```
public abstract void clear()
```
    Clears this column. All values are removed and the size is doSet to 0
  - toArray
```
public abstract T[] toArray(T[] a)
```
    Copies the values of this column to a specified array of the same type. The size of the array and the column size must be equal.
    
    Parameters:
    
    a - The array the values are copied to
    
    Returns:
    
    the array with the copied values.
  - toArray
```
public abstract Comparable[] toArray()
```
    Returns an Comparable array that contains all values of this column.
    
    Returns:
    
    Object array with all column values
  - containsAll
```
public abstract boolean containsAll(Collection<?> c)
```
    Returns true if all values of a specified collection are present in this column.
    
    Parameters:
    
    c - Collection that contains the tested values
    
    Returns:
    
    true if all values are present in this column
  - contains
```
public abstract boolean contains(T o)
```
    Returns true if the specified value exists in this column.
    
    Parameters:
    
    o - value that is tested
    
    Returns:
    
    true if this column contains the specified value
  - doAppend
```
protected abstract boolean doAppend(T value)
```
    Used by append(Comparable) to append a value to this column.
    
    Parameters:
    
    value - value to be appended
    
    Returns:
    
    true if the value is successfully appended
  - getValueFromRow
```
public abstract <H> T getValueFromRow(Row<?,H> row,
                                      H headerName)
```
  - getValueFromRow
```
public abstract T getValueFromRow(Row<?,?> row,
                                  int headerIdex)
```
  - append
```
public final boolean append(T value)
```
    A new value is appended at the end of this column using doAppend(Comparable).
    CallsvalidateAppend() to ensure data frame index consistency
    
    Parameters:
    
    value - value to be appended
    
    Returns:
    
    true if the value is successfully appended
    
    See Also:
    
    validateAppend()
  - append
```
public final <H> boolean append(Row<?,H> row,
                                H headerName)
```
    A new value is appended at the end of this column using doAppend(Comparable).
    CallsvalidateAppend() to ensure data frame index consistency
    
    Parameters:
    
    row - row containing the value
    
    headerName - headerName of the value within the row
    
    Returns:
    
    true if the value is successfully appended
    
    See Also:
    
    validateAppend()
  - append
```
public final boolean append(Row<?,?> row,
                            int index)
```
    A new value is appended at the end of this column using doAppend(Comparable).
    CallsvalidateAppend() to ensure data frame index consistency
    
    Parameters:
    
    row - row containing the value
    
    index - index of the value within the row
    
    Returns:
    
    true if the value is successfully appended
    
    See Also:
    
    validateAppend()
  - append
```
protected final boolean append(Object value)
```
    Append a value at the end of this column. Value is first casted to the correct type. This method throws a RuntimeException if anything goes wrong.
    
    Parameters:
    
    value - value to be appended
    
    Returns:
    
    true if the value is successfully appended
    
    See Also:
    
    append(Comparable)
  - doAppendAll
```
protected abstract boolean doAppendAll(Collection<? extends T> c)
```
    Used by appendAll(Collection)} to append a collection of values.
    
    Parameters:
    
    c - collection containing values to be added to this column
    
    Returns:
    
    true if the value is successfully appended
    
    See Also:
    
    append(Comparable)
  - appendAll
```
public final boolean appendAll(Collection<? extends T> c)
```
    Appends all values of in a collection to this column.
    Calls validateAppend() to ensure data frame index consistency
    
    Parameters:
    
    c - collection containing values to be added to this column
    
    Returns:
    
    true if all values are appended successfully
    
    See Also:
    
    append(Comparable)
  - doAppendNA
```
protected abstract boolean doAppendNA()
```
    Used by appendNA() to append NA at the end of this column.
    
    Returns:
    
    true if value was appended successfully
    
    See Also:
    
    appendNA()
  - appendNA
```
public final boolean appendNA()
```
    Appends a NA value to the end of this column.
    Calls validateAppend() to ensure data frame index consistency
    
    Returns:
    
    true if value was appended successfully
  - size
```
public abstract int size()
```
    Returns the number of values in this column.
    
    Returns:
    
    Number of values in this column
  - isEmpty
```
public abstract boolean isEmpty()
```
    Returns true if this column contains no values.
    
    Returns:
    
    true if this column is empty.
  - isNA
```
public abstract boolean isNA(int index)
```
    Returns true if the value at the specified index equals NA.
    
    Parameters:
    
    index - index to be tested for NA
    
    Returns:
    
    true if the specified index is NA
  - doSetNA
```
protected abstract void doSetNA(int index)
```
    Used by setNA(int) to set a specified index to NA.
    
    Parameters:
    
    index - index to be doSet to NA
  - setNA
```
public final C setNA(int index)
```
    Sets the value at a specified index to NA.
    Calls notifyDataFrameValueChanged(int) to ensure data frame index consistency
    
    Parameters:
    
    index - index to be set NA
    
    Returns:
    
    self for method chaining
  - validateAppend
```
public void validateAppend()
                    throws DataFrameException
```
    Throws an exception if appending is currently not allowed. Appending is not allowed if the column is part of a data frame. This step is necessary to ensure consistency of indices in the data frame.
    
    Throws:
    
    DataFrameException - Exception thrown if appending is not allowed
  - notifyDataFrameValueChanged
```
public void notifyDataFrameValueChanged(int index)
```
    Notifies the parent data frame about a value change at a specified index. This tells the data frame to update the indices if required.
    
    Parameters:
    
    index - index of the changed value
  - notifyDataFrameColumnChanged
```
public void notifyDataFrameColumnChanged()
```
    Notifies the parent data frame that this column changed. This tells the data frame to update the indices if required.
  - startDataFrameAppend
```
protected void startDataFrameAppend()
```
    Internal method used by the parent data frame to enable appending.
  - endDataFrameAppend
```
protected void endDataFrameAppend()
```
    Internal method used by the parent data frame to disable appending.
  - getDataFrame
```
public DataFrame getDataFrame()
```
    Returns the parent data frame
    
    Returns:
    
    parent data frame
  - setDataFrame
```
protected void setDataFrame(DataFrame dataFrame)
                     throws DataFrameException
```
    Used internally by the data frame. Sets the parent data frame. Columns can only be part of one data frame. Throws an exception if this column is already appended to an other data frame.
    
    Parameters:
    
    dataFrame - parent data frame
    
    Throws:
    
    DataFrameException - thrown if column already assigned to other data frame

Class DataFrameColumn<T extends Comparable<T>,C extends DataFrameColumn<T,C>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

ERROR_APPENDING

Constructor Detail

DataFrameColumn

Method Detail

getThis

transform

transform

doSort

sort

doSort

sort

toDouble

getName

setName

getParser

getType

doSet

set

doMap

map

doReverse

reverse

get

copy

clear

toArray

toArray

containsAll

contains

doAppend

getValueFromRow

getValueFromRow

append

append

append

append

doAppendAll

appendAll

doAppendNA

appendNA

size

isEmpty

isNA

doSetNA

setNA

validateAppend

notifyDataFrameValueChanged

notifyDataFrameColumnChanged

startDataFrameAppend

endDataFrameAppend

getDataFrame

setDataFrame