DateColumn (tablesaw-core 0.23.1 API)

java.lang.Object
- tech.tablesaw.columns.AbstractColumn
- - tech.tablesaw.api.DateColumn

All Implemented Interfaces:

Iterable<LocalDate>, CategoricalColumn, Column, DateFillers<DateColumn>, DateFilters, DateMapFunctions
```
public class DateColumn
extends AbstractColumn
implements DateFilters, DateFillers<DateColumn>, DateMapFunctions, CategoricalColumn, Iterable<LocalDate>
```
A column in a base table that contains float values

Field Summary

Fields
Modifier and Type Field and Description

static int MISSING_VALUE
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`MISSING_VALUE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(Column column)`
`DateColumn`	`append(LocalDate f)`
`DateColumn`	`appendCell(String string)`
`DateColumn`	`appendInternal(int f)`
`DateColumn`	`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()`
`int[]`	`asIntArray()`
`List<LocalDate>`	`asList()`
`Set<LocalDate>`	`asSet()`
`List<LocalDate>`	`bottom(int n)` Returns the smallest ("bottom") n values in the column
`int`	`byteSize()` Returns the width of a cell in this column, in bytes.
`void`	`clear()`
`boolean`	`contains(LocalDate localDate)`
`int`	`convert(String value)` Returns a PackedDate as converted from the given string
`DateColumn`	`copy()` Returns a deep copy of the receiver
`int`	`countMissing()` Returns the count of missing values in this column
`int`	`countUnique()` Returns the count of unique values in this column.
`static DateColumn`	`create(String name)`
`static DateColumn`	`create(String name, int initialSize)`
`static DateColumn`	`create(String name, int initialSize, Locale locale)`
`static DateColumn`	`create(String name, List<LocalDate> data)`
`static DateColumn`	`create(String name, LocalDate[] data)`
`static DateColumn`	`create(String name, Locale locale)`
`it.unimi.dsi.fastutil.ints.IntArrayList`	`data()`
`DateColumn`	`emptyCopy()` Returns a copy of the receiver with no data.
`DateColumn`	`emptyCopy(int rowSize)` Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
`Selection`	`eval(BiPredicate<LocalDate,LocalDate> predicate, LocalDate valueToCompare)`
`Selection`	`eval(IntBiPredicate predicate, DateColumn otherColumn)`
`Selection`	`eval(IntBiPredicate predicate, int value)`
`Selection`	`eval(IntPredicate predicate)` This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes
`Selection`	`eval(Predicate<LocalDate> predicate)` Returns a selection formed by applying the given predicate
`DateColumn`	`fillWith(Iterable<LocalDate> iterable)`
`DateColumn`	`fillWith(Iterator<LocalDate> iterator)`
`DateColumn`	`fillWith(Supplier<LocalDate> supplier)`
`LocalDate`	`firstElement()`
`LocalDate`	`get(int index)`
`double`	`getDouble(int i)` Returns a double representation of the value at the given row.
`int`	`getIntInternal(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int row)`
`it.unimi.dsi.fastutil.ints.IntIterator`	`intIterator()`
`boolean`	`isEmpty()` Returns true if the column has no data
`boolean`	`isMissing(int rowNumber)`
`Iterator<LocalDate>`	`iterator()` Returns an iterator over elements of type `T`.
`DateColumn`	`lag(int n)` Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`DateColumn`	`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.
`LocalDate`	`max()`
`LocalDate`	`min()`
`DateColumn`	`removeMissing()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`DateColumn`	`set(int index, int value)`
`DateColumn`	`set(int index, LocalDate value)`
`DateColumn`	`set(Selection rowSelection, LocalDate newValue)` Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
`void`	`setFormatter(DateTimeFormatter formatter)`
`void`	`setPrintFormatter(DateTimeFormatter dateTimeFormatter)`
`void`	`setPrintFormatter(DateTimeFormatter dateTimeFormatter, String missingValueString)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`Table`	`summary()` Returns a table of dates and the number of observations of those dates
`List<LocalDate>`	`top(int n)` Returns the largest ("top") n values in the column
`ColumnType`	`type()` Returns this column's ColumnType
`DateColumn`	`unique()` Returns a column of the same type as the receiver, containing only the unique values of the receiver.
`static boolean`	`valueIsMissing(int i)`
`DateColumn`	`where(Selection selection)`

Methods inherited from class tech.tablesaw.columns.AbstractColumn
columnWidth, name, print, setName, toString

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

Methods inherited from interface tech.tablesaw.columns.dates.DateFilters
isAfter, isAfter, isAfter, isBefore, isBefore, isBefore, isBetweenExcluding, isBetweenExcluding, isBetweenIncluding, isBetweenIncluding, isEqualTo, isEqualTo, isEqualTo, isFirstDayOfMonth, isFriday, isInApril, isInAugust, isInDecember, isInFebruary, isInJanuary, isInJuly, isInJune, isInMarch, isInMay, isInNovember, isInOctober, isInQ1, isInQ2, isInQ3, isInQ4, isInSeptember, isInYear, isLastDayOfMonth, isMissing, isMonday, isNotEqualTo, isNotMissing, isOnOrAfter, isOnOrAfter, isOnOrBefore, isOnOrBefore, isSaturday, isSunday, isThursday, isTuesday, isWednesday

Methods inherited from interface tech.tablesaw.columns.dates.DateMapFunctions
atStartOfDay, atTime, atTime, dateColumnName, dayOfMonth, dayOfWeek, dayOfWeekValue, dayOfYear, daysUntil, minus, minusDays, minusMonths, minusWeeks, minusYears, month, monthsUntil, monthValue, plus, plusDays, plusMonths, plusWeeks, plusYears, timeUntil, timeWindow, timeWindow, weeksUntil, year, yearDay, yearMonth, yearQuarter, yearsUntil, yearWeek

Methods inherited from interface tech.tablesaw.api.CategoricalColumn
countByCategory

Methods inherited from interface tech.tablesaw.columns.Column
columnWidth, create, first, inRange, last, name, print, rolling, rows, sampleN, sampleX, setName, subset, summarizeIf, title

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

- Field Detail
  - MISSING_VALUE
```
public static final int MISSING_VALUE
```
- Method Detail
  - setFormatter
```
public void setFormatter(DateTimeFormatter formatter)
```
  - create
```
public static DateColumn create(String name)
```
  - create
```
public static DateColumn create(String name,
                                Locale locale)
