InstantColumn (tablesaw-core 0.34.0 API)

java.lang.Object
- tech.tablesaw.columns.AbstractColumn<Instant>
- - tech.tablesaw.api.InstantColumn

All Implemented Interfaces:

Iterable<Instant>, Comparator<Instant>, CategoricalColumn<Instant>, Column<Instant>, TemporalColumn<Instant>, TemporalFillers<Instant,InstantColumn>, TemporalFilters<Instant>, TemporalMapFunctions<Instant>
```
public class InstantColumn
extends AbstractColumn<Instant>
implements TemporalMapFunctions<Instant>, TemporalFillers<Instant,InstantColumn>, TemporalFilters<Instant>, CategoricalColumn<Instant>
```
A column in a table that contains long-integer encoded (packed) local date-time values

Field Summary
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstantColumn`	`append(Column<Instant> column)`
`InstantColumn`	`append(Column<Instant> column, int row)`
`InstantColumn`	`append(Instant dateTime)`
`InstantColumn`	`appendCell(String stringValue)`
`InstantColumn`	`appendCell(String stringValue, AbstractColumnParser<?> parser)`
`InstantColumn`	`appendInternal(long dateTime)`
`InstantColumn`	`appendMissing()` Appends a missing value appropriate to the column
`InstantColumn`	`appendObj(Object obj)`
`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 Instant and midnight, January 1, 1970 UTC.
`long[]`	`asEpochMillisArray(ZoneOffset offset)` Returns an array where each entry is the difference, measured in milliseconds, between the Instant and midnight, January 1, 1970 UTC.
`long[]`	`asEpochSecondArray()` Returns an array where each entry is the difference, measured in seconds, between the Instant 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 If a value is missing, InstantColumnType.missingValueIndicator() is used
`DateTimeColumn`	`asLocalDateTimeColumn()`
`DateTimeColumn`	`asLocalDateTimeColumn(ZoneId zone)`
`Instant[]`	`asObjectArray()`
`Set<Instant>`	`asSet()`
`List<Instant>`	`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()`
`int`	`compare(Instant o1, Instant o2)`
`boolean`	`contains(Instant dateTime)` Returns `true` if the given object appears in this column, and false otherwise TODO override in column subtypes for performance
`InstantColumn`	`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 InstantColumn`	`create(String name)`
`static InstantColumn`	`create(String name, Instant[] data)`
`static InstantColumn`	`create(String name, int initialSize)`
`static InstantColumn`	`create(String name, List<Instant> data)`
`it.unimi.dsi.fastutil.longs.LongArrayList`	`data()`
`InstantColumn`	`emptyCopy()` Returns a copy of the receiver with no data.
`InstantColumn`	`emptyCopy(int rowSize)` Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
`InstantColumn`	`fillWith(Iterable<Instant> iterable)`
`InstantColumn`	`fillWith(Iterator<Instant> iterator)`
`InstantColumn`	`fillWith(Supplier<Instant> supplier)`
`InstantColumn`	`filter(Predicate<? super Instant> test)` Returns a new Column of the same type with only those rows satisfying the predicate
`InstantColumn`	`first(int numRows)`
`Instant`	`get(int index)`
`double`	`getDouble(int i)`
`long`	`getLongInternal(int index)`
`protected long`	`getPackedDateTime(int index)`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int row)`
`InstantColumn`	`inRange(int start, int end)` Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
`boolean`	`isEmpty()` Returns true if the column has no data
`boolean`	`isMissing(int rowNumber)`
`Iterator<Instant>`	`iterator()` Returns an iterator over elements of type `T`.
`InstantColumn`	`lag(int n)` Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`InstantColumn`	`last(int numRows)`
`it.unimi.dsi.fastutil.longs.LongIterator`	`longIterator()`
`InstantColumn`	`map(Function<? super Instant,? extends Instant> fun)` Maps the function across all rows, appending the results to a new Column of the same type
`Instant`	`max()`
`InstantColumn`	`max(Column<Instant> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`Instant`	`min()`
`InstantColumn`	`min(Column<Instant> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`InstantColumn`	`removeMissing()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`InstantColumn`	`sampleN(int n)` Returns a column containing a random sample of the values in this column
`InstantColumn`	`sampleX(double proportion)` Returns a table consisting of randomly selected values from this column.
`InstantColumn`	`set(int row, Column<Instant> column, int sourceRow)`
`InstantColumn`	`set(int index, Instant value)`
`InstantColumn`	`set(int index, long value)`
`InstantColumn`	`set(Selection condition, Column<Instant> other)` Updates this column where values matching the selection are replaced with the corresponding value from the given column
`InstantColumn`	`set(Selection rowSelection, Instant newValue)` Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
`Column<Instant>`	`setMissing(int i)`
`InstantColumn`	`setName(String name)` Sets the columns name to the given string
`void`	`setPrintFormatter(InstantColumnFormatter formatter)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`InstantColumn`	`sorted(Comparator<? super Instant> comp)` Returns a new Column of the same type sorted according to the provided Comparator
`InstantColumn`	`subset(int[] rows)`
`Table`	`summary()`
`List<Instant>`	`top(int n)` Returns the largest ("top") n values in the column
`InstantColumn`	`unique()` Returns a column of the same type as the receiver, containing only the unique values of the receiver.
`static boolean`	`valueIsMissing(long value)`
`InstantColumn`	`where(Selection selection)`

Methods inherited from class tech.tablesaw.columns.AbstractColumn
asStringColumn, name, 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.columns.temporal.TemporalMapFunctions
difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, missingValues, plus, plusDays, plusHours, plusMicros, plusMillis, plusMinutes, plusMonths, plusSeconds, plusWeeks, plusYears, temporalColumnName

Methods inherited from interface tech.tablesaw.columns.Column
allMatch, anyMatch, asList, asStringColumn, columnWidth, count, count, isMissing, isNotMissing, lead, mapInto, max, min, name, noneMatch, print, reduce, reduce, rolling, set, title, type

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface tech.tablesaw.columns.temporal.TemporalFilters
eval, eval, eval, eval, eval, isBetweenExcluding, isBetweenIncluding, isMissing, isNotMissing

Methods inherited from interface tech.tablesaw.api.CategoricalColumn
countByCategory

- Method Detail
  - create
```
public static InstantColumn create(String name)
```
  - create
```
public static InstantColumn create(String name,
                                   int initialSize)
```
  - create
```
public static InstantColumn create(String name,
                                   List<Instant> data)
```
  - create
```
public static InstantColumn create(String name,
                                   Instant[] data)
```
  - valueIsMissing
```
public static boolean valueIsMissing(long value)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column<Instant>
  - subset
```
public InstantColumn subset(int[] rows)
```
    Specified by:
    
    subset in interface Column<Instant>
  - removeMissing
```
public InstantColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column<Instant>
  - contains
```
public boolean contains(Instant dateTime)
```
    Description copied from interface: Column
    
    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<Instant>
  - setMissing
```
public Column<Instant> setMissing(int i)
```
    Specified by:
    
    setMissing in interface Column<Instant>
  - where
```
public InstantColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column<Instant>
  - setPrintFormatter
```
public void setPrintFormatter(InstantColumnFormatter formatter)
```
  - lag
```
public InstantColumn 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<Instant>
  - appendCell
```
public InstantColumn appendCell(String stringValue)
```
    Specified by:
    
    appendCell in interface Column<Instant>
  - appendCell
```
public InstantColumn appendCell(String stringValue,
                                AbstractColumnParser<?> parser)
```
    Specified by:
    
    appendCell in interface Column<Instant>
  - append
```
public InstantColumn append(Instant dateTime)
```
    Specified by:
    
    append in interface Column<Instant>
  - appendObj
```
public InstantColumn appendObj(Object obj)
```
    Specified by:
    
    appendObj in interface Column<Instant>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Column<Instant>
    
    Specified by:
    
    size in interface TemporalFilters<Instant>
  - data
```
public it.unimi.dsi.fastutil.longs.LongArrayList data()
```
    Specified by:
    
    data in interface TemporalFilters<Instant>
  - appendInternal
```
public InstantColumn appendInternal(long dateTime)
```
    Specified by:
    
    appendInternal in interface TemporalColumn<Instant>
  - 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<Instant>
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString in interface Column<Instant>
  - emptyCopy
```
public InstantColumn 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<Instant>
    
    Specified by:
    
    emptyCopy in interface TemporalMapFunctions<Instant>
    
    Specified by:
    
    emptyCopy in class AbstractColumn<Instant>
    
    Returns:
    
    a empty copy of Column
  - emptyCopy
```
public InstantColumn 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<Instant>
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - copy
```
public InstantColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column<Instant>
    
    Returns:
    
    a Column
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Column<Instant>
  - sortAscending
```
public void sortAscending()
```
    Specified by:
    
    sortAscending in interface Column<Instant>
  - sortDescending
```
public void sortDescending()
```
    Specified by:
    
    sortDescending in interface Column<Instant>
  - summary
```
public Table summary()
```
    Specified by:
    
    summary in interface Column<Instant>
  - countUnique
```
public int countUnique()
```
    Description copied from interface: Column
    
    Returns the count of unique values in this column.
    
    Specified by:
    
    countUnique in interface Column<Instant>
    
    Returns:
    
    unique values as int
  - unique
```
public InstantColumn 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<Instant>
    
    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<Instant>
    
    Returns:
    
    true if empty, false if not
  - getLongInternal
```
public long getLongInternal(int index)
```
    Specified by:
    
    getLongInternal in interface TemporalColumn<Instant>
    
    Specified by:
    
    getLongInternal in interface TemporalFilters<Instant>
  - getPackedDateTime
```
protected long getPackedDateTime(int index)
```
  - get
```
public Instant get(int index)
```
    Specified by:
    
    get in interface Column<Instant>
    
    Specified by:
    
    get in interface TemporalColumn<Instant>
    
    Specified by:
    
    get in interface TemporalFilters<Instant>
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column<Instant>
  - set
```
public InstantColumn set(Selection rowSelection,
                         Instant 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(), Instant.now()); // no more missing values
    
    Specified by:
    
    set in interface Column<Instant>
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column<Instant>
    
    Returns:
    
    missing values as int
  - asEpochSecondArray
```
public long[] asEpochSecondArray()
```
    Returns an array where each entry is the difference, measured in seconds, between the Instant and midnight, January 1, 1970 UTC. If a value is missing, InstantColumnType.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, InstantColumnType.missingValueIndicator() is used
  - asEpochMillisArray
```
public long[] asEpochMillisArray()
```
    Returns an array where each entry is the difference, measured in milliseconds, between the Instant and midnight, January 1, 1970 UTC. If a missing value is encountered, InstantColumnType.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 Instant and midnight, January 1, 1970 UTC. If a missing value is encountered, InstantColumnType.missingValueIndicator() is inserted in the array
  - asLocalDateTimeColumn
```
public DateTimeColumn asLocalDateTimeColumn()
```
  - asLocalDateTimeColumn
```
public DateTimeColumn asLocalDateTimeColumn(ZoneId zone)
```
  - append
```
public InstantColumn append(Column<Instant> column)
```
    Specified by:
    
    append in interface Column<Instant>
  - append
```
public InstantColumn append(Column<Instant> column,
                            int row)
```
    Specified by:
    
    append in interface Column<Instant>
  - set
```
public InstantColumn set(int row,
                         Column<Instant> column,
                         int sourceRow)
```
    Specified by:
    
    set in interface Column<Instant>
  - max
```
public Instant max()
```
  - appendMissing
```
public InstantColumn appendMissing()
```
    Description copied from interface: Column
    
    Appends a missing value appropriate to the column
    
    Specified by:
    
    appendMissing in interface Column<Instant>
  - min
```
public Instant min()
```
    Specified by:
    
    min in interface TemporalMapFunctions<Instant>
  - set
```
public InstantColumn set(int index,
                         long value)
```
  - set
```
public InstantColumn set(int index,
                         Instant value)
```
    Specified by:
    
    set in interface Column<Instant>
  - top
```
public List<Instant> 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<Instant> 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<Instant> 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<Instant>
    
    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<Instant>
    
    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<Instant> iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface Iterable<Instant>
    
    Returns:
    
    an Iterator.
  - fillWith
```
public InstantColumn fillWith(Iterator<Instant> iterator)
```
    Specified by:
    
    fillWith in interface TemporalFillers<Instant,InstantColumn>
  - fillWith
```
public InstantColumn fillWith(Iterable<Instant> iterable)
```
    Specified by:
    
    fillWith in interface TemporalFillers<Instant,InstantColumn>
  - fillWith
```
public InstantColumn fillWith(Supplier<Instant> supplier)
```
    Specified by:
    
    fillWith in interface TemporalFillers<Instant,InstantColumn>
  - asObjectArray
```
public Instant[] asObjectArray()
```
    Specified by:
    
    asObjectArray in interface Column<Instant>
  - compare
```
public int compare(Instant o1,
                   Instant o2)
```
    Specified by:
    
    compare in interface Comparator<Instant>
  - setName
```
public InstantColumn setName(String name)
```
    Description copied from interface: Column
    
    Sets the columns name to the given string
    
    Specified by:
    
    setName in interface Column<Instant>
    
    Overrides:
    
    setName in class AbstractColumn<Instant>
    
    Parameters:
    
    name - The new name MUST be unique for any table containing this column
    
    Returns:
    
    this Column to allow method chaining
  - filter
```
public InstantColumn filter(Predicate<? super Instant> test)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type with only those rows satisfying the predicate
    
    Specified by:
    
    filter in interface Column<Instant>
    
    Parameters:
    
    test - the predicate
    
    Returns:
    
    a new Column of the same type with only those rows satisfying the predicate
  - sorted
```
public InstantColumn sorted(Comparator<? super Instant> comp)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type sorted according to the provided Comparator
    
    Specified by:
    
    sorted in interface Column<Instant>
    
    Parameters:
    
    comp - the Comparator
    
    Returns:
    
    a sorted Column
  - map
```
public InstantColumn map(Function<? super Instant,? extends Instant> fun)
```
    Description copied from interface: Column
    
    Maps the function across all rows, appending the results to a new Column of the same type
    
    Specified by:
    
    map in interface Column<Instant>
    
    Parameters:
    
    fun - function to map
    
    Returns:
    
    the Column with the results
  - min
```
public InstantColumn min(Column<Instant> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    min in interface Column<Instant>
  - max
```
public InstantColumn max(Column<Instant> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    max in interface Column<Instant>
  - set
```
public InstantColumn set(Selection condition,
                         Column<Instant> other)
```
    Description copied from interface: Column
    
    Updates this column where values matching the selection are replaced with the corresponding value from the given column
    
    Specified by:
    
    set in interface Column<Instant>
  - first
```
public InstantColumn first(int numRows)
```
    Specified by:
    
    first in interface Column<Instant>
  - last
```
public InstantColumn last(int numRows)
```
    Specified by:
    
    last in interface Column<Instant>
  - inRange
```
public InstantColumn inRange(int start,
                             int end)
```
    Description copied from interface: Column
    
    Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
    
    Specified by:
    
    inRange in interface Column<Instant>
  - sampleN
```
public InstantColumn sampleN(int n)
```
    Description copied from interface: Column
    
    Returns a column containing a random sample of the values in this column
    
    Specified by:
    
    sampleN in interface Column<Instant>
    
    Parameters:
    
    n - the number of values to select
    
    Returns:
    
    A column of the same type as the receiver
  - sampleX
```
public InstantColumn sampleX(double proportion)
```
    Description copied from interface: Column
    
    Returns a table consisting of randomly selected values from this column. The sample size is based on the given proportion of the total number of cells in this column
    
    Specified by:
    
    sampleX in interface Column<Instant>
    
    Parameters:
    
    proportion - The proportion to go in the sample

Class InstantColumn

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.temporal.TemporalMapFunctions

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Comparator

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

Methods inherited from interface tech.tablesaw.api.CategoricalColumn

Method Detail

create

create

create

create

valueIsMissing

isMissing

subset

removeMissing

contains

setMissing

where

setPrintFormatter

lag

appendCell

appendCell

append

appendObj

size

data

appendInternal

getString

getUnformattedString

emptyCopy

emptyCopy

copy

clear

sortAscending

sortDescending

summary

countUnique

unique

isEmpty

getLongInternal

getPackedDateTime

get

rowComparator

set

countMissing

asEpochSecondArray

asEpochSecondArray

asEpochMillisArray

asEpochMillisArray

asLocalDateTimeColumn

asLocalDateTimeColumn

append

append

set

max

appendMissing

min

set

set

top

bottom

longIterator

asSet

byteSize

asBytes

getDouble

asDoubleArray

asDoubleColumn

iterator

fillWith

fillWith

fillWith

asObjectArray

compare