DateTimeColumn (tablesaw-core 0.12.0 API)

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

All Implemented Interfaces:

Iterable<LocalDateTime>, Column, DateTimeColumnUtils, DateTimeMapUtils
```
public class DateTimeColumn
extends AbstractColumn
implements DateTimeMapUtils, Iterable<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 tech.tablesaw.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(String name)`
`DateTimeColumn(String name, int initialSize)`
`DateTimeColumn(String name, List<LocalDateTime> data)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(LocalDateTime dateTime)`
`void`	`append(Column column)`
`void`	`append(LocalDateTime dateTime)`
`void`	`appendCell(String stringValue)`
`void`	`appendInternal(long dateTime)`
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[]
`long[]`	`asEpochMillisArray()` Returns an array where each entry is the difference, measured in milliseconds, between the LocalDateTime and midnight, January 1, 1970 UTC.
`long[]`	`asEpochMillisArray(ZoneOffset offset)`
`long[]`	`asEpochSecondArray()` Returns an array where each entry is the difference, measured in seconds, between the LocalDateTime and midnight, January 1, 1970 UTC.
`long[]`	`asEpochSecondArray(ZoneOffset offset)`
`Set<LocalDateTime>`	`asSet()`
`List<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(LocalDateTime dateTime)`
`long`	`convert(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.
`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.
`LocalDateTime`	`get(int index)`
`long`	`getLongInternal(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`Selection`	`isAfter(DateTimeColumn column)`
`Selection`	`isAfter(LocalDateTime value)`
`Selection`	`isAfter(Long packedDateTime)`
`Selection`	`isAfterNoon()`
`Selection`	`isBefore(DateTimeColumn column)`
`Selection`	`isBefore(LocalDateTime value)`
`Selection`	`isBefore(Long packedDateTime)`
`Selection`	`isBeforeNoon()`
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isEqualTo(DateTimeColumn column)`
`Selection`	`isEqualTo(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(LocalDateTime value)`
`Selection`	`isOnOrAfter(long value)`
`Selection`	`isOnOrBefore(LocalDateTime value)`
`Selection`	`isOnOrBefore(long value)`
`Selection`	`isSaturday()`
`Selection`	`isSunday()`
`Selection`	`isThursday()`
`Selection`	`isTuesday()`
`Selection`	`isWednesday()`
`Iterator<LocalDateTime>`	`iterator()` Returns an iterator over elements of type `T`.
`it.unimi.dsi.fastutil.longs.LongIterator`	`longIterator()`
`LocalDateTime`	`max()`
`LocalDateTime`	`min()`
`ShortColumn`	`minuteOfDay()`
`CategoryColumn`	`monthName()`
`ShortColumn`	`monthNumber()`
`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)`
`void`	`set(int index, LocalDateTime value)`
`void`	`set(int index, long value)`
`void`	`set(LocalDateTime 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(LocalDateTime.now(), myColumn.isMissing()); // no more missing values
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`Table`	`summary()`
`TimeColumn`	`time()` Returns a TimeColumn containing the time portion of each dateTime in this DateTimeColumn
`List<LocalDateTime>`	`top(int n)` Returns the largest ("top") n values in the column
`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()`
`CategoryColumn`	`yearDayString()` Returns a CategoryColumn with the year and day-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
`CategoryColumn`	`yearMonthString()` Returns a CategoryColumn with the year and month from this column concatenated into a String that will sort lexicographically in temporal order.
`CategoryColumn`	`yearWeekString()` Returns a CategoryColumn with the year and week-of-year derived 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.DateTimeMapUtils
difference, difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, hour, secondOfDay

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 long MISSING_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DateTimeColumn
```
public DateTimeColumn(String name)
```
  - DateTimeColumn
```
public DateTimeColumn(ColumnMetadata metadata)
```
  - DateTimeColumn
```
public DateTimeColumn(String name,
                      int initialSize)
```
  - DateTimeColumn
```
public DateTimeColumn(String name,
                      List<LocalDateTime> data)
