DateTimeColumn

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

All Implemented Interfaces:

java.lang.Iterable<java.time.LocalDateTime>, Column, DateTImeColumnUtils, DateTimeMapUtils
```
public class DateTimeColumn
extends AbstractColumn
implements DateTimeMapUtils, java.lang.Iterable<java.time.LocalDateTime>
```
A column in a table that contains long-integer encoded (packed) local date-time values

Field Summary

Fields
Modifier and Type Field and Description

static long MISSING_VALUE
- Fields inherited from interface org.datavec.dataframe.columns.DateTImeColumnUtils
  isMissing, isNotMissing

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

Constructor Summary

Constructors
Constructor and Description

DateTimeColumn(ColumnMetadata metadata)

DateTimeColumn(java.lang.String name, int initialSize)

Constructors
Constructor and Description
`DateTimeColumn(ColumnMetadata metadata)`
`DateTimeColumn(java.lang.String name, int initialSize)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(java.time.LocalDateTime dateTime)`
`void`	`add(long dateTime)`
`void`	`addCell(java.lang.String stringValue)`
`void`	`append(Column column)`
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[]
`java.util.Set<java.time.LocalDateTime>`	`asSet()`
`java.util.List<java.time.LocalDateTime>`	`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.LocalDateTime dateTime)`
`long`	`convert(java.lang.String value)` Returns a PackedDateTime as converted from the given string
`DateTimeColumn`	`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 DateTimeColumn`	`create(java.lang.String name)`
`static DateTimeColumn`	`create(java.lang.String fileName, it.unimi.dsi.fastutil.longs.LongArrayList dateTimes)`
`it.unimi.dsi.fastutil.longs.LongArrayList`	`data()`
`DateColumn`	`date()` Returns a DateColumn containing the date portion of each dateTime in this DateTimeColumn
`ShortColumn`	`dayOfMonth()`
`CategoryColumn`	`dayOfWeek()`
`ShortColumn`	`dayOfWeekValue()`
`ShortColumn`	`dayOfYear()`
`DateTimeColumn`	`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.
`DateTimeColumn`	`emptyCopy()` Returns a copy of the receiver with no data.
`DateTimeColumn`	`emptyCopy(int rowSize)` Returns an empty copy of the receiver, with its internal storage initialized to the given row size
`java.time.LocalDateTime`	`get(int index)`
`long`	`getLong(int index)`
`java.lang.String`	`getString(int row)` Returns a string representation of the value at the given row
`Selection`	`isAfter(DateTimeColumn column)`
`Selection`	`isAfter(java.time.LocalDateTime value)`
`Selection`	`isAfterNoon()`
`Selection`	`isBefore(DateTimeColumn column)`
`Selection`	`isBefore(java.time.LocalDateTime value)`
`Selection`	`isBeforeNoon()`
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isEqualTo(DateTimeColumn column)`
`Selection`	`isEqualTo(java.time.LocalDateTime 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`	`isMidnight()`
`Selection`	`isMissing()`
`Selection`	`isMonday()`
`Selection`	`isNoon()`
`Selection`	`isNotMissing()`
`Selection`	`isOnOrAfter(long value)`
`Selection`	`isOnOrBefore(long value)`
`Selection`	`isSaturday()`
`Selection`	`isSunday()`
`Selection`	`isThursday()`
`Selection`	`isTuesday()`
`Selection`	`isWednesday()`
`java.util.Iterator<java.time.LocalDateTime>`	`iterator()` Returns an iterator over elements of type `T`.
`it.unimi.dsi.fastutil.longs.LongIterator`	`longIterator()`
`java.time.LocalDateTime`	`max()`
`java.time.LocalDateTime`	`min()`
`ShortColumn`	`minuteOfDay()`
`CategoryColumn`	`monthName()`
`ShortColumn`	`monthNumber()`
`java.lang.String`	`print()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`Selection`	`select(LongBiPredicate predicate, long value)`
`Selection`	`select(LongPredicate predicate)`
`DateTimeColumn`	`selectIf(LocalDateTimePredicate predicate)`
`DateTimeColumn`	`selectIf(LongPredicate predicate)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`Table`	`summary()`
`TimeColumn`	`time()` Returns a TimeColumn containing the time portion of each dateTime in this DateTimeColumn
`java.util.List<java.time.LocalDateTime>`	`top(int n)` Returns the largest ("top") n values in the column
`java.lang.String`	`toString()`
`ColumnType`	`type()` Returns this column's ColumnType
`DateTimeColumn`	`unique()` Returns a column of the same type as the receiver, containing only the unique values of the receiver
`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.mapping.DateTimeMapUtils
difference, difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, hour, secondOfDay

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 long MISSING_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DateTimeColumn
```
public DateTimeColumn(ColumnMetadata metadata)
```
  - DateTimeColumn
```
public DateTimeColumn(java.lang.String name,
                      int initialSize)
```
- Method Detail
  - addCell
```
public void addCell(java.lang.String stringValue)
```
    Specified by:
    
    addCell in interface Column
    
    Specified by:
    
    addCell in class AbstractColumn
  - add
```
public void add(java.time.LocalDateTime dateTime)
```
  - convert
```
public long convert(java.lang.String value)
```
    Returns a PackedDateTime as converted from the given string
    
    Parameters:
    
    value - A string representation of a time
    
    Throws:
    
    java.time.format.DateTimeParseException - if no parser can be found for the time format used
  - create
```
public static DateTimeColumn create(java.lang.String name)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Column
  - data
