tech.tablesaw.api

Class TimeColumn

java.lang.Object

tech.tablesaw.columns.AbstractColumn

tech.tablesaw.api.TimeColumn

All Implemented Interfaces:

Iterable<LocalTime>, CategoricalColumn, Column, TimeFillers<TimeColumn>, TimeFilters, TimeMapFunctions

public class TimeColumn
extends AbstractColumn
implements CategoricalColumn, Iterable<LocalTime>, TimeFilters, TimeFillers<TimeColumn>, TimeMapFunctions

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 class tech.tablesaw.columns.AbstractColumn

DEFAULT_ARRAY_SIZE

Method Summary

Modifier and Type	Method and Description
void	append(Column column)
TimeColumn	append(LocalTime time)
TimeColumn	appendCell(String object)
TimeColumn	appendInternal(int f)
TimeColumn	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()
int[]	asIntArray()
List<LocalTime>	asList() Returns the entire contents of this column as a list
List<LocalTime>	bottom(int n) Returns the smallest ("bottom") n values in the column, Does not change the order in this column
int	byteSize() Returns the width of a cell in this column, in bytes.
void	clear()
boolean	contains(LocalTime time)
int	convert(String value) Returns a PackedTime as converted from the given string
TimeColumn	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 TimeColumn	create(String name)
static TimeColumn	create(String name, int initialSize)
static TimeColumn	create(String name, int initialSize, Locale locale)
static TimeColumn	create(String name, List<LocalTime> data)
static TimeColumn	create(String name, LocalTime[] data)
it.unimi.dsi.fastutil.ints.IntArrayList	data()
TimeColumn	emptyCopy() Returns a copy of the receiver with no data.
TimeColumn	emptyCopy(int rowSize) Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
TimeColumn	fillWith(Iterable<LocalTime> iterable)
TimeColumn	fillWith(Iterator<LocalTime> iterator)
TimeColumn	fillWith(Supplier<LocalTime> supplier)
LocalTime	get(int index)
double	getDouble(int i) Returns a double representation of the value at the given row.
int	getIntInternal(int index) Returns the packed time representation of the value at index
String	getString(int row) Returns a string representation of the value at the given row.
String	getUnformattedString(int row)
it.unimi.dsi.fastutil.ints.IntIterator	intIterator()
boolean	isEmpty() Returns true if the column has no data
Selection	isMissing()
boolean	isMissing(int rowNumber)
Selection	isNotMissing()
Iterator<LocalTime>	iterator() Returns an iterator over elements of type T.
TimeColumn	lag(int n) Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
LocalTime	max()
LocalTime	min()
TimeColumn	removeMissing()
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator()
TimeColumn	set(int index, int value)
TimeColumn	set(int index, LocalTime value)
TimeColumn	set(Selection rowSelection, LocalTime 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(DateTimeFormatter dateTimeFormatter)
void	setPrintFormatter(DateTimeFormatter dateTimeFormatter, String missingValueString)
int	size()
void	sortAscending()
void	sortDescending()
Table	summary()
List<LocalTime>	top(int n) Returns the largest ("top") n values in the column.
String	toString()
ColumnType	type() Returns this column's ColumnType
TimeColumn	unique() Returns a column of the same type as the receiver, containing only the unique values of the receiver.
static boolean	valueIsMissing(int i)
TimeColumn	where(Selection selection)

Methods inherited from class tech.tablesaw.columns.AbstractColumn

columnWidth, name, print, setName

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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface tech.tablesaw.columns.times.TimeFilters

eval, eval, eval, eval, eval, isAfter, isAfter, isAfter, isAfterNoon, isBefore, isBefore, isBefore, isBeforeNoon, isEqualTo, isEqualTo, isMidnight, isNoon, isNotEqualTo, isNotEqualTo, isOnOrAfter, isOnOrAfter, isOnOrBefore, isOnOrBefore

Methods inherited from interface tech.tablesaw.columns.times.TimeMapFunctions

difference, difference, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, hour, hourMinute, lead, milliseconds, minus, minusHours, minusMilliseconds, minusMinutes, minusSeconds, minute, minuteOfDay, plus, plusHours, plusMilliseconds, plusMinutes, plusSeconds, second, secondOfDay, timeWindow, timeWindow, truncatedTo, with, withHour, withMillisecond, withMinute, withSecond

Methods inherited from interface tech.tablesaw.columns.Column

columnWidth, create, first, inRange, last, name, print, rolling, rows, sampleN, sampleX, setName, subset, summarizeIf, title

Field Detail

MISSING_VALUE

public static final int MISSING_VALUE

Method Detail

setFormatter

public void setFormatter(DateTimeFormatter formatter)

valueIsMissing

public static boolean valueIsMissing(int i)

create

public static TimeColumn create(String name)

create

public static TimeColumn create(String name,
                                List<LocalTime> data)

create

public static TimeColumn create(String name,
                                LocalTime[] data)

create

public static TimeColumn create(String name,
                                int initialSize)

create

public static TimeColumn create(String name,
                                int initialSize,
                                Locale locale)

appendMissing

public TimeColumn appendMissing()

Description copied from interface: Column

Appends a missing value appropriate to the column

Specified by:

appendMissing in interface Column

lag

public TimeColumn 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 TimeMapFunctions

isMissing

public boolean isMissing(int rowNumber)

Specified by:

isMissing in interface Column

size

public int size()

Specified by:

size in interface Column

appendInternal

public TimeColumn appendInternal(int f)

append

public TimeColumn append(LocalTime time)

removeMissing

public TimeColumn removeMissing()

Specified by:

removeMissing in interface Column

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

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

setPrintFormatter

public void setPrintFormatter(DateTimeFormatter dateTimeFormatter,
                              String missingValueString)

setPrintFormatter

public void setPrintFormatter(DateTimeFormatter dateTimeFormatter)

emptyCopy

public TimeColumn 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 TimeColumn 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 TimeColumn 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

asList

public List<LocalTime> asList()

Returns the entire contents of this column as a list

sortAscending

public void sortAscending()

Specified by:

sortAscending in interface Column

sortDescending

public void sortDescending()

Specified by:

sortDescending in interface Column

max

public LocalTime max()

min

public LocalTime min()

Specified by:

min in interface TimeMapFunctions

summary

public Table summary()

Specified by:

summary in interface 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

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

convert

public int convert(String value)

Returns a PackedTime 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

appendCell

public TimeColumn appendCell(String object)

Specified by:

appendCell in interface Column

Specified by:

appendCell in class AbstractColumn

getIntInternal

public int getIntInternal(int index)

Description copied from interface: TimeFilters

Returns the packed time representation of the value at index

Specified by:

getIntInternal in interface TimeFilters

Specified by:

getIntInternal in interface TimeMapFunctions

get

public LocalTime get(int index)

Specified by:

get in interface TimeFilters

Specified by:

get in interface TimeMapFunctions

rowComparator

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

Specified by:

rowComparator in interface Column

data

public it.unimi.dsi.fastutil.ints.IntArrayList data()

Specified by:

data in interface TimeFilters

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

toString

public String toString()

Overrides:

toString in class AbstractColumn

append

public void append(Column column)

Specified by:

append in interface Column

top

public List<LocalTime> top(int n)

Returns the largest ("top") n values in the column. Does not change the order in this 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<LocalTime> bottom(int n)

Returns the smallest ("bottom") n values in the column, Does not change the order in this 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

set

public TimeColumn set(int index,
                      int value)

set

public TimeColumn set(int index,
                      LocalTime value)

set

public TimeColumn set(Selection rowSelection,
                      LocalTime 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(), LocalTime.now()); // no more missing values

intIterator

public it.unimi.dsi.fastutil.ints.IntIterator intIterator()

contains

public boolean contains(LocalTime time)

isMissing

public Selection isMissing()

Specified by:

isMissing in interface Column

isNotMissing

public Selection isNotMissing()

Specified by:

isNotMissing in interface Column

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

Returns an iterator over elements of type T.

Specified by:

iterator in interface Iterable<LocalTime>

Returns:

an Iterator.

where

public TimeColumn where(Selection selection)

Specified by:

where in interface Column

Specified by:

where in interface TimeFilters

fillWith

public TimeColumn fillWith(Iterator<LocalTime> iterator)

Specified by:

fillWith in interface TimeFillers<TimeColumn>

fillWith

public TimeColumn fillWith(Iterable<LocalTime> iterable)

Specified by:

fillWith in interface TimeFillers<TimeColumn>

fillWith

public TimeColumn fillWith(Supplier<LocalTime> supplier)

Specified by:

fillWith in interface TimeFillers<TimeColumn>

asIntArray

public int[] asIntArray()

Specified by:

asIntArray in interface CategoricalColumn