tech.tablesaw.api

Class TimeColumn

java.lang.Object

tech.tablesaw.columns.AbstractColumn

tech.tablesaw.api.TimeColumn

All Implemented Interfaces:

Iterable<LocalTime>, Column, TimeColumnUtils, TimeMapUtils

public class TimeColumn
extends AbstractColumn
implements Iterable<LocalTime>, TimeMapUtils

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 interface tech.tablesaw.columns.TimeColumnUtils

isEqualTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isMissing, isNotMissing

Constructor Summary

Constructors

Constructor and Description
TimeColumn(ColumnMetadata metadata)
TimeColumn(String name)
TimeColumn(String name, int initialSize)
TimeColumn(String name, List<LocalTime> data)

Method Summary

Modifier and Type	Method and Description
void	append(Column column)
void	append(LocalTime f)
void	appendCell(String object)
void	appendInternal(int f)
byte[]	asBytes(int rowNumber) Returns the contents of the cell at rowNumber as a byte[]
List<LocalTime>	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(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.
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.
LocalTime	get(int index)
int	getIntInternal(int index)
String	getString(int row) Returns a string representation of the value at the given row.
it.unimi.dsi.fastutil.ints.IntIterator	intIterator()
Selection	isAfter(int packedTime)
Selection	isAfter(LocalTime time)
Selection	isAfterNoon() Applies a function to every value in this column that returns true if the time is in the PM or "after noon".
Selection	isBefore(int packedTime)
Selection	isBefore(LocalTime time)
Selection	isBeforeNoon() Applies a function to every value in this column that returns true if the time is in the AM or "before noon".
boolean	isEmpty() Returns true if the column has no data
Selection	isEqualTo(LocalTime value)
Selection	isEqualTo(TimeColumn column) Returns a bitmap flagging the records for which the value in this column is equal to the value in the given column Columnwise isEqualTo.
Selection	isMidnight()
Selection	isMissing()
Selection	isNoon()
Selection	isNotEqualTo(LocalTime value)
Selection	isNotMissing()
Selection	isOnOrAfter(int packed)
Selection	isOnOrAfter(LocalTime time)
Selection	isOnOrBefore(int packed)
Selection	isOnOrBefore(LocalTime value)
Iterator<LocalTime>	iterator() Returns an iterator over elements of type T.
LocalTime	max()
LocalTime	min()
String	print()
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator()
Selection	select(IntBiPredicate predicate, int value)
Selection	select(IntPredicate predicate)
TimeColumn	selectIf(IntPredicate predicate) This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes
TimeColumn	selectIf(LocalTimePredicate predicate)
void	set(int index, int value)
void	set(LocalTime 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(LocalTime.now(), myColumn.isMissing()); // no more missing values
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.

Methods inherited from class tech.tablesaw.columns.AbstractColumn

columnMetadata, columnWidth, comment, difference, 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.TimeMapUtils

difference, difference, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, hour, minuteOfDay, secondOfDay

Methods inherited from interface tech.tablesaw.columns.Column

asDoubleArray, columnMetadata, columnWidth, comment, difference, 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 int MISSING_VALUE

Constructor Detail

TimeColumn

public TimeColumn(String name)

TimeColumn

public TimeColumn(ColumnMetadata metadata)

TimeColumn

public TimeColumn(String name,
                  int initialSize)

TimeColumn

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

Method Detail

size

public int size()

Specified by:

size in interface Column

appendInternal

public void appendInternal(int f)

append

public void append(LocalTime f)

type

public ColumnType type()

Description copied from interface: Column

Returns this column's ColumnType

Specified by:

type in interface Column

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

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

clear

public void clear()

Specified by:

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

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

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 void appendCell(String object)

Specified by:

appendCell in interface Column

Specified by:

appendCell in class AbstractColumn

getIntInternal

public int getIntInternal(int index)

Specified by:

getIntInternal in interface TimeMapUtils

get

public LocalTime get(int index)

Specified by:

get in interface TimeMapUtils

rowComparator

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

Specified by:

rowComparator in interface Column

isNotEqualTo

public Selection isNotEqualTo(LocalTime value)

isEqualTo

public Selection isEqualTo(LocalTime value)

print

public String print()

Specified by:

print in interface Column

data

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

Specified by:

data in interface TimeColumnUtils

toString

public String toString()

Overrides:

toString in class Object

selectIf

public TimeColumn selectIf(LocalTimePredicate predicate)

selectIf

public TimeColumn selectIf(IntPredicate predicate)

This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes

append

public void append(Column column)

Specified by:

append in interface Column

isMidnight

public Selection isMidnight()

isNoon

public Selection isNoon()

isBefore

public Selection isBefore(LocalTime time)

isBefore

public Selection isBefore(int packedTime)

isAfter

public Selection isAfter(LocalTime time)

isAfter

public Selection isAfter(int packedTime)

isOnOrAfter

public Selection isOnOrAfter(LocalTime time)

isOnOrAfter

public Selection isOnOrAfter(int packed)

isOnOrBefore

public Selection isOnOrBefore(LocalTime value)

isOnOrBefore

public Selection isOnOrBefore(int packed)

isBeforeNoon

public Selection isBeforeNoon()

Applies a function to every value in this column that returns true if the time is in the AM or "before noon". Note: we follow the convention that 12:00 NOON is PM and 12 MIDNIGHT is AM

isAfterNoon

public Selection isAfterNoon()

Applies a function to every value in this column that returns true if the time is in the PM or "after noon". Note: we follow the convention that 12:00 NOON is PM and 12 MIDNIGHT is AM

top

public List<LocalTime> 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<LocalTime> 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

set

public void set(int index,
                int value)

set

public void set(LocalTime 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(LocalTime.now(), myColumn.isMissing()); // no more missing values

isEqualTo

public Selection isEqualTo(TimeColumn column)

Returns a bitmap flagging the records for which the value in this column is equal to the value in the given column Columnwise isEqualTo.

intIterator

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

select

public Selection select(IntPredicate predicate)

select

public Selection select(IntBiPredicate predicate,
                        int value)

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.