```
public it.unimi.dsi.fastutil.longs.LongArrayList data()
```
    Specified by:
    
    data in interface DateTImeColumnUtils
  - type
```
public ColumnType type()
```
    Description copied from interface: Column
    
    Returns this column's ColumnType
    
    Specified by:
    
    type in interface Column
  - add
```
public void add(long dateTime)
```
  - 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 DateTimeColumn 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 DateTimeColumn 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 DateTimeColumn 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
  - summary
```
public Table summary()
```
    Specified by:
    
    summary 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 DateTimeColumn 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
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Column
    
    Returns true if the column has no data
    
    Specified by:
    
    isEmpty in interface Column
  - getLong
```
public long getLong(int index)
```
    Specified by:
    
    getLong in interface DateTimeMapUtils
  - get
```
public java.time.LocalDateTime get(int index)
```
    Specified by:
    
    get in interface DateTimeMapUtils
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column
  - dayOfWeek
```
public CategoryColumn dayOfWeek()
```
  - dayOfWeekValue
```
public ShortColumn dayOfWeekValue()
```
  - dayOfYear
```
public ShortColumn dayOfYear()
```
  - dayOfMonth
```
public ShortColumn dayOfMonth()
```
  - time
```
public TimeColumn time()
```
    Returns a TimeColumn containing the time portion of each dateTime in this DateTimeColumn
  - date
```
public DateColumn date()
```
    Returns a DateColumn containing the date portion of each dateTime in this DateTimeColumn
  - monthNumber
```
public ShortColumn monthNumber()
```
  - monthName
```
public CategoryColumn monthName()
```
  - year
```
public ShortColumn year()
```
  - isEqualTo
```
public Selection isEqualTo(java.time.LocalDateTime value)
```
  - isEqualTo
```
public Selection isEqualTo(DateTimeColumn column)
```
  - isAfter
```
public Selection isAfter(java.time.LocalDateTime value)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(long value)
```
  - isBefore
```
public Selection isBefore(java.time.LocalDateTime value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(long value)
```
  - isAfter
```
public Selection isAfter(DateTimeColumn column)
```
  - isBefore
```
public Selection isBefore(DateTimeColumn column)
```
  - create
```
public static DateTimeColumn create(java.lang.String fileName,
                                    it.unimi.dsi.fastutil.longs.LongArrayList dateTimes)
```
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column
  - print
```
public java.lang.String print()
```
    Specified by:
    
    print in interface Column
  - isMissing
```
public Selection isMissing()
```
    Specified by:
    
    isMissing 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
  - max
```
public java.time.LocalDateTime max()
```
  - min
```
public java.time.LocalDateTime min()
```
  - minuteOfDay
```
public ShortColumn minuteOfDay()
```
    Specified by:
    
    minuteOfDay in interface DateTimeMapUtils
  - selectIf
```
public DateTimeColumn selectIf(LocalDateTimePredicate predicate)
```
  - selectIf
```
public DateTimeColumn selectIf(LongPredicate predicate)
```
  - 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()
```
  - isNoon
```
public Selection isNoon()
```
  - isMidnight
```
public Selection isMidnight()
```
  - isBeforeNoon
```
public Selection isBeforeNoon()
```
  - isAfterNoon
```
public Selection isAfterNoon()
```
  - select
```
public Selection select(LongPredicate predicate)
```
  - select
```
public Selection select(LongBiPredicate predicate,
                        long value)
```
  - top
```
public java.util.List<java.time.LocalDateTime> 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.LocalDateTime> 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
  - longIterator
```
public it.unimi.dsi.fastutil.longs.LongIterator longIterator()
```
  - asSet
```
public java.util.Set<java.time.LocalDateTime> asSet()
```
  - isInYear
```
public Selection isInYear(int year)
```
  - contains
```
public boolean contains(java.time.LocalDateTime dateTime)
```
  - 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.LocalDateTime> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.time.LocalDateTime>
    
    Returns:
    
    an Iterator.
  - difference
```
public DateTimeColumn 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 DateTimeColumn

Field Summary

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

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.mapping.DateTimeMapUtils

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

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Constructor Detail

DateTimeColumn

DateTimeColumn

Method Detail

addCell

add

convert

create

size

data

type

add

getString

emptyCopy

emptyCopy

clear

copy

sortAscending

sortDescending

summary

countUnique

unique

isEmpty

getLong

get

rowComparator

dayOfWeek

dayOfWeekValue

dayOfYear

dayOfMonth

time

date

monthNumber

monthName

year

isEqualTo

isEqualTo

isAfter

isOnOrAfter

isBefore

isOnOrBefore

isAfter

isBefore

create

countMissing

print

isMissing

isNotMissing

toString

append

max

min

minuteOfDay

selectIf

selectIf

isMonday

isTuesday

isWednesday

isThursday

isFriday

isSaturday

isSunday

isInJanuary

isInFebruary

isInMarch

isInApril

isInMay

isInJune