Package tech.tablesaw.api

Class DateTimeColumn

java.lang.Object

tech.tablesaw.columns.AbstractColumn<DateTimeColumn,LocalDateTime>

tech.tablesaw.api.DateTimeColumn

All Implemented Interfaces:

Iterable<LocalDateTime>, Comparator<LocalDateTime>, CategoricalColumn<LocalDateTime>, Column<LocalDateTime>, DateTimeFilters, DateTimeMapFunctions, TemporalColumn<LocalDateTime>, TemporalFillers<LocalDateTime,DateTimeColumn>, TemporalFilters<LocalDateTime>, TemporalMapFunctions<DateTimeColumn,LocalDateTime>, DateAndDateTimeFilterSpec<Selection>, DateTimeFilterSpec<Selection>, FilterSpec<Selection>, InstantFilterSpec<Selection>, TimeAndDateTimeFilterSpec<Selection>

public class DateTimeColumn
extends AbstractColumn<DateTimeColumn,LocalDateTime>
implements DateTimeMapFunctions, DateTimeFilters, TemporalFillers<LocalDateTime,DateTimeColumn>, CategoricalColumn<LocalDateTime>

A column that contains long-integer encoded (packed) local date-time values

Field Summary

Fields

Modifier and Type	Field	Description
protected it.unimi.dsi.fastutil.longs.LongArrayList	data	The dateTime values held in this column, in their PackedLocalDateTime format

Fields inherited from class tech.tablesaw.columns.AbstractColumn

DEFAULT_ARRAY_SIZE, DEFAULT_COLUMN_TYPE_MISMATCH_MESSAGE

Method Summary

Modifier and Type	Method	Description
DateTimeColumn	append(LocalDateTime dateTime)	Appends value to the bottom of this column and return this column
DateTimeColumn	append(Column<LocalDateTime> column)	Appends all the values in the argument to the bottom of this column and return this column
DateTimeColumn	append(Column<LocalDateTime> column, int row)	Appends the value at the given row in the given column to the bottom of this column and return this column
DateTimeColumn	appendCell(String stringValue)	Add one element to the bottom of this column and set its value to the parsed value of the given String.
DateTimeColumn	appendCell(String stringValue, AbstractColumnParser<?> parser)	Add one element to the bottom of this column and set its value to the parsed value of the given String, as performed by the given parser
DateTimeColumn	appendInternal(long dateTime)	Returns this column with the argument appended at the bottom
DateTimeColumn	appendMissing()	Appends a missing value appropriate to the column
DateTimeColumn	appendObj(Object obj)	Appends the given value to the bottom of this column and return this column
byte[]	asBytes(int rowNumber)	Returns the contents of the cell at rowNumber as a byte[]
double[]	asDoubleArray()
DoubleColumn	asDoubleColumn()
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)	Returns an array where each entry is the difference, measured in milliseconds, between the LocalDateTime and midnight, January 1, 1970 UTC.
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)	Returns the seconds from epoch for each value as an array based on the given offset
InstantColumn	asInstantColumn()
InstantColumn	asInstantColumn(ZoneId zone)
LocalDateTime[]	asObjectArray()	Returns an array of objects as appropriate for my type of column
Set<LocalDateTime>	asSet()	Returns a Set containing all the unique values in this column
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()	Removes all elements TODO: Make this return this column
int	compare(LocalDateTime o1, LocalDateTime o2)
boolean	contains(LocalDateTime dateTime)	Returns true if the given object appears in this column, and false otherwise
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, LocalDateTime... data)
static DateTimeColumn	create(String name, Collection<LocalDateTime> data)
static DateTimeColumn	create(String name, Stream<LocalDateTime> stream)
static DateTimeColumn	createInternal(String name, long[] longs)	For internal Tablesaw use only Returns a new column with the given name and 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.
boolean	equals(int rowNumber1, int rowNumber2)	Returns true if the value in this column at rowNumber1 is equal to the value at rowNumber2
DateTimeColumn	fillWith(Iterable<LocalDateTime> iterable)
DateTimeColumn	fillWith(Supplier<LocalDateTime> supplier)
DateTimeColumn	fillWith(Iterator<LocalDateTime> iterator)
LocalDateTime	get(int index)	Returns a value of the Object type stored in the column (e.g. a LocalDateTime) at the given row
double	getDouble(int i)
long	getLongInternal(int index)	Returns the internal (long-encoded) value stored in the column at the given row
protected long	getPackedDateTime(int index)
String	getString(int row)	Returns a string representation of the value at the given row.
String	getUnformattedString(int row)	Returns a String representation of the value at index r, without any formatting applied
boolean	isEmpty()	Returns true if the column has no data
boolean	isMissing(int rowNumber)	Returns true if the value at rowNumber is missing
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	plus(long amountToAdd, ChronoUnit unit)
DateTimeColumn	removeMissing()	Returns a copy of this column with the missing values removed
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator()	Returns an IntComparator for sorting my rows
DateTimeColumn	set(int index, long value)
DateTimeColumn	set(int index, LocalDateTime value)	Sets the value at index row to the given value and return this column
DateTimeColumn	set(int row, Column<LocalDateTime> column, int sourceRow)	Sets the value at row to the value at sourceRow in the given column and return this column
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
DateTimeColumn	setMissing(int i)	Sets the value at index i to the missing-value indicator for this column type, and return this column
void	setPrintFormatter(DateTimeFormatter dateTimeFormatter)
void	setPrintFormatter(DateTimeFormatter dateTimeFormatter, String missingValueString)
void	setPrintFormatter(DateTimeColumnFormatter formatter)
int	size()	Returns the number of elements in this column, including missing values
void	sortAscending()	Sorts my values in ascending order
void	sortDescending()	Sorts my values in descending order
DateTimeColumn	subset(int[] rows)	Return a column of the same type containing just those elements whose indexes are included in the given array
Table	summary()	Returns a table containing a ColumnType specific summary of the data in this column
List<LocalDateTime>	top(int n)	Returns the largest ("top") n values in the column
DateTimeColumn	unique()	Returns a column of the same type containing only the unique values
int	valueHash(int rowNumber)	Returns an int suitable as a hash for the value in this column at the given index
static boolean	valueIsMissing(long value)
DateTimeColumn	where(Selection selection)	Returns a new column containing the subset referenced by the Selection

