tech.tablesaw.columns.times.TimeMapFunctions Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package tech.tablesaw.columns.times;
import static java.time.temporal.ChronoUnit.HOURS;
import static java.time.temporal.ChronoUnit.MILLIS;
import static java.time.temporal.ChronoUnit.MINUTES;
import static java.time.temporal.ChronoUnit.SECONDS;
import com.google.common.base.Strings;
import java.time.LocalTime;
import java.time.temporal.ChronoUnit;
import java.time.temporal.UnsupportedTemporalTypeException;
import tech.tablesaw.api.DoubleColumn;
import tech.tablesaw.api.IntColumn;
import tech.tablesaw.api.StringColumn;
import tech.tablesaw.api.TimeColumn;
import tech.tablesaw.columns.Column;
import tech.tablesaw.columns.numbers.IntColumnType;
import tech.tablesaw.columns.numbers.NumberColumnFormatter;
import tech.tablesaw.columns.strings.StringColumnType;
public interface TimeMapFunctions extends Column {
default IntColumn differenceInMilliseconds(TimeColumn column2) {
return difference(column2, MILLIS);
}
default IntColumn differenceInSeconds(TimeColumn column2) {
return difference(column2, SECONDS);
}
default IntColumn differenceInMinutes(TimeColumn column2) {
return difference(column2, MINUTES);
}
default IntColumn differenceInHours(TimeColumn column2) {
return difference(column2, HOURS);
}
@Override
default TimeColumn lead(int n) {
TimeColumn column = lag(-n);
column.setName(name() + " lead(" + n + ")");
return column;
}
TimeColumn lag(int n);
default IntColumn difference(TimeColumn column2, ChronoUnit unit) {
IntColumn newColumn =
IntColumn.create(name() + " - " + column2.name() + "[" + unit.name() + "]");
for (int r = 0; r < size(); r++) {
int c1 = this.getIntInternal(r);
int c2 = column2.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1) || TimeColumn.valueIsMissing(c2)) {
newColumn.append(IntColumnType.missingValueIndicator());
} else {
LocalTime value1 = PackedLocalTime.asLocalTime(c1);
LocalTime value2 = PackedLocalTime.asLocalTime(c2);
if (value1 != null && value2 != null) {
newColumn.append((int) unit.between(value1, value2));
} else {
newColumn.appendMissing();
}
}
}
return newColumn;
}
default TimeColumn plus(int time, ChronoUnit unit) {
TimeColumn newColumn = TimeColumn.create("");
String timeUnitString = "";
for (int r = 0; r < size(); r++) {
int c1 = this.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1)) {
newColumn.appendInternal(TimeColumnType.missingValueIndicator());
} else {
switch (unit) {
case HOURS:
newColumn.appendInternal(PackedLocalTime.plusHours(time, c1));
timeUnitString = "hours";
break;
case MINUTES:
newColumn.appendInternal(PackedLocalTime.plusMinutes(time, c1));
timeUnitString = "minutes";
break;
case SECONDS:
newColumn.appendInternal(PackedLocalTime.plusSeconds(time, c1));
timeUnitString = "seconds";
break;
case MILLIS:
newColumn.appendInternal(PackedLocalTime.plusMilliseconds(time, c1));
timeUnitString = "ms";
break;
default:
throw new UnsupportedTemporalTypeException(
"Type " + unit + " is not currently supported");
}
}
}
newColumn.setName(name() + " + " + time + " " + timeUnitString + "(s)");
return newColumn;
}
default TimeColumn minus(int time, ChronoUnit unit) {
TimeColumn newColumn = TimeColumn.create("");
String timeUnitString = "";
for (int r = 0; r < size(); r++) {
int c1 = this.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1)) {
newColumn.appendInternal(TimeColumnType.missingValueIndicator());
} else {
switch (unit) {
case HOURS:
newColumn.appendInternal(PackedLocalTime.minusHours(time, c1));
timeUnitString = "hours";
break;
case MINUTES:
newColumn.appendInternal(PackedLocalTime.minusMinutes(time, c1));
timeUnitString = "minutes";
break;
case SECONDS:
newColumn.appendInternal(PackedLocalTime.minusSeconds(time, c1));
timeUnitString = "seconds";
break;
case MILLIS:
newColumn.appendInternal(PackedLocalTime.minusMilliseconds(time, c1));
timeUnitString = "ms";
break;
default:
throw new UnsupportedTemporalTypeException(
"Type " + unit + " is not currently supported");
}
}
}
newColumn.setName(name() + " - " + time + " " + timeUnitString + "(s)");
return newColumn;
}
default TimeColumn with(int time, ChronoUnit unit) {
TimeColumn newColumn = TimeColumn.create("");
String timeUnitString = "";
for (int r = 0; r < size(); r++) {
int c1 = this.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1)) {
newColumn.appendInternal(TimeColumnType.missingValueIndicator());
} else {
switch (unit) {
case HOURS:
newColumn.appendInternal(PackedLocalTime.withHour(time, c1));
timeUnitString = "hours";
break;
case MINUTES:
newColumn.appendInternal(PackedLocalTime.withMinute(time, c1));
timeUnitString = "minutes";
break;
case SECONDS:
newColumn.appendInternal(PackedLocalTime.withSecond(time, c1));
timeUnitString = "seconds";
break;
case MILLIS:
newColumn.appendInternal(PackedLocalTime.withMillisecond(time, c1));
timeUnitString = "ms";
break;
default:
throw new UnsupportedTemporalTypeException(
"Type " + unit + " is not currently supported");
}
}
}
newColumn.setName(name() + " with " + time + " " + timeUnitString + "(s)");
return newColumn;
}
default TimeColumn withHour(int hours) {
return with(hours, HOURS);
}
default TimeColumn plusHours(int hours) {
return plus(hours, HOURS);
}
default TimeColumn withMinute(int minutes) {
return with(minutes, MINUTES);
}
default TimeColumn plusMinutes(int minutes) {
return plus(minutes, MINUTES);
}
default TimeColumn withSecond(int seconds) {
return with(seconds, SECONDS);
}
default TimeColumn plusSeconds(int seconds) {
return plus(seconds, SECONDS);
}
default TimeColumn withMillisecond(int millis) {
return with(millis, MILLIS);
}
default TimeColumn plusMilliseconds(int millis) {
return plus(millis, MILLIS);
}
default TimeColumn minusHours(int hours) {
return minus(hours, HOURS);
}
default TimeColumn minusMinutes(int minutes) {
return minus(minutes, MINUTES);
}
default TimeColumn minusSeconds(int seconds) {
return minus(seconds, SECONDS);
}
default TimeColumn minusMilliseconds(int millis) {
return minus(millis, MILLIS);
}
default TimeColumn truncatedTo(ChronoUnit unit) {
TimeColumn newColumn = TimeColumn.create("");
for (int r = 0; r < size(); r++) {
int c1 = this.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1)) {
newColumn.appendInternal(TimeColumnType.missingValueIndicator());
} else {
newColumn.appendInternal(PackedLocalTime.truncatedTo(unit, c1));
}
}
return newColumn;
}
default IntColumn hour() {
IntColumn newColumn = IntColumn.create(name() + "[" + "hour" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!TimeColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getHour(c1));
} else {
newColumn.append(IntColumnType.missingValueIndicator());
}
}
return newColumn;
}
default IntColumn minute() {
IntColumn newColumn = IntColumn.create(name() + "[" + "minute" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!IntColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getMinute(c1));
} else {
newColumn.append(IntColumnType.missingValueIndicator());
}
}
return newColumn;
}
default IntColumn second() {
IntColumn newColumn = IntColumn.create(name() + "[" + "second" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!TimeColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getSecond(c1));
} else {
newColumn.appendMissing();
}
}
return newColumn;
}
default IntColumn milliseconds() {
IntColumn newColumn = IntColumn.create(name() + "[" + "ms" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!TimeColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getMilliseconds(c1));
} else {
newColumn.appendMissing();
}
}
return newColumn;
}
default IntColumn minuteOfDay() {
IntColumn newColumn = IntColumn.create(name() + "[" + "minute-of-day" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!TimeColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getMinuteOfDay(c1));
} else {
newColumn.appendMissing();
}
}
return newColumn;
}
default IntColumn secondOfDay() {
IntColumn newColumn = IntColumn.create(name() + "[" + "second-of-day" + "]");
for (int r = 0; r < size(); r++) {
int c1 = getIntInternal(r);
if (!TimeColumn.valueIsMissing(c1)) {
newColumn.append(PackedLocalTime.getSecondOfDay(c1));
} else {
newColumn.append(IntColumnType.missingValueIndicator());
}
}
return newColumn;
}
/**
* 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.
*
* @param unit A ChronoUnit greater than or equal to a day
* @param n The number of units in each group.
* @param start The starting point of the first group; group boundaries are offsets from this
* point
*/
default DoubleColumn timeWindow(ChronoUnit unit, int n, LocalTime start) {
String newColumnName = "" + n + " " + unit.toString() + " window [" + name() + "]";
int packedStartTime = PackedLocalTime.pack(start);
DoubleColumn numberColumn = DoubleColumn.create(newColumnName, size());
for (int i = 0; i < size(); i++) {
int packedTime = getIntInternal(i);
int result;
switch (unit) {
case HOURS:
result = PackedLocalTime.hoursUntil(packedTime, packedStartTime) / n;
numberColumn.append(result);
break;
case MINUTES:
result = PackedLocalTime.minutesUntil(packedTime, packedStartTime) / n;
numberColumn.append(result);
break;
case SECONDS:
result = PackedLocalTime.secondsUntil(packedTime, packedStartTime) / n;
numberColumn.append(result);
break;
default:
throw new UnsupportedTemporalTypeException(
"The ChronoUnit " + unit + " is not supported for timeWindows on times");
}
}
numberColumn.setPrintFormatter(NumberColumnFormatter.ints());
return numberColumn;
}
/**
* Returns a StringColumn with the hour and minute-of-hour 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
*/
default StringColumn hourMinute() {
StringColumn newColumn = StringColumn.create(this.name() + " hour & minute");
for (int r = 0; r < this.size(); r++) {
int c1 = this.getIntInternal(r);
if (TimeColumn.valueIsMissing(c1)) {
newColumn.append(StringColumnType.missingValueIndicator());
} else {
String hm = Strings.padStart(String.valueOf(PackedLocalTime.getHour(c1)), 2, '0');
hm = hm + "-" + Strings.padStart(String.valueOf(PackedLocalTime.getMinute(c1)), 2, '0');
newColumn.append(hm);
}
}
return newColumn;
}
default DoubleColumn timeWindow(ChronoUnit unit, int n) {
return timeWindow(unit, n, min());
}
LocalTime get(int r);
int getIntInternal(int r);
LocalTime min();
}