```
  - create
```
public static DateColumn create(String name,
                                int initialSize,
                                Locale locale)
```
  - create
```
public static DateColumn create(String name,
                                int initialSize)
```
  - create
```
public static DateColumn create(String name,
                                List<LocalDate> data)
```
  - create
```
public static DateColumn create(String name,
                                LocalDate[] data)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Column
  - type
```
public ColumnType type()
```
    Description copied from interface: Column
    
    Returns this column's ColumnType
    
    Specified by:
    
    type in interface Column
    
    Overrides:
    
    type in class AbstractColumn
    
    Returns:
    
    ColumnType
  - appendInternal
```
public DateColumn appendInternal(int f)
```
  - data
```
public it.unimi.dsi.fastutil.ints.IntArrayList data()
```
    Specified by:
    
    data in interface DateFilters
  - set
```
public DateColumn set(int index,
                      int value)
```
  - set
```
public DateColumn set(int index,
                      LocalDate value)
```
  - append
```
public DateColumn append(LocalDate f)
```
  - setPrintFormatter
```
public void setPrintFormatter(DateTimeFormatter dateTimeFormatter,
                              String missingValueString)
```
  - setPrintFormatter
```
public void setPrintFormatter(DateTimeFormatter dateTimeFormatter)
```
  - getString
```
public String getString(int row)
```
    Description copied from interface: Column
    
    Returns a string representation of the value at the given row.
    
    Specified by:
    
    getString in interface Column
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString in interface Column
  - emptyCopy
