DateTimeColumn (tablesaw-core 0.23.1 API)

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

All Implemented Interfaces:

Iterable<LocalDateTime>, Column, DateTimeFillers<DateTimeColumn>, DateTimeFilters, DateTimeMapFunctions
```
public class DateTimeColumn
extends AbstractColumn
implements DateTimeMapFunctions, DateTimeFilters, DateTimeFillers<DateTimeColumn>, 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 class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(Column column)`
`DateTimeColumn`	`append(LocalDateTime dateTime)`
`DateTimeColumn`	`appendCell(String stringValue)`
`DateTimeColumn`	`appendInternal(long dateTime)`
`DateTimeColumn`	`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()`
`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.
`static DateTimeColumn`	`create(String name)`
`static DateTimeColumn`	`create(String name, int initialSize)`
`static DateTimeColumn`	`create(String name, int initialSize, Locale locale)`
`static DateTimeColumn`	`create(String name, List<LocalDateTime> data)`
`static DateTimeColumn`	`create(String name, LocalDateTime[] data)`
`it.unimi.dsi.fastutil.longs.LongArrayList`	`data()`
`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.
`DateTimeColumn`	`fillWith(Iterable<LocalDateTime> iterable)`
`DateTimeColumn`	`fillWith(Iterator<LocalDateTime> iterator)`
`DateTimeColumn`	`fillWith(Supplier<LocalDateTime> supplier)`
`LocalDateTime`	`get(int index)`
`double`	`getDouble(int i)` Returns a double representation of the value at the given row.
`long`	`getLongInternal(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int row)`
`boolean`	`isEmpty()` Returns true if the column has no data
`boolean`	`isMissing(int rowNumber)`
`Iterator<LocalDateTime>`	`iterator()` Returns an iterator over elements of type `T`.
`DateTimeColumn`	`lag(int n)` Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`it.unimi.dsi.fastutil.longs.LongIterator`	`longIterator()`
`LocalDateTime`	`max()`
`LocalDateTime`	`min()`
`DateTimeColumn`	`removeMissing()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`DateTimeColumn`	`set(int index, LocalDateTime value)`
`DateTimeColumn`	`set(int index, long value)`
`DateTimeColumn`	`set(Selection rowSelection, LocalDateTime 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(DateTimeColumnFormatter formatter)`
`void`	`setPrintFormatter(DateTimeFormatter dateTimeFormatter)`
`void`	`setPrintFormatter(DateTimeFormatter dateTimeFormatter, String missingValueString)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`Table`	`summary()`
`List<LocalDateTime>`	`top(int n)` Returns the largest ("top") n values in the column
`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.
`static boolean`	`valueIsMissing(long value)`
`DateTimeColumn`	`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.datetimes.DateTimeMapFunctions
date, dayOfMonth, dayOfWeek, dayOfWeekValue, dayOfYear, difference, difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, hour, hourMinute, lead, minute, minuteOfDay, month, monthValue, secondOfDay, time, timeWindow, timeWindow, year, yearDay, yearMonth, yearQuarter, yearWeek

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

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 long MISSING_VALUE
```
- Method Detail
  - setFormatter
```
public void setFormatter(DateTimeFormatter formatter)
```
  - valueIsMissing
```
public static boolean valueIsMissing(long value)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column
  - create
```
public static DateTimeColumn create(String name)
```
  - create
```
public static DateTimeColumn create(String name,
                                    int initialSize)
```
  - create
```
public static DateTimeColumn create(String name,
                                    int initialSize,
                                    Locale locale)
```
  - create
```
public static DateTimeColumn create(String name,
                                    List<LocalDateTime> data)
```
  - create
```
public static DateTimeColumn create(String name,
                                    LocalDateTime[] data)
```
  - removeMissing
```
public DateTimeColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column
  - contains
```
public boolean contains(LocalDateTime dateTime)
```
  - where
```
public DateTimeColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column
  - setPrintFormatter
```
public void setPrintFormatter(DateTimeFormatter dateTimeFormatter,
                              String missingValueString)
```
  - setPrintFormatter
```
public void setPrintFormatter(DateTimeFormatter dateTimeFormatter)
```
  - setPrintFormatter
```
public void setPrintFormatter(DateTimeColumnFormatter formatter)
```
  - lag
```
public DateTimeColumn 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
    
    Specified by:
    
    lag in interface DateTimeMapFunctions
  - appendCell
```
public DateTimeColumn appendCell(String stringValue)
```
    Specified by:
    
    appendCell in interface Column
    
    Specified by:
    
    appendCell in class AbstractColumn
  - append
```
public DateTimeColumn append(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
    
    Specified by:
    
    size in interface DateTimeFilters
  - data
```
public it.unimi.dsi.fastutil.longs.LongArrayList data()
```
    Specified by:
    
    data in interface DateTimeFilters
  - 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 DateTimeColumn appendInternal(long 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
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString 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
    
    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
  - 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
  - clear
```
public void clear()
```
    Specified by:
    
    clear 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
    
    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 DateTimeFilters
    
    Specified by:
    
    getLongInternal in interface DateTimeMapFunctions
  - get
```
public LocalDateTime get(int index)
```
    Specified by:
    
    get in interface DateTimeFilters
    
    Specified by:
    
    get in interface DateTimeMapFunctions
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column
  - set
```
public DateTimeColumn set(Selection rowSelection,
                          LocalDateTime 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(), LocalDateTime.now()); // no more missing values
  - 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)
```
  - append
```
public void append(Column column)
```
    Specified by:
    
    append in interface Column
  - max
```
public LocalDateTime max()
```
  - appendMissing
```
public DateTimeColumn appendMissing()
```
    Description copied from interface: Column
    
    Appends a missing value appropriate to the column
    
    Specified by:
    
    appendMissing in interface Column
  - min
```
public LocalDateTime min()
```
    Specified by:
    
    min in interface DateTimeMapFunctions
  - set
```
public DateTimeColumn set(int index,
                          long value)
```
  - set
```
public DateTimeColumn set(int index,
                          LocalDateTime 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()
```
  - 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[]
  - 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
  - asDoubleArray
```
public double[] asDoubleArray()
```
    Specified by:
    
    asDoubleArray in interface Column
  - iterator
```
public Iterator<LocalDateTime> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface Iterable<LocalDateTime>
    
    Returns:
    
    an Iterator.
  - fillWith
```
public DateTimeColumn fillWith(Iterator<LocalDateTime> iterator)
```
    Specified by:
    
    fillWith in interface DateTimeFillers<DateTimeColumn>
  - fillWith
```
public DateTimeColumn fillWith(Iterable<LocalDateTime> iterable)
```
    Specified by:
    
    fillWith in interface DateTimeFillers<DateTimeColumn>
  - fillWith
```
public DateTimeColumn fillWith(Supplier<LocalDateTime> supplier)
```
    Specified by:
    
    fillWith in interface DateTimeFillers<DateTimeColumn>

Class DateTimeColumn

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.datetimes.DateTimeMapFunctions

Methods inherited from interface tech.tablesaw.columns.datetimes.DateTimeFilters

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Field Detail

MISSING_VALUE

Method Detail

setFormatter

valueIsMissing

isMissing

create

create

create

create

create

removeMissing

contains

where

setPrintFormatter

setPrintFormatter

setPrintFormatter

lag

appendCell

append

convert

size

data

type

appendInternal

getString

getUnformattedString

emptyCopy

emptyCopy

copy

clear

sortAscending

sortDescending

summary

countUnique

unique

isEmpty

getLongInternal

get

rowComparator

set

countMissing

asEpochSecondArray

asEpochSecondArray

asEpochMillisArray

asEpochMillisArray

append

max

appendMissing

min

set

set

top

bottom

longIterator

asSet

byteSize

asBytes

getDouble

asDoubleArray

iterator

fillWith

fillWith

fillWith