DateTimeMapFunctions (tablesaw-core 0.42.0 API)

All Superinterfaces:

Column<LocalDateTime>, Comparator<LocalDateTime>, Iterable<LocalDateTime>, TemporalColumn<LocalDateTime>, TemporalMapFunctions<LocalDateTime>

All Known Implementing Classes:

DateTimeColumn
```
public interface DateTimeMapFunctions
extends TemporalMapFunctions<LocalDateTime>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default DateColumn`	`date()`	Returns a DateColumn containing the date portion of each dateTime in this DateTimeColumn
`default IntColumn`	`dayOfMonth()`
`default StringColumn`	`dayOfWeek()`
`default IntColumn`	`dayOfWeekValue()`
`default IntColumn`	`dayOfYear()`
`default IntColumn`	`hour()`
`default StringColumn`	`hourMinute()`	Returns a StringColumn with the year and week-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
`DateTimeColumn`	`lag(int n)`	Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`default DateTimeColumn`	`lead(int n)`	Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
`default IntColumn`	`minute()`
`default IntColumn`	`minuteOfDay()`
`default StringColumn`	`month()`	Returns a StringColumn containing the name of the month for each date/time in this column
`default IntColumn`	`monthValue()`
`DateTimeColumn`	`plus(long amountToAdd, ChronoUnit unit)`
`default DateTimeColumn`	`plusDays(long amountToAdd)`
`default DateTimeColumn`	`plusHours(long amountToAdd)`
`default DateTimeColumn`	`plusMicros(long amountToAdd)`
`default DateTimeColumn`	`plusMillis(long amountToAdd)`
`default DateTimeColumn`	`plusMinutes(long amountToAdd)`
`default DateTimeColumn`	`plusMonths(long amountToAdd)`
`default DateTimeColumn`	`plusSeconds(long amountToAdd)`
`default DateTimeColumn`	`plusWeeks(long amountToAdd)`
`default DateTimeColumn`	`plusYears(long amountToAdd)`
`default IntColumn`	`secondOfDay()`
`default TimeColumn`	`time()`	Returns a TimeColumn containing the time portion of each dateTime in this DateTimeColumn
`default LongColumn`	`timeWindow(ChronoUnit unit, int n)`
`default LongColumn`	`timeWindow(ChronoUnit unit, int n, LocalDateTime start)`	Returns a column containing integers representing the nth group (0-based) that a date falls into.
`default IntColumn`	`year()`
`default StringColumn`	`yearDay()`	Returns a StringColumn with the year and day-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
`default StringColumn`	`yearMonth()`	Returns a StringColumn with the year and month from this column concatenated into a String that will sort lexicographically in temporal order.
`default StringColumn`	`yearQuarter()`	Returns a StringColumn with the year and quarter from this column concatenated into a String that will sort lexicographically in temporal order.
`default StringColumn`	`yearWeek()`	Returns a StringColumn with the year and week-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.

Methods inherited from interface tech.tablesaw.columns.Column
allMatch, anyMatch, append, append, append, appendCell, appendCell, appendMissing, appendObj, asBytes, asList, asObjectArray, asSet, asStringColumn, byteSize, clear, columnWidth, contains, copy, count, count, countMissing, countUnique, emptyCopy, filter, first, getString, getUnformattedString, indexOf, inRange, interpolate, isEmpty, isMissing, isMissing, isNotMissing, last, map, map, mapInto, max, max, min, min, name, noneMatch, parser, print, reduce, reduce, removeMissing, rolling, rowComparator, sampleN, sampleX, set, set, set, set, set, set, setMissing, setMissingTo, setName, setParser, size, sortAscending, sortDescending, sorted, subset, summary, title, type, unique, where

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

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

Methods inherited from interface tech.tablesaw.columns.temporal.TemporalColumn
appendInternal, get, getLongInternal

Methods inherited from interface tech.tablesaw.columns.temporal.TemporalMapFunctions
difference, differenceInDays, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, differenceInYears, emptyCopy, min, missingValues, temporalColumnName

- Method Detail
  - hour
```
default IntColumn hour()
```
  - minuteOfDay
```
default IntColumn minuteOfDay()
```
  - secondOfDay
```
default IntColumn secondOfDay()
```
  - lead
```
default DateTimeColumn lead(int n)
```
    Description copied from interface: Column
    
    Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
    
    Specified by:
    
    lead in interface Column<LocalDateTime>
  - lag
```
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<LocalDateTime>
  - time
```
default TimeColumn time()
```
    Returns a TimeColumn containing the time portion of each dateTime in this DateTimeColumn
  - monthValue
```
default IntColumn monthValue()
```
  - month
```
default StringColumn month()
```
    Returns a StringColumn containing the name of the month for each date/time in this column
  - yearQuarter
```
default StringColumn yearQuarter()
```
    Returns a StringColumn with the year and quarter from this column concatenated into a String that will sort lexicographically in temporal order.
    This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - plus
```
DateTimeColumn plus(long amountToAdd,
                    ChronoUnit unit)
```
    Specified by:
    
    plus in interface TemporalMapFunctions<LocalDateTime>
  - plusYears
```
default DateTimeColumn plusYears(long amountToAdd)
```
    Specified by:
    
    plusYears in interface TemporalMapFunctions<LocalDateTime>
  - plusMonths
```
default DateTimeColumn plusMonths(long amountToAdd)
```
    Specified by:
    
    plusMonths in interface TemporalMapFunctions<LocalDateTime>
  - plusWeeks
```
default DateTimeColumn plusWeeks(long amountToAdd)
```
    Specified by:
    
    plusWeeks in interface TemporalMapFunctions<LocalDateTime>
  - plusDays
```
default DateTimeColumn plusDays(long amountToAdd)
```
    Specified by:
    
    plusDays in interface TemporalMapFunctions<LocalDateTime>
  - plusHours
```
default DateTimeColumn plusHours(long amountToAdd)
```
    Specified by:
    
    plusHours in interface TemporalMapFunctions<LocalDateTime>
  - plusMinutes
```
default DateTimeColumn plusMinutes(long amountToAdd)
```
    Specified by:
    
    plusMinutes in interface TemporalMapFunctions<LocalDateTime>
  - plusSeconds
```
default DateTimeColumn plusSeconds(long amountToAdd)
```
    Specified by:
    
    plusSeconds in interface TemporalMapFunctions<LocalDateTime>
  - plusMillis
```
default DateTimeColumn plusMillis(long amountToAdd)
```
    Specified by:
    
    plusMillis in interface TemporalMapFunctions<LocalDateTime>
  - plusMicros
```
default DateTimeColumn plusMicros(long amountToAdd)
```
    Specified by:
    
    plusMicros in interface TemporalMapFunctions<LocalDateTime>
  - yearMonth
```
default StringColumn yearMonth()
```
    Returns a StringColumn with the year and month from this column concatenated into a String that will sort lexicographically in temporal order.
    This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - yearDay
```
default StringColumn yearDay()
```
    Returns a StringColumn with the year and day-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
    This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - hourMinute
```
default StringColumn hourMinute()
```
    Returns a StringColumn with the year and week-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
    This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - yearWeek
```
default StringColumn yearWeek()
```
    Returns a StringColumn with the year and week-of-year derived from this column concatenated into a String that will sort lexicographically in temporal order.
    This simplifies the production of plots and tables that aggregate values into standard temporal units (e.g., you want monthly data but your source data is more than a year long and you don't want months from different years aggregated together).
  - date
```
default DateColumn date()
```
    Returns a DateColumn containing the date portion of each dateTime in this DateTimeColumn
  - year
```
default IntColumn year()
```
  - dayOfWeek
```
default StringColumn dayOfWeek()
```
  - dayOfWeekValue
```
default IntColumn dayOfWeekValue()
```
  - dayOfYear
```
default IntColumn dayOfYear()
```
  - dayOfMonth
```
default IntColumn dayOfMonth()
```
  - timeWindow
```
default LongColumn timeWindow(ChronoUnit unit,
                              int n,
                              LocalDateTime start)
```
    Returns a column containing integers representing the nth group (0-based) that a date falls into.
    Example: When Unit = ChronoUnit.DAY and n = 5, we form 5 day groups. a Date that is 2 days after the start is assigned to the first ("0") group. A day 7 days after the start is assigned to the second ("1") group.
    
    Parameters:
    
    unit - A ChronoUnit greater than or equal to a minute
    
    n - The number of units in each group.
    
    start - The starting point of the first group; group boundaries are offsets from this point
  - minute
```
default IntColumn minute()
```
  - timeWindow
```
default LongColumn timeWindow(ChronoUnit unit,
                              int n)
```

Interface DateTimeMapFunctions

Method Summary

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.util.Comparator

Methods inherited from interface java.lang.Iterable

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

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

Method Detail

hour

minuteOfDay

secondOfDay

lead

lag

time

monthValue

month

yearQuarter

plus

plusYears

plusMonths

plusWeeks

plusDays

plusHours

plusMinutes

plusSeconds

plusMillis

plusMicros

yearMonth

yearDay

hourMinute

yearWeek

date

year

dayOfWeek

dayOfWeekValue

dayOfYear

dayOfMonth

timeWindow

minute

timeWindow