DateColumn (tablesaw-core 0.12.0 API)

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

All Implemented Interfaces:

Iterable<LocalDate>, Column, DateColumnUtils, DateMapUtils
```
public class DateColumn
extends AbstractColumn
implements DateMapUtils
```
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 interface tech.tablesaw.columns.DateColumnUtils
  isEqualTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isMissing, isNotMissing

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

Constructor Summary

Constructors
Constructor and Description
`DateColumn(ColumnMetadata metadata)`
`DateColumn(ColumnMetadata metadata, Locale locale)`
`DateColumn(String name)`
`DateColumn(String name, int initialSize)`
`DateColumn(String name, List<LocalDate> data)`
`DateColumn(String name, Locale locale)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(Column column)`
`void`	`append(LocalDate f)`
`void`	`appendCell(String string)`
`void`	`appendInternal(int f)`
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[]
`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.
`it.unimi.dsi.fastutil.ints.IntArrayList`	`data()`
`ShortColumn`	`dayOfMonth()`
`CategoryColumn`	`dayOfWeek()`
`ShortColumn`	`dayOfWeekValue()`
`ShortColumn`	`dayOfYear()`
`DateColumn`	`difference()` Returns a new column of the same type as the receiver, such that the values in the new column contain the difference between each cell in the original and it's predecessor.
`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.
`LocalDate`	`firstElement()`
`LocalDate`	`get(int index)`
`int`	`getIntInternal(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`it.unimi.dsi.fastutil.ints.IntIterator`	`intIterator()`
`Selection`	`isAfter(int value)`
`Selection`	`isAfter(LocalDate value)`
`Selection`	`isBefore(int value)`
`Selection`	`isBefore(LocalDate value)`
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isEqualTo(DateColumn column)` Returns a bitmap flagging the records for which the value in this column is equal to the value in the given column Columnwise isEqualTo.
`Selection`	`isEqualTo(LocalDate value)`
`Selection`	`isFirstDayOfMonth()`
`Selection`	`isFriday()`
`Selection`	`isInApril()`
`Selection`	`isInAugust()`
`Selection`	`isInDecember()`
`Selection`	`isInFebruary()`
`Selection`	`isInJanuary()`
`Selection`	`isInJuly()`
`Selection`	`isInJune()`
`Selection`	`isInMarch()`
`Selection`	`isInMay()`
`Selection`	`isInNovember()`
`Selection`	`isInOctober()`
`Selection`	`isInQ1()`
`Selection`	`isInQ2()`
`Selection`	`isInQ3()`
`Selection`	`isInQ4()`
`Selection`	`isInSeptember()`
`Selection`	`isInYear(int year)`
`Selection`	`isLastDayOfMonth()`
`Selection`	`isMissing()`
`Selection`	`isMonday()`
`Selection`	`isNotMissing()`
`Selection`	`isOnOrAfter(int value)`
`Selection`	`isOnOrAfter(LocalDate value)`
`Selection`	`isOnOrBefore(int value)`
`Selection`	`isOnOrBefore(LocalDate value)`
`Selection`	`isSaturday()`
`Selection`	`isSunday()`
`Selection`	`isThursday()`
`Selection`	`isTuesday()`
`Selection`	`isWednesday()`
`Iterator<LocalDate>`	`iterator()` Returns an iterator over elements of type `T`.
`LocalDate`	`max()`
`LocalDate`	`min()`
`CategoryColumn`	`month()`
`ShortColumn`	`monthValue()`
`String`	`print()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`Selection`	`select(IntBiPredicate predicate, int value)`
`Selection`	`select(IntPredicate predicate)`
`DateColumn`	`selectIf(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
`DateColumn`	`selectIf(LocalDatePredicate predicate)`
`void`	`set(int index, int value)`
`void`	`set(int index, LocalDate value)`
`void`	`set(LocalDate newValue, Selection rowSelection)` Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria Example: myColumn.set(LocalDate.now(), myColumn.isMissing()); // no more missing values
`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
`String`	`toString()`
`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.
`DateTimeColumn`	`with(TimeColumn timeColumn)`
`ShortColumn`	`year()`
`CategoryColumn`	`yearMonthString()` Returns a CategoryColumn with the year and month from this column concatenated into a String that will sort lexicographically in temporal order.

Methods inherited from class tech.tablesaw.columns.AbstractColumn
columnMetadata, columnWidth, comment, id, metadata, name, setComment, setName

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

Methods inherited from interface tech.tablesaw.mapping.DateMapUtils
atStartOfDay, atTime, atTime, dateColumnName, difference, differenceInDays, differenceInMonths, differenceInWeeks, differenceInYears, minus, minusDays, minusMonths, minusWeeks, minusYears, plus, plusDays, plusMonths, plusWeeks, plusYears

Methods inherited from interface tech.tablesaw.columns.Column
asDoubleArray, columnMetadata, columnWidth, comment, first, first, id, last, last, metadata, name, rolling, setComment, setName, subset, title

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

- Field Detail
  - MISSING_VALUE
```
public static final int MISSING_VALUE
```
- Constructor Detail
  - DateColumn
```
public DateColumn(String name)
```
  - DateColumn
```
public DateColumn(String name,
                  Locale locale)
```
  - DateColumn
```
public DateColumn(String name,
                  int initialSize)
```
  - DateColumn
```
public DateColumn(String name,
                  List<LocalDate> data)
```
  - DateColumn
```
public DateColumn(ColumnMetadata metadata)
```
  - DateColumn
```
public DateColumn(ColumnMetadata metadata,
                  Locale locale)
```
- Method Detail
  - 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
    
    Returns:
    
    ColumnType
  - appendInternal
```
public void appendInternal(int f)
```
  - data
```
public it.unimi.dsi.fastutil.ints.IntArrayList data()
```
    Specified by:
    
    data in interface DateColumnUtils
  - set
```
public void set(int index,
                int value)
```
  - set
```
public void set(int index,
                LocalDate value)
```
  - append
```
public void append(LocalDate f)
```
  - 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
  - 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
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface 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
  - 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()
```
  - min
```
public LocalDate min()
```
  - dayOfWeek
```
public CategoryColumn dayOfWeek()
```
  - set
```
public void set(LocalDate newValue,
                Selection rowSelection)
```
    Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria Example: myColumn.set(LocalDate.now(), myColumn.isMissing()); // no more missing values
  - dayOfWeekValue
```
public ShortColumn dayOfWeekValue()
```
  - dayOfMonth
```
public ShortColumn dayOfMonth()
```
  - dayOfYear
```
public ShortColumn dayOfYear()
```
  - monthValue
```
public ShortColumn monthValue()
```
  - yearMonthString
```
public CategoryColumn yearMonthString()
```
    Returns a CategoryColumn with the year and month from this column concatenated into a String that will sort lexicographically in temporal order. This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - month
```
public CategoryColumn month()
```
  - year
```
public ShortColumn year()
```
  - get
```
public LocalDate get(int index)
```
    Specified by:
    
    get in interface DateMapUtils
  - 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 void 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 DateMapUtils
  - isEqualTo
```
public Selection isEqualTo(LocalDate value)
```
  - isEqualTo
```
public Selection isEqualTo(DateColumn column)
```
    Returns a bitmap flagging the records for which the value in this column is equal to the value in the given column Columnwise isEqualTo.
  - 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
  - isAfter
```
public Selection isAfter(int value)
```
  - isAfter
```
public Selection isAfter(LocalDate value)
```
  - isBefore
```
public Selection isBefore(int value)
```
  - isBefore
```
public Selection isBefore(LocalDate value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(LocalDate value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(int value)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(LocalDate value)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(int value)
```
  - isMonday
```
public Selection isMonday()
```
  - isTuesday
```
public Selection isTuesday()
```
  - isWednesday
```
public Selection isWednesday()
```
  - isThursday
```
public Selection isThursday()
```
  - isFriday
```
public Selection isFriday()
```
  - isSaturday
```
public Selection isSaturday()
```
  - isSunday
```
public Selection isSunday()
```
  - isInJanuary
```
public Selection isInJanuary()
```
  - isInFebruary
```
public Selection isInFebruary()
```
  - isInMarch
```
public Selection isInMarch()
```
  - isInApril
```
public Selection isInApril()
```
  - isInMay
```
public Selection isInMay()
```
  - isInJune
```
public Selection isInJune()
```
  - isInJuly
```
public Selection isInJuly()
```
  - isInAugust
```
public Selection isInAugust()
```
  - isInSeptember
```
public Selection isInSeptember()
```
  - isInOctober
```
public Selection isInOctober()
```
  - isInNovember
```
public Selection isInNovember()
```
  - isInDecember
```
public Selection isInDecember()
```
  - isFirstDayOfMonth
```
public Selection isFirstDayOfMonth()
```
  - isLastDayOfMonth
```
public Selection isLastDayOfMonth()
```
  - isInQ1
```
public Selection isInQ1()
```
  - isInQ2
```
public Selection isInQ2()
```
  - isInQ3
```
public Selection isInQ3()
```
  - isInQ4
```
public Selection isInQ4()
```
  - isInYear
```
public Selection isInYear(int year)
```
  - print
```
public String print()
```
    Specified by:
    
    print in interface Column
  - isMissing
```
public Selection isMissing()
```
    Specified by:
    
    isMissing in interface Column
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column
    
    Returns:
    
    missing values as int
  - isNotMissing
```
public Selection isNotMissing()
```
    Specified by:
    
    isNotMissing in interface Column
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - append
```
public void append(Column column)
```
    Specified by:
    
    append in interface Column
  - selectIf
```
public DateColumn selectIf(LocalDatePredicate predicate)
```
  - selectIf
```
public DateColumn selectIf(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
  - 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()
```
  - select
```
public Selection select(IntPredicate predicate)
```
  - select
```
public Selection select(IntBiPredicate predicate,
                        int value)
```
  - asList
```
public List<LocalDate> asList()
```
  - asSet
```
public Set<LocalDate> asSet()
```
  - with
```
public DateTimeColumn with(TimeColumn timeColumn)
```
  - contains
```
public boolean contains(LocalDate localDate)
```
  - 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.
  - difference
```
public DateColumn difference()
```
    Description copied from interface: Column
    
    Returns a new column of the same type as the receiver, such that the values in the new column contain the difference between each cell in the original and it's predecessor. The Missing Value Indicator is used for the first cell in the new column. (e.g. IntColumn.MISSING_VALUE)
    
    Specified by:
    
    difference in interface Column
    
    Overrides:
    
    difference in class AbstractColumn
    
    Returns:
    
    a Column

Class DateColumn

Field Summary

Fields inherited from interface tech.tablesaw.columns.DateColumnUtils

Constructor Summary

Method Summary

Methods inherited from class tech.tablesaw.columns.AbstractColumn

Methods inherited from class java.lang.Object

Methods inherited from interface tech.tablesaw.mapping.DateMapUtils

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Constructor Detail

DateColumn

DateColumn

DateColumn

DateColumn

DateColumn

DateColumn

Method Detail

size

type

appendInternal

data

set

set

append

getString

emptyCopy

emptyCopy

clear

copy

sortAscending

sortDescending

countUnique

unique

firstElement

max

min

dayOfWeek

set

dayOfWeekValue

dayOfMonth

dayOfYear

monthValue

yearMonthString

month

year

get

isEmpty

rowComparator

convert

appendCell

getIntInternal

isEqualTo

isEqualTo

summary

isAfter

isAfter

isBefore

isBefore

isOnOrBefore

isOnOrBefore

isOnOrAfter

isOnOrAfter

isMonday

isTuesday

isWednesday

isThursday

isFriday

isSaturday

isSunday

isInJanuary

isInFebruary

isInMarch

isInApril

isInMay

isInJune

isInJuly

isInAugust