```
public DateColumn emptyCopy()
```
    Description copied from interface: Column
    
    Returns a copy of the receiver with no data. The column name and type are the same.
    
    Specified by:
    
    emptyCopy in interface Column
    
    Returns:
    
    a empty copy of Column
  - emptyCopy
```
public DateColumn emptyCopy(int rowSize)
```
    Description copied from interface: Column
    
    Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
    
    Specified by:
    
    emptyCopy in interface Column
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - copy
```
public DateColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column
    
    Returns:
    
    a Column
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Column
  - lead
```
public DateColumn lead(int n)
```
    Description copied from interface: Column
    
    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.
    
    Specified by:
    
    lead in interface Column
  - lag
```
public DateColumn lag(int n)
```
    Description copied from interface: Column
    
    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
    
    Specified by:
    
    lag in interface Column
  - sortAscending
```
public void sortAscending()
```
    Specified by:
    
    sortAscending in interface Column
  - sortDescending
```
public void sortDescending()
```
    Specified by:
    
    sortDescending in interface Column
  - countUnique
```
public int countUnique()
```
    Description copied from interface: Column
    
    Returns the count of unique values in this column.
    
    Specified by:
    
    countUnique in interface Column
    
    Returns:
    
    unique values as int
  - unique
```
public DateColumn unique()
```
    Description copied from interface: Column
    
    Returns a column of the same type as the receiver, containing only the unique values of the receiver.
    
    Specified by:
    
    unique in interface Column
    
    Returns:
    
    a Column
  - firstElement
```
public LocalDate firstElement()
```
  - max
```
public LocalDate max()
```
    Specified by:
    
    max in interface DateMapFunctions
  - min
```
public LocalDate min()
```
    Specified by:
    
    min in interface DateMapFunctions
  - set
```
public DateColumn set(Selection rowSelection,
                      LocalDate newValue)
```
    Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
    Example: myColumn.set(myColumn.valueIsMissing(), LocalDate.now()); // no more missing values
  - appendMissing
```
public DateColumn appendMissing()
```
    Description copied from interface: Column
    
    Appends a missing value appropriate to the column
    
    Specified by:
    
    appendMissing in interface Column
  - get
```
public LocalDate get(int index)
```
    Specified by:
    
    get in interface DateMapFunctions
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Column
    
    Returns true if the column has no data
    
    Specified by:
    
    isEmpty in interface Column
    
    Returns:
    
    true if empty, false if not
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column
  - convert
```
public int convert(String value)
```
    Returns a PackedDate as converted from the given string
    
    Parameters:
    
    value - A string representation of a date
    
    Throws:
    
    DateTimeParseException - if no parser can be found for the date format
  - appendCell
```
public DateColumn appendCell(String string)
```
    Specified by:
    
    appendCell in interface Column
    
    Specified by:
    
    appendCell in class AbstractColumn
  - getIntInternal
```
public int getIntInternal(int index)
```
    Specified by:
    
    getIntInternal in interface DateMapFunctions
  - summary
```
public Table summary()
```
    Returns a table of dates and the number of observations of those dates
    
    Specified by:
    
    summary in interface Column
    
    Returns:
    
    the summary table
  - valueIsMissing
```
public static boolean valueIsMissing(int i)
```
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column
    
    Returns:
    
    missing values as int
  - append
```
public void append(Column column)
```
    Specified by:
    
    append in interface Column
  - top
```
public List<LocalDate> top(int n)
```
    Returns the largest ("top") n values in the column
    
    Parameters:
    
    n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column
    
    Returns:
    
    A list, possibly empty, of the largest observations
  - bottom
```
public List<LocalDate> bottom(int n)
```
    Returns the smallest ("bottom") n values in the column
    
    Parameters:
    
    n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column
    
    Returns:
    
    A list, possibly empty, of the smallest n observations
  - intIterator
```
public it.unimi.dsi.fastutil.ints.IntIterator intIterator()
```
  - removeMissing
```
public DateColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column
  - asList