Methods inherited from class tech.tablesaw.columns.AbstractColumn

asStringColumn, filter, first, indexOf, inRange, last, map, max, min, name, parser, sampleN, sampleX, set, setName, setParser, sorted, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tech.tablesaw.api.CategoricalColumn

countByCategory

Methods inherited from interface tech.tablesaw.columns.Column

allMatch, anyMatch, asList, asStringColumn, columnWidth, count, count, filter, first, indexOf, inRange, interpolate, last, map, map, mapInto, max, max, min, min, name, noneMatch, parser, print, reduce, reduce, rolling, sampleN, sampleX, set, set, set, setMissingTo, setName, setParser, sorted, title, type

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

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

isAfter, isAfter, isAfter, isAfterNoon, isBefore, isBefore, isBefore, isBeforeNoon, isBetweenExcluding, 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.datetimes.DateTimeMapFunctions

date, dayOfMonth, dayOfWeek, dayOfWeekValue, dayOfYear, hour, hourMinute, minute, minuteOfDay, month, monthValue, plusMonths, plusWeeks, plusYears, secondOfDay, time, timeWindow, timeWindow, year, yearDay, yearMonth, yearQuarter, yearWeek

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface tech.tablesaw.columns.temporal.TemporalFilters

eval, eval, eval, eval, eval, isAfter, isBefore, isBetweenExcluding, isBetweenIncluding, isEqualTo

Methods inherited from interface tech.tablesaw.columns.temporal.TemporalMapFunctions

difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, lead, missingValues, plusDays, plusHours, plusMicros, plusMillis, plusMinutes, plusSeconds, temporalColumnName

Field Details

data

protected it.unimi.dsi.fastutil.longs.LongArrayList data

The dateTime values held in this column, in their PackedLocalDateTime format

Method Details

valueHash

public int valueHash(int rowNumber)

Returns an int suitable as a hash for the value in this column at the given index

Specified by:

valueHash in interface Column<LocalDateTime>

equals

public boolean equals(int rowNumber1,
 int rowNumber2)

Returns true if the value in this column at rowNumber1 is equal to the value at rowNumber2

Specified by:

equals in interface Column<LocalDateTime>

createInternal

public static DateTimeColumn createInternal(String name,
 long[] longs)

For internal Tablesaw use only Returns a new column with the given name and data

Parameters:

name - The column name

longs - An array of longs representing datetime values in Tablesaw internal format

create

public static DateTimeColumn create(String name)

create

public static DateTimeColumn create(String name,
 int initialSize)

create

public static DateTimeColumn create(String name,
 Collection<LocalDateTime> data)

create

public static DateTimeColumn create(String name,
 Stream<LocalDateTime> stream)

plus

public DateTimeColumn plus(long amountToAdd,
 ChronoUnit unit)

Specified by:

plus in interface TemporalMapFunctions<DateTimeColumn,LocalDateTime>

