/*
* Copyright 2004-2019 H2 Group. Multiple-Licensed under the MPL 2.0,
* and the EPL 1.0 (http://h2database.com/html/license.html).
* Initial Developer: H2 Group
*/
package org.h2.value;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Timestamp;
import org.h2.api.ErrorCode;
import org.h2.engine.Mode;
import org.h2.message.DbException;
import org.h2.util.DateTimeUtils;
Implementation of the TIMESTAMP data type.
/**
* Implementation of the TIMESTAMP data type.
*/
public class ValueTimestamp extends Value {
The default precision and display size of the textual representation of a timestamp.
Example: 2001-01-01 23:59:59.123456
/**
* The default precision and display size of the textual representation of a timestamp.
* Example: 2001-01-01 23:59:59.123456
*/
public static final int DEFAULT_PRECISION = 26;
The maximum precision and display size of the textual representation of a timestamp.
Example: 2001-01-01 23:59:59.123456789
/**
* The maximum precision and display size of the textual representation of a timestamp.
* Example: 2001-01-01 23:59:59.123456789
*/
public static final int MAXIMUM_PRECISION = 29;
The default scale for timestamps.
/**
* The default scale for timestamps.
*/
static final int DEFAULT_SCALE = 6;
The maximum scale for timestamps.
/**
* The maximum scale for timestamps.
*/
public static final int MAXIMUM_SCALE = 9;
A bit field with bits for the year, month, and day (see DateTimeUtils for
encoding)
/**
* A bit field with bits for the year, month, and day (see DateTimeUtils for
* encoding)
*/
private final long dateValue;
The nanoseconds since midnight.
/**
* The nanoseconds since midnight.
*/
private final long timeNanos;
private ValueTimestamp(long dateValue, long timeNanos) {
this.dateValue = dateValue;
if (timeNanos < 0 || timeNanos >= DateTimeUtils.NANOS_PER_DAY) {
throw new IllegalArgumentException("timeNanos out of range " + timeNanos);
}
this.timeNanos = timeNanos;
}
Get or create a date value for the given date.
Params: - dateValue – the date value, a bit field with bits for the year,
month, and day
- timeNanos – the nanoseconds since midnight
Returns: the value
/**
* Get or create a date value for the given date.
*
* @param dateValue the date value, a bit field with bits for the year,
* month, and day
* @param timeNanos the nanoseconds since midnight
* @return the value
*/
public static ValueTimestamp fromDateValueAndNanos(long dateValue, long timeNanos) {
return (ValueTimestamp) Value.cache(new ValueTimestamp(dateValue, timeNanos));
}
Get or create a timestamp value for the given timestamp.
Params: - timestamp – the timestamp
Returns: the value
/**
* Get or create a timestamp value for the given timestamp.
*
* @param timestamp the timestamp
* @return the value
*/
public static ValueTimestamp get(Timestamp timestamp) {
long ms = timestamp.getTime();
long nanos = timestamp.getNanos() % 1_000_000;
ms += DateTimeUtils.getTimeZoneOffset(ms);
long dateValue = DateTimeUtils.dateValueFromLocalMillis(ms);
nanos += DateTimeUtils.nanosFromLocalMillis(ms);
return fromDateValueAndNanos(dateValue, nanos);
}
Get or create a timestamp value for the given date/time in millis.
Params: - ms – the milliseconds
- nanos – the nanoseconds
Returns: the value
/**
* Get or create a timestamp value for the given date/time in millis.
*
* @param ms the milliseconds
* @param nanos the nanoseconds
* @return the value
*/
public static ValueTimestamp fromMillisNanos(long ms, int nanos) {
ms += DateTimeUtils.getTimeZoneOffset(ms);
long dateValue = DateTimeUtils.dateValueFromLocalMillis(ms);
long timeNanos = nanos + DateTimeUtils.nanosFromLocalMillis(ms);
return fromDateValueAndNanos(dateValue, timeNanos);
}
Get or create a timestamp value for the given date/time in millis.
Params: - ms – the milliseconds
Returns: the value
/**
* Get or create a timestamp value for the given date/time in millis.
*
* @param ms the milliseconds
* @return the value
*/
public static ValueTimestamp fromMillis(long ms) {
ms += DateTimeUtils.getTimeZoneOffset(ms);
long dateValue = DateTimeUtils.dateValueFromLocalMillis(ms);
long nanos = DateTimeUtils.nanosFromLocalMillis(ms);
return fromDateValueAndNanos(dateValue, nanos);
}
Parse a string to a ValueTimestamp. This method supports the format
+/-year-month-day hour[:.]minute[:.]seconds.fractional and an optional timezone
part.
Params: - s – the string to parse
Returns: the date
/**
* Parse a string to a ValueTimestamp. This method supports the format
* +/-year-month-day hour[:.]minute[:.]seconds.fractional and an optional timezone
* part.
*
* @param s the string to parse
* @return the date
*/
public static ValueTimestamp parse(String s) {
return parse(s, null);
}
Parse a string to a ValueTimestamp, using the given Mode
. This method supports the format +/-year-month-day[ -]hour[:.]minute[:.]seconds.fractional and an optional timezone part. Params: - s – the string to parse
- mode – the database
Mode
Returns: the date
/**
* Parse a string to a ValueTimestamp, using the given {@link Mode}.
* This method supports the format +/-year-month-day[ -]hour[:.]minute[:.]seconds.fractional
* and an optional timezone part.
*
* @param s the string to parse
* @param mode the database {@link Mode}
* @return the date
*/
public static ValueTimestamp parse(String s, Mode mode) {
try {
return (ValueTimestamp) DateTimeUtils.parseTimestamp(s, mode, false);
} catch (Exception e) {
throw DbException.get(ErrorCode.INVALID_DATETIME_CONSTANT_2,
e, "TIMESTAMP", s);
}
}
A bit field with bits for the year, month, and day (see DateTimeUtils for
encoding).
Returns: the data value
/**
* A bit field with bits for the year, month, and day (see DateTimeUtils for
* encoding).
*
* @return the data value
*/
public long getDateValue() {
return dateValue;
}
The nanoseconds since midnight.
Returns: the nanoseconds
/**
* The nanoseconds since midnight.
*
* @return the nanoseconds
*/
public long getTimeNanos() {
return timeNanos;
}
@Override
public Timestamp getTimestamp() {
return DateTimeUtils.convertDateValueToTimestamp(dateValue, timeNanos);
}
@Override
public TypeInfo getType() {
return TypeInfo.TYPE_TIMESTAMP;
}
@Override
public int getValueType() {
return TIMESTAMP;
}
@Override
public int getMemory() {
return 32;
}
@Override
public String getString() {
StringBuilder buff = new StringBuilder(MAXIMUM_PRECISION);
DateTimeUtils.appendDate(buff, dateValue);
buff.append(' ');
DateTimeUtils.appendTime(buff, timeNanos);
return buff.toString();
}
@Override
public StringBuilder getSQL(StringBuilder builder) {
builder.append("TIMESTAMP '");
DateTimeUtils.appendDate(builder, dateValue);
builder.append(' ');
DateTimeUtils.appendTime(builder, timeNanos);
return builder.append('\'');
}
@Override
public boolean checkPrecision(long precision) {
// TIMESTAMP data type does not have precision parameter
return true;
}
@Override
public Value convertScale(boolean onlyToSmallerScale, int targetScale) {
if (targetScale >= MAXIMUM_SCALE) {
return this;
}
if (targetScale < 0) {
throw DbException.getInvalidValueException("scale", targetScale);
}
long n = timeNanos;
long n2 = DateTimeUtils.convertScale(n, targetScale);
if (n2 == n) {
return this;
}
long dv = dateValue;
if (n2 >= DateTimeUtils.NANOS_PER_DAY) {
n2 -= DateTimeUtils.NANOS_PER_DAY;
dv = DateTimeUtils.incrementDateValue(dv);
}
return fromDateValueAndNanos(dv, n2);
}
@Override
public int compareTypeSafe(Value o, CompareMode mode) {
ValueTimestamp t = (ValueTimestamp) o;
int c = Long.compare(dateValue, t.dateValue);
if (c != 0) {
return c;
}
return Long.compare(timeNanos, t.timeNanos);
}
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
} else if (!(other instanceof ValueTimestamp)) {
return false;
}
ValueTimestamp x = (ValueTimestamp) other;
return dateValue == x.dateValue && timeNanos == x.timeNanos;
}
@Override
public int hashCode() {
return (int) (dateValue ^ (dateValue >>> 32) ^ timeNanos ^ (timeNanos >>> 32));
}
@Override
public Object getObject() {
return getTimestamp();
}
@Override
public void set(PreparedStatement prep, int parameterIndex)
throws SQLException {
prep.setTimestamp(parameterIndex, getTimestamp());
}
@Override
public Value add(Value v) {
ValueTimestamp t = (ValueTimestamp) v.convertTo(Value.TIMESTAMP);
long d1 = DateTimeUtils.absoluteDayFromDateValue(dateValue);
long d2 = DateTimeUtils.absoluteDayFromDateValue(t.dateValue);
return DateTimeUtils.normalizeTimestamp(d1 + d2, timeNanos + t.timeNanos);
}
@Override
public Value subtract(Value v) {
ValueTimestamp t = (ValueTimestamp) v.convertTo(Value.TIMESTAMP);
long d1 = DateTimeUtils.absoluteDayFromDateValue(dateValue);
long d2 = DateTimeUtils.absoluteDayFromDateValue(t.dateValue);
return DateTimeUtils.normalizeTimestamp(d1 - d2, timeNanos - t.timeNanos);
}
}