Column (tablesaw-core 0.24.7 API)

All Known Subinterfaces:

BooleanColumnUtils, BooleanMapUtils, CategoricalColumn, DateFilters, DateMapFunctions, DateTimeFilters, DateTimeMapFunctions, NumberColumn, NumberFilters, NumberMapFunctions, NumberPredicates, StringFilters, StringMapFunctions, StringReduceUtils, TimeFilters, TimeMapFunctions

All Known Implementing Classes:

AbstractColumn, BooleanColumn, DateColumn, DateTimeColumn, DoubleColumn, StringColumn, TimeColumn
```
public interface Column
```
The general interface for columns.
Columns can either exist on their own or be a part of a table. All the data in a single column is of a particular type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`append(Column column)`
`Column`	`appendCell(String stringValue)`
`Column`	`appendCell(String stringValue, StringParser parser)`
`Column`	`appendMissing()` Appends a missing value appropriate to the column
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[].
`double[]`	`asDoubleArray()`
`Object[]`	`asObjectArray()`
`int`	`byteSize()` Returns the width of a cell in this column, in bytes.
`void`	`clear()`
`int`	`columnWidth()` Returns the width of the column in characters, for printing
`Column`	`copy()` Returns a deep copy of the receiver
`int`	`countMissing()` Returns the count of missing values in this column.
`default int`	`countUnique()` Returns the count of unique values in this column.
`static Column`	`create(String columnName, ColumnType type)`
`Column`	`emptyCopy()` Returns a copy of the receiver with no data.
`Column`	`emptyCopy(int rowSize)` Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
`default Column`	`first(int numRows)`
`double`	`getDouble(int row)` Returns a double representation of the value at the given row.
`Object`	`getObject(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int r)`
`default Column`	`inRange(int start, int end)` Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isMissing()`
`boolean`	`isMissing(int rowNumber)`
`Selection`	`isNotMissing()`
`Column`	`lag(int n)` Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`default Column`	`last(int numRows)`
`default Column`	`lead(int n)` Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
`String`	`name()` Returns the column's name.
`String`	`print()` TODO(lwhite): Print n from the top and bottom, like a table;
`Column`	`removeMissing()`
`default RollingColumn`	`rolling(int windowSize)`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`default Column`	`rows(int... indices)` Returns a column containing the values in this column with the given indices
`default Column`	`sampleN(int n)` Returns a column containing a random sample of the values in this column
`default Column`	`sampleX(double proportion)` Returns a table consisting of randomly selected values from this column.
`Column`	`setName(String name)` Sets the columns name to the given string
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`default Column`	`subset(Selection rows)`
`default double`	`summarizeIf(Selection selection, AggregateFunction function)`
`Table`	`summary()`
`default String`	`title()`
`ColumnType`	`type()` Returns this column's ColumnType
`Column`	`unique()` Returns a column of the same type as the receiver, containing only the unique values of the receiver.
`Column`	`where(Selection selection)`

- Method Detail
  - create
```
static Column create(String columnName,
                     ColumnType type)
```
  - size
```
int size()
```
  - summary
```
Table summary()
```
  - asObjectArray
```
Object[] asObjectArray()
```
  - subset
```
default Column subset(Selection rows)
```
  - summarizeIf
```
default double summarizeIf(Selection selection,
                           AggregateFunction function)