create

public static DateTimeColumn create(String name,
 LocalDateTime... data)

valueIsMissing

public static boolean valueIsMissing(long value)

isMissing

public boolean isMissing(int rowNumber)

Returns true if the value at rowNumber is missing

Specified by:

isMissing in interface Column<LocalDateTime>

subset

public DateTimeColumn subset(int[] rows)

Return a column of the same type containing just those elements whose indexes are included in the given array

Specified by:

subset in interface Column<LocalDateTime>

Overrides:

subset in class AbstractColumn<DateTimeColumn,LocalDateTime>

removeMissing

public DateTimeColumn removeMissing()

Returns a copy of this column with the missing values removed

Specified by:

removeMissing in interface Column<LocalDateTime>

contains

public boolean contains(LocalDateTime dateTime)

Returns true if the given object appears in this column, and false otherwise

TODO override in column subtypes for performance

Specified by:

contains in interface Column<LocalDateTime>

setMissing

public DateTimeColumn setMissing(int i)

Sets the value at index i to the missing-value indicator for this column type, and return this column

Specified by:

setMissing in interface Column<LocalDateTime>

where

public DateTimeColumn where(Selection selection)

Returns a new column containing the subset referenced by the Selection

Specified by:

where in interface Column<LocalDateTime>

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)

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<LocalDateTime>

Specified by:

lag in interface TemporalMapFunctions<DateTimeColumn,LocalDateTime>

appendCell

public DateTimeColumn appendCell(String stringValue)

Add one element to the bottom of this column and set its value to the parsed value of the given String. Parsing is type-specific

Specified by:

appendCell in interface Column<LocalDateTime>

appendCell

public DateTimeColumn appendCell(String stringValue,
 AbstractColumnParser<?> parser)

Add one element to the bottom of this column and set its value to the parsed value of the given String, as performed by the given parser

Specified by:

appendCell in interface Column<LocalDateTime>

append

public DateTimeColumn append(LocalDateTime dateTime)

Appends value to the bottom of this column and return this column

Specified by:

append in interface Column<LocalDateTime>

appendObj

public DateTimeColumn appendObj(Object obj)

Appends the given value to the bottom of this column and return this column

Specified by:

appendObj in interface Column<LocalDateTime>

size

public int size()

Returns the number of elements in this column, including missing values

Specified by:

size in interface Column<LocalDateTime>

Specified by:

size in interface TemporalFilters<LocalDateTime>

appendInternal

public DateTimeColumn appendInternal(long dateTime)

Returns this column with the argument appended at the bottom

Specified by:

appendInternal in interface TemporalColumn<LocalDateTime>

getString

public String getString(int row)

Returns a string representation of the value at the given row.

Specified by:

getString in interface Column<LocalDateTime>

Parameters:

row - The index of the row.

Returns:

value as String

getUnformattedString

public String getUnformattedString(int row)

Returns a String representation of the value at index r, without any formatting applied

Specified by:

getUnformattedString in interface Column<LocalDateTime>

emptyCopy

public DateTimeColumn emptyCopy()

Returns a copy of the receiver with no data. The column name and type are the same.

Specified by:

emptyCopy in interface Column<LocalDateTime>

Specified by:

emptyCopy in interface TemporalMapFunctions<DateTimeColumn,LocalDateTime>

Returns:

a empty copy of Column

emptyCopy

public DateTimeColumn emptyCopy(int rowSize)

Returns an empty copy of the receiver, with its internal storage initialized to the given row size.

Specified by:

emptyCopy in interface Column<LocalDateTime>

Parameters:

rowSize - the initial row size

Returns:

a Column

copy

public DateTimeColumn copy()

Returns a deep copy of the receiver

Specified by:

copy in interface Column<LocalDateTime>

Returns:

a Column

clear

public void clear()

Removes all elements TODO: Make this return this column

Specified by:

clear in interface Column<LocalDateTime>

sortAscending

public void sortAscending()

Sorts my values in ascending order

Specified by:

sortAscending in interface Column<LocalDateTime>

sortDescending

public void sortDescending()

Sorts my values in descending order

Specified by:

sortDescending in interface Column<LocalDateTime>

summary

public Table summary()

Returns a table containing a ColumnType specific summary of the data in this column

Specified by:

summary in interface Column<LocalDateTime>

countUnique

public int countUnique()

Returns the count of unique values in this column.

Specified by:

countUnique in interface Column<LocalDateTime>

Returns:

unique values as int

unique

public DateTimeColumn unique()

Returns a column of the same type containing only the unique values

Specified by:

unique in interface Column<LocalDateTime>

Returns:

a Column

isEmpty

public boolean isEmpty()

Returns true if the column has no data

Specified by:

isEmpty in interface Column<LocalDateTime>

Returns:

true if empty, false if not

getLongInternal

public long getLongInternal(int index)

Returns the internal (long-encoded) value stored in the column at the given row

Specified by:

getLongInternal in interface TemporalColumn<LocalDateTime>

Specified by:

getLongInternal in interface TemporalFilters<LocalDateTime>

getPackedDateTime

protected long getPackedDateTime(int index)

get

public LocalDateTime get(int index)

Returns a value of the Object type stored in the column (e.g. a LocalDateTime) at the given row

Specified by:

get in interface Column<LocalDateTime>

Specified by:

get in interface TemporalColumn<LocalDateTime>

Specified by:

get in interface TemporalFilters<LocalDateTime>

rowComparator

public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()

Returns an IntComparator for sorting my rows

Specified by:

rowComparator in interface Column<LocalDateTime>

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

Specified by:

set in interface Column<LocalDateTime>

Overrides:

set in class AbstractColumn<DateTimeColumn,LocalDateTime>

countMissing

public int countMissing()

Returns the count of missing values in this column

Specified by:

countMissing in interface Column<LocalDateTime>

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.

If a value is missing, DateTimeColumnType.missingValueIndicator() is used

asEpochSecondArray

public long[] asEpochSecondArray(ZoneOffset offset)

Returns the seconds from epoch for each value as an array based on the given offset

If a value is missing, DateTimeColumnType.missingValueIndicator() is used

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.

If a missing value is encountered, DateTimeColumnType.missingValueIndicator() is inserted in the array

asEpochMillisArray

public long[] asEpochMillisArray(ZoneOffset offset)

Returns an array where each entry is the difference, measured in milliseconds, between the LocalDateTime and midnight, January 1, 1970 UTC.

If a missing value is encountered, DateTimeColumnType.missingValueIndicator() is inserted in the array

asInstantColumn

public InstantColumn asInstantColumn()

asInstantColumn

public InstantColumn asInstantColumn(ZoneId zone)

append

public DateTimeColumn append(Column<LocalDateTime> column)

Appends all the values in the argument to the bottom of this column and return this column

Specified by:

append in interface Column<LocalDateTime>

append

public DateTimeColumn append(Column<LocalDateTime> column,
 int row)

Appends the value at the given row in the given column to the bottom of this column and return this column

Specified by:

append in interface Column<LocalDateTime>

set

public DateTimeColumn set(int row,
 Column<LocalDateTime> column,
 int sourceRow)

Sets the value at row to the value at sourceRow in the given column and return this column

Specified by:

set in interface Column<LocalDateTime>

max

public LocalDateTime max()

appendMissing

public DateTimeColumn appendMissing()

Appends a missing value appropriate to the column

Specified by:

appendMissing in interface Column<LocalDateTime>

min

public LocalDateTime min()

Specified by:

min in interface TemporalMapFunctions<DateTimeColumn,LocalDateTime>

set

public DateTimeColumn set(int index,
 long value)

set

public DateTimeColumn set(int index,
 LocalDateTime value)

Sets the value at index row to the given value and return this column

Specified by:

set in interface Column<LocalDateTime>

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()

Description copied from interface: Column

Returns a Set containing all the unique values in this column

Specified by:

asSet in interface Column<LocalDateTime>

byteSize

public int byteSize()

Returns the width of a cell in this column, in bytes.

Specified by:

byteSize in interface Column<LocalDateTime>

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<LocalDateTime>

Parameters:

rowNumber - index of the row

Returns:

content as byte[]

getDouble

public double getDouble(int i)

asDoubleArray

public double[] asDoubleArray()

asDoubleColumn

public DoubleColumn asDoubleColumn()

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 TemporalFillers<LocalDateTime,DateTimeColumn>

fillWith

public DateTimeColumn fillWith(Iterable<LocalDateTime> iterable)

Specified by:

fillWith in interface TemporalFillers<LocalDateTime,DateTimeColumn>

fillWith

public DateTimeColumn fillWith(Supplier<LocalDateTime> supplier)

Specified by:

fillWith in interface TemporalFillers<LocalDateTime,DateTimeColumn>

asObjectArray

public LocalDateTime[] asObjectArray()

Returns an array of objects as appropriate for my type of column

Specified by:

asObjectArray in interface Column<LocalDateTime>

compare

public int compare(LocalDateTime o1,
 LocalDateTime o2)

Specified by:

compare in interface Comparator<LocalDateTime>