```
- Method Detail
  - appendCell
```
public void appendCell(String stringValue)
```
    Specified by:
    
    appendCell in interface Column
    
    Specified by:
    
    appendCell in class AbstractColumn
  - add
```
public void add(LocalDateTime dateTime)
```
  - convert
```
public long convert(String value)
```
    Returns a PackedDateTime as converted from the given string
    
    Parameters:
    
    value - A string representation of a time
    
    Throws:
    
    DateTimeParseException - if no parser can be found for the time format used
  - 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
    
    Returns:
    
    ColumnType
  - appendInternal
```
public void appendInternal(long dateTime)
```
  - append
```
public void append(LocalDateTime dateTime)
```
  - 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 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
    
    Returns:
    
    a empty copy of 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
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a 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
    
    Returns:
    
    a 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
    
    Returns:
    
    unique values as int
  - 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
    
    Returns:
    
    a Column
  - 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
  - getLongInternal
```
public long getLongInternal(int index)
```
    Specified by:
    
    getLongInternal in interface DateTimeMapUtils
  - get
```
public 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()
```
  - 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).
  - yearDayString
```
public CategoryColumn yearDayString()
```
    Returns a CategoryColumn with the year and day-of-year derived 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).
  - yearWeekString
```
public CategoryColumn yearWeekString()
```
    Returns a CategoryColumn with the year and week-of-year derived 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).
  - year
```
public ShortColumn year()
```
  - set
```
public void set(LocalDateTime 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(LocalDateTime.now(), myColumn.isMissing()); // no more missing values
  - isEqualTo
```
public Selection isEqualTo(LocalDateTime value)
```
  - isEqualTo
```
public Selection isEqualTo(DateTimeColumn column)
```
  - isAfter
```
public Selection isAfter(LocalDateTime value)
```
  - isAfter
```
public Selection isAfter(Long packedDateTime)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(long value)
```
  - isOnOrAfter
```
public Selection isOnOrAfter(LocalDateTime value)
```
  - isBefore
```
public Selection isBefore(LocalDateTime value)
```
  - isBefore
```
public Selection isBefore(Long packedDateTime)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(long value)
```
  - isOnOrBefore
```
public Selection isOnOrBefore(LocalDateTime value)
```
  - isAfter
```
public Selection isAfter(DateTimeColumn column)
```
  - isBefore
```
public Selection isBefore(DateTimeColumn 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
  - asEpochSecondArray
```
public long[] asEpochSecondArray()
```
    Returns an array where each entry is the difference, measured in seconds, between the LocalDateTime and midnight, January 1, 1970 UTC.
  - asEpochSecondArray
```
public long[] asEpochSecondArray(ZoneOffset offset)
```
  - asEpochMillisArray
```
public long[] asEpochMillisArray()
```
    Returns an array where each entry is the difference, measured in milliseconds, between the LocalDateTime and midnight, January 1, 1970 UTC.
  - asEpochMillisArray
```
public long[] asEpochMillisArray(ZoneOffset offset)
```
  - print
```
public 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 String toString()
```
    Overrides:
    
    toString in class Object
  - append
```
public void append(Column column)
```
    Specified by:
    
    append in interface Column
  - max
```
public LocalDateTime max()
```
  - min
```
public 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)
```
  - set
```
public void set(int index,
                long value)
```
  - set
```
public void set(int index,
                LocalDateTime value)
```
  - select
```
public Selection select(LongBiPredicate predicate,
                        long value)
```
  - top
```
public List<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 List<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 Set<LocalDateTime> asSet()
```
  - isInYear
```
public Selection isInYear(int year)
```
  - contains
```
public boolean contains(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
    
    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 - index of the row
    
    Returns:
    
    content as byte[]
  - iterator
```
public Iterator<LocalDateTime> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface Iterable<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
    
    Returns:
    
    a Column

Class DateTimeColumn

Field Summary

Fields inherited from interface tech.tablesaw.columns.DateTimeColumnUtils

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

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Constructor Detail

DateTimeColumn

DateTimeColumn

DateTimeColumn

DateTimeColumn

Method Detail

appendCell

add

convert

size

data

type

appendInternal

append

getString

emptyCopy

emptyCopy

clear

copy

sortAscending

sortDescending

summary

countUnique

unique

isEmpty

getLongInternal

get

rowComparator

dayOfWeek

dayOfWeekValue

dayOfYear

dayOfMonth

time

date

monthNumber

monthName

yearMonthString

yearDayString

yearWeekString

year

set

isEqualTo

isEqualTo

isAfter

isAfter

isOnOrAfter

isOnOrAfter

isBefore

isBefore

isOnOrBefore

isOnOrBefore

isAfter

isBefore

countMissing

asEpochSecondArray

asEpochSecondArray

asEpochMillisArray

asEpochMillisArray

print

isMissing

isNotMissing

toString

append

max

min

minuteOfDay

selectIf

selectIf