```
  - countMissing
```
int countMissing()
```
    Returns the count of missing values in this column.
    
    Returns:
    
    missing values as int
  - countUnique
```
default int countUnique()
```
    Returns the count of unique values in this column.
    
    Returns:
    
    unique values as int
  - unique
```
Column unique()
```
    Returns a column of the same type as the receiver, containing only the unique values of the receiver.
    
    Returns:
    
    a Column
  - lead
```
default Column lead(int n)
```
    Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
  - lag
```
Column lag(int n)
```
    Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
    For example if you lag a column containing 2, 3, 4 by 1, you get a column containing NA, 2, 3
  - name
```
String name()
```
    Returns the column's name.
    
    Returns:
    
    name as String
  - setName
```
Column setName(String name)
```
    Sets the columns name to the given string
    
    Parameters:
    
    name - The new name MUST be unique for any table containing this column
    
    Returns:
    
    this Column to allow method chaining
  - type
```
ColumnType type()
```
    Returns this column's ColumnType
    
    Returns:
    
    ColumnType
  - getString
```
String getString(int row)
```
    Returns a string representation of the value at the given row.
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getDouble
```
double getDouble(int row)
```
    Returns a double representation of the value at the given row. The nature of the returned value is column-specific. The double returned MAY be the actual value (for Number columns) but is more likely a number that maps to the column value in some way.
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - emptyCopy
```
Column emptyCopy()
```
    Returns a copy of the receiver with no data. The column name and type are the same.
    
    Returns:
    
    a empty copy of Column
  - copy
```
Column copy()
```
    Returns a deep copy of the receiver
    
    Returns:
    
    a Column
  - emptyCopy
```
Column emptyCopy(int rowSize)
```
    Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - clear
```
void clear()
```
  - sortAscending
```
void sortAscending()
```
  - sortDescending
```
void sortDescending()
```
  - isEmpty
```
boolean isEmpty()
```
    Returns true if the column has no data
    
    Returns:
    
    true if empty, false if not
  - appendCell
```
Column appendCell(String stringValue)
```
  - appendCell
```
Column appendCell(String stringValue,
                  StringParser parser)
```
  - rowComparator
```
it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
  - append
```
void append(Column column)
```
  - first
```
default Column first(int numRows)
```
  - last
```
default Column last(int numRows)
```
  - print
```
String print()
```
    TODO(lwhite): Print n from the top and bottom, like a table;
  - title
```
default String title()
```
  - asDoubleArray
```
double[] asDoubleArray()
```
  - columnWidth
```
int columnWidth()
```
    Returns the width of the column in characters, for printing
  - inRange
```
default Column inRange(int start,
                       int end)
```
    Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
  - rows
```
default Column rows(int... indices)
```
    Returns a column containing the values in this column with the given indices
  - sampleN
```
default Column sampleN(int n)
```
    Returns a column containing a random sample of the values in this column
    
    Parameters:
    
    n - the number of values to select
    
    Returns:
    
    A column of the same type as the receiver
  - sampleX
```
default Column sampleX(double proportion)
```
    Returns a table consisting of randomly selected values from this column. The sample size is based on the given proportion of the total number of cells in this column
    
    Parameters:
    
    proportion - The proportion to go in the sample
  - isMissing
```
Selection isMissing()
```
  - isNotMissing
```
Selection isNotMissing()
```
  - byteSize
```
int byteSize()
```
    Returns the width of a cell in this column, in bytes.
    
    Returns:
    
    width in bytes
  - asBytes
```
byte[] asBytes(int rowNumber)
```
    Returns the contents of the cell at rowNumber as a byte[].
    
    Parameters:
    
    rowNumber - index of the row
    
    Returns:
    
    content as byte[]
  - rolling
```
default RollingColumn rolling(int windowSize)
```
  - getUnformattedString
```
String getUnformattedString(int r)
```
  - isMissing
```
boolean isMissing(int rowNumber)
```
  - appendMissing
```
Column appendMissing()
```
    Appends a missing value appropriate to the column
  - where
```
Column where(Selection selection)
```
  - removeMissing
```
Column removeMissing()
```
  - getObject
```
Object getObject(int index)
```

Interface Column

Method Summary

Method Detail

create

size

summary

asObjectArray

subset

summarizeIf

countMissing

countUnique

unique

lead

lag

name

setName

type

getString

getDouble

emptyCopy

copy

emptyCopy

clear

sortAscending

sortDescending

isEmpty

appendCell

appendCell

rowComparator

append

first

last

print

title

asDoubleArray

columnWidth

inRange

rows

sampleN

sampleX

isMissing

isNotMissing

byteSize

asBytes

rolling

getUnformattedString

isMissing

appendMissing

where

removeMissing

getObject