```
public List<LocalDate> asList()
```
  - where
```
public DateColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column
    
    Specified by:
    
    where in interface DateFilters
  - eval
```
public Selection eval(IntPredicate predicate)
```
    This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes
    
    Specified by:
    
    eval in interface DateFilters
  - eval
```
public Selection eval(IntBiPredicate predicate,
                      int value)
```
    Specified by:
    
    eval in interface DateFilters
  - eval
```
public Selection eval(IntBiPredicate predicate,
                      DateColumn otherColumn)
```
  - eval
```
public Selection eval(BiPredicate<LocalDate,LocalDate> predicate,
                      LocalDate valueToCompare)
```
    Specified by:
    
    eval in interface DateFilters
  - eval
```
public Selection eval(Predicate<LocalDate> predicate)
```
    Description copied from interface: DateFilters
    
    Returns a selection formed by applying the given predicate
    Prefer using an IntPredicate where the int is a PackedDate, as this version creates a date object for each value in the column
    
    Specified by:
    
    eval in interface DateFilters
  - asSet
```
public Set<LocalDate> asSet()
```
  - contains
```
public boolean contains(LocalDate localDate)
```
  - asDoubleArray
```
public double[] asDoubleArray()
```
    Specified by:
    
    asDoubleArray in interface Column
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column
  - getDouble
```
public double getDouble(int i)
```
    Description copied from interface: Column
    
    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.
    
    Specified by:
    
    getDouble in interface Column
    
    Parameters:
    
    i - The index of the row.
    
    Returns:
    
    value as String
  - byteSize
```
public int byteSize()
```
    Description copied from interface: Column
    
    Returns the width of a cell in this column, in bytes.
    
    Specified by:
    
    byteSize in interface Column
    
    Returns:
    
    width in bytes
  - asBytes
```
public byte[] asBytes(int rowNumber)
```
    Returns the contents of the cell at rowNumber as a byte[]
    
    Specified by:
    
    asBytes in interface Column
    
    Parameters:
    
    rowNumber - the number of the row as int
    
    Returns:
    
    content as byte[]
  - iterator
```
public Iterator<LocalDate> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface Iterable<LocalDate>
    
    Returns:
    
    an Iterator.
  - fillWith
```
public DateColumn fillWith(Iterator<LocalDate> iterator)
```
    Specified by:
    
    fillWith in interface DateFillers<DateColumn>
  - fillWith
```
public DateColumn fillWith(Iterable<LocalDate> iterable)
```
    Specified by:
    
    fillWith in interface DateFillers<DateColumn>
  - fillWith
```
public DateColumn fillWith(Supplier<LocalDate> supplier)
```
    Specified by:
    
    fillWith in interface DateFillers<DateColumn>
  - asIntArray
```
public int[] asIntArray()
```
    Specified by:
    
    asIntArray in interface CategoricalColumn

Class DateColumn

Field Summary

Fields inherited from class tech.tablesaw.columns.AbstractColumn

Method Summary

Methods inherited from class tech.tablesaw.columns.AbstractColumn

Methods inherited from class java.lang.Object

Methods inherited from interface tech.tablesaw.columns.dates.DateFilters

Methods inherited from interface tech.tablesaw.columns.dates.DateMapFunctions

Methods inherited from interface tech.tablesaw.api.CategoricalColumn

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Method Detail

setFormatter

create

create

create

create

create

create

size

type

appendInternal

data

set

set

append

setPrintFormatter

setPrintFormatter

getString

getUnformattedString

emptyCopy

emptyCopy

copy

clear

lead

lag

sortAscending

sortDescending

countUnique

unique

firstElement

max

min

set

appendMissing

get

isEmpty

rowComparator

convert

appendCell

getIntInternal

summary

valueIsMissing

countMissing

append

top

bottom

intIterator

removeMissing

asList

where

eval

eval

eval

eval

eval

asSet

contains

asDoubleArray

isMissing

getDouble

byteSize

asBytes

iterator

fillWith

fillWith

fillWith

asIntArray