DateColumn

java.lang.Object
- org.datavec.dataframe.columns.AbstractColumn
- - org.datavec.dataframe.api.DateColumn

All Implemented Interfaces:

java.lang.Iterable<java.time.LocalDate>, Column, DateColumnUtils
```
public class DateColumn
extends AbstractColumn
implements DateColumnUtils
```
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 org.datavec.dataframe.columns.DateColumnUtils
  isMissing, isNotMissing

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

Constructor Summary

Constructors
Constructor and Description

DateColumn(ColumnMetadata metadata)

Constructors
Constructor and Description
`DateColumn(ColumnMetadata metadata)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int f)`
`void`	`add(java.time.LocalDate f)`
`void`	`addCell(java.lang.String string)`
`void`	`append(Column column)`
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[]
`java.util.Set<java.time.LocalDate>`	`asSet()`
`DateTimeColumn`	`atTime(TimeColumn c)` Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
`java.util.List<java.time.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(java.time.LocalDate localDate)`
`int`	`convert(java.lang.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(java.lang.String name)`
`static DateColumn`	`create(java.lang.String columnName, it.unimi.dsi.fastutil.ints.IntArrayList dates)`
`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
`java.time.LocalDate`	`firstElement()`
`java.time.LocalDate`	`get(int index)`
`int`	`getInt(int index)`
`java.lang.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(java.time.LocalDate value)`
`Selection`	`isBefore(int value)`
`Selection`	`isBefore(java.time.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(java.time.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(java.time.LocalDate value)`
`Selection`	`isOnOrBefore(int value)`
`Selection`	`isOnOrBefore(java.time.LocalDate value)`
`Selection`	`isSaturday()`
`Selection`	`isSunday()`
`Selection`	`isThursday()`
`Selection`	`isTuesday()`
`Selection`	`isWednesday()`
`java.util.Iterator<java.time.LocalDate>`	`iterator()` Returns an iterator over elements of type `T`.
`java.time.LocalDate`	`max()`
`java.time.LocalDate`	`min()`
`CategoryColumn`	`month()`
`ShortColumn`	`monthValue()`
`java.lang.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)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`Table`	`summary()` Returns a table of dates and the number of observations of those dates
`java.util.List<java.time.LocalDate>`	`top(int n)` Returns the largest ("top") n values in the column
`java.lang.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()`

Methods inherited from class org.datavec.dataframe.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 org.datavec.dataframe.columns.Column
columnMetadata, columnWidth, comment, first, first, id, last, last, metadata, name, setComment, setName, subset, title, toDoubleArray

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

- Field Detail
  - MISSING_VALUE
```
public static final int MISSING_VALUE
```
- Constructor Detail
  - DateColumn
```
public DateColumn(ColumnMetadata metadata)
```
- 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
  - add
```
public void add(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)
```
  - add
```
public void add(java.time.LocalDate f)
```
  - getString
```
public java.lang.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
  - 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
  - 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
  - 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
  - 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
  - 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
  - firstElement
```
public java.time.LocalDate firstElement()
```
  - max
```
public java.time.LocalDate max()
```
  - min
```
public java.time.LocalDate min()
```
  - dayOfWeek
```
public CategoryColumn dayOfWeek()
```
  - dayOfWeekValue
```
public ShortColumn dayOfWeekValue()
```
  - dayOfMonth
```
public ShortColumn dayOfMonth()
```
  - dayOfYear
```
public ShortColumn dayOfYear()
```
  - monthValue
```
public ShortColumn monthValue()
```
  - month
```
public CategoryColumn month()
```
  - year
```
public ShortColumn year()
```
  - get
```
public java.time.LocalDate get(int index)
```
  - create
```
public static DateColumn create(java.lang.String name)
```
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Column
    
    Returns true if the column has no data
    
    Specified by:
    
    isEmpty in interface Column
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column
  - create
```
public static DateColumn create(java.lang.String columnName,
                                it.unimi.dsi.fastutil.ints.IntArrayList dates)
```
  - convert
```
public int convert(java.lang.String value)
```
    Returns a PackedDate as converted from the given string
    
    Parameters:
    
    value - A string representation of a date
    
    Throws:
    
    java.time.format.DateTimeParseException - if no parser can be found for the date format
  - addCell
```
public void addCell(java.lang.String string)
```
    Specified by:
    
    addCell in interface Column
    
    Specified by:
    
    addCell in class AbstractColumn
  - getInt
```
public int getInt(int index)
```
  - isEqualTo
```
public Selection isEqualTo(java.time.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
  - atTime
```
public DateTimeColumn atTime(TimeColumn c)
```
    Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
  - isAfter
```
public Selection isAfter(int value)
```
  - isAfter
```
public Selection isAfter(java.time.LocalDate value)
```
  - isBefore
```
public Selection isBefore(int value)
```
  - isBefore
```
public Selection isBefore(java.time.LocalDate value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(java.time.LocalDate value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(int value)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(java.time.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 java.lang.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
  - isNotMissing
```
public Selection isNotMissing()
```
    Specified by:
    
    isNotMissing in interface Column
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.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 java.util.List<java.time.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 java.util.List<java.time.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)
```
  - asSet
```
public java.util.Set<java.time.LocalDate> asSet()
```
  - with
```
public DateTimeColumn with(TimeColumn timeColumn)
```
  - contains
```
public boolean contains(java.time.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
  - asBytes
```
public byte[] asBytes(int rowNumber)
```
    Returns the contents of the cell at rowNumber as a byte[]
    
    Specified by:
    
    asBytes in interface Column
  - iterator
```
public java.util.Iterator<java.time.LocalDate> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.time.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

Class DateColumn

Field Summary

Fields inherited from interface org.datavec.dataframe.columns.DateColumnUtils

Constructor Summary

Method Summary

Methods inherited from class org.datavec.dataframe.columns.AbstractColumn

Methods inherited from class java.lang.Object

Methods inherited from interface org.datavec.dataframe.columns.Column

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Constructor Detail

DateColumn

Method Detail

size

type

add

data

set

add

getString

emptyCopy

emptyCopy

clear

copy

sortAscending

sortDescending

countUnique

unique

firstElement

max

min

dayOfWeek

dayOfWeekValue

dayOfMonth

dayOfYear

monthValue

month

year

get

create

isEmpty

rowComparator

create

convert

addCell

getInt

isEqualTo

isEqualTo

summary

atTime

isAfter

isAfter

isBefore

isBefore

isOnOrBefore

isOnOrBefore

isOnOrAfter

isOnOrAfter

isMonday

isTuesday

isWednesday

isThursday

isFriday

isSaturday

isSunday

isInJanuary

isInFebruary

isInMarch

isInApril

isInMay

isInJune

isInJuly

isInAugust

isInSeptember

isInOctober

isInNovember

isInDecember

isFirstDayOfMonth

isLastDayOfMonth