DateMapFunctions (tablesaw-core 0.24.1 API)

All Superinterfaces:

Column

All Known Implementing Classes:

DateColumn
```
public interface DateMapFunctions
extends Column
```
An interface for mapping operations unique to Date columns

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default DateTimeColumn`	`atStartOfDay()`
`default DateTimeColumn`	`atTime(LocalTime time)`	Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
`default DateTimeColumn`	`atTime(TimeColumn timeColumn)`	Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
`static String`	`dateColumnName(Column column1, int value, TemporalUnit unit)`
`default NumberColumn`	`dayOfMonth()`
`default StringColumn`	`dayOfWeek()`
`default NumberColumn`	`dayOfWeekValue()`
`default NumberColumn`	`dayOfYear()`
`default NumberColumn`	`daysUntil(DateColumn column2)`
`LocalDate`	`get(int index)`
`int`	`getIntInternal(int r)`
`LocalDate`	`max()`
`LocalDate`	`min()`
`default DateColumn`	`minus(int value, ChronoUnit unit)`
`default DateColumn`	`minusDays(int days)`
`default DateColumn`	`minusMonths(int months)`
`default DateColumn`	`minusWeeks(int weeks)`
`default DateColumn`	`minusYears(int years)`
`default StringColumn`	`month()`
`default NumberColumn`	`monthsUntil(DateColumn column2)`
`default NumberColumn`	`monthValue()`
`default DateColumn`	`plus(int value, ChronoUnit unit)`
`default DateColumn`	`plusDays(int days)`
`default DateColumn`	`plusMonths(int months)`
`default DateColumn`	`plusWeeks(int weeks)`
`default DateColumn`	`plusYears(int years)`
`default NumberColumn`	`timeUntil(DateColumn end, ChronoUnit unit)`	Calculates the temporal difference between each element of the receiver and the respective element of the argument
`default NumberColumn`	`timeWindow(ChronoUnit unit, int n)`
`default NumberColumn`	`timeWindow(ChronoUnit unit, int n, LocalDate start)`	Returns a column containing integers representing the nth group (0-based) that a date falls into.
`default NumberColumn`	`weeksUntil(DateColumn column2)`
`default NumberColumn`	`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 NumberColumn`	`yearsUntil(DateColumn column2)`
`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
append, appendCell, appendMissing, asBytes, asDoubleArray, asObjectArray, byteSize, clear, columnWidth, copy, countMissing, countUnique, create, emptyCopy, emptyCopy, first, getDouble, getString, getUnformattedString, inRange, isEmpty, isMissing, isMissing, isNotMissing, lag, last, lead, name, print, removeMissing, rolling, rowComparator, rows, sampleN, sampleX, setName, size, sortAscending, sortDescending, subset, summarizeIf, summary, title, type, unique, where

- Method Detail
  - dateColumnName
```
static String dateColumnName(Column column1,
                             int value,
                             TemporalUnit unit)
```
  - daysUntil
```
default NumberColumn daysUntil(DateColumn column2)
```
  - weeksUntil
```
default NumberColumn weeksUntil(DateColumn column2)
```
  - monthsUntil
```
default NumberColumn monthsUntil(DateColumn column2)
```
  - yearsUntil
```
default NumberColumn yearsUntil(DateColumn column2)
```
  - dayOfMonth
```
default NumberColumn dayOfMonth()
```
  - dayOfYear
```
default NumberColumn dayOfYear()
```
  - monthValue
```
default NumberColumn monthValue()
```
  - month
```
default StringColumn month()
```
  - year
```
default NumberColumn year()
```
  - 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).
  - 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).
  - 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).
  - dayOfWeekValue
```
default NumberColumn dayOfWeekValue()
```
  - dayOfWeek
```
default StringColumn dayOfWeek()
```
  - timeUntil
```
default NumberColumn timeUntil(DateColumn end,
                               ChronoUnit unit)
```
    Calculates the temporal difference between each element of the receiver and the respective element of the argument
    Missing values in either result in a Missing Value for the new column
  - plusDays
```
default DateColumn plusDays(int days)
```
  - plusWeeks
```
default DateColumn plusWeeks(int weeks)
```
  - plusYears
```
default DateColumn plusYears(int years)
```
  - plusMonths
```
default DateColumn plusMonths(int months)
```
  - minusDays
```
default DateColumn minusDays(int days)
```
  - minusWeeks
```
default DateColumn minusWeeks(int weeks)
```
  - minusYears
```
default DateColumn minusYears(int years)
```
  - minusMonths
```
default DateColumn minusMonths(int months)
```
  - timeWindow
```
default NumberColumn timeWindow(ChronoUnit unit,
                                int n,
                                LocalDate 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 day
    
    n - The number of units in each group.
    
    start - The starting point of the first group; group boundaries are offsets from this point
  - timeWindow
```
default NumberColumn timeWindow(ChronoUnit unit,
                                int n)
```
  - plus
```
default DateColumn plus(int value,
                        ChronoUnit unit)
```
  - minus
```
default DateColumn minus(int value,
                         ChronoUnit unit)
```
  - atStartOfDay
```
default DateTimeColumn atStartOfDay()
```
  - atTime
```
default DateTimeColumn atTime(LocalTime time)
```
    Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
  - atTime
```
default DateTimeColumn atTime(TimeColumn timeColumn)
```
    Returns a DateTime column where each value consists of the dates from this column combined with the corresponding times from the other column
  - getIntInternal
```
int getIntInternal(int r)
```
  - get
```
LocalDate get(int index)
```
  - min
```
LocalDate min()
```
  - max
```
LocalDate max()
```

Interface DateMapFunctions

Method Summary

Methods inherited from interface tech.tablesaw.columns.Column

Method Detail

dateColumnName

daysUntil

weeksUntil

monthsUntil

yearsUntil

dayOfMonth

dayOfYear

monthValue

month

year

yearQuarter

yearMonth

yearDay

yearWeek

dayOfWeekValue

dayOfWeek

timeUntil

plusDays

plusWeeks

plusYears

plusMonths

minusDays

minusWeeks

minusYears

minusMonths

timeWindow

timeWindow

plus

minus

atStartOfDay

atTime

atTime

getIntInternal

get

min

max