org.apache.derby.iapi.types
Class SQLTimestamp

java.lang.Object
  org.apache.derby.iapi.types.DataType
      org.apache.derby.iapi.types.SQLTimestamp

All Implemented Interfaces:

CloneableObject, DataValueDescriptor, DateTimeDataValue, java.io.Externalizable, Formatable, Orderable, java.io.Serializable, Storable, TypedFormat

public final class SQLTimestamp

extends DataType

implements DateTimeDataValue

This contains an instance of a SQL Timestamp object.

SQLTimestamp is stored in 3 ints - an encoded date, an encoded time and nanoseconds encodedDate = 0 indicates a null WSCTimestamp SQLTimestamp is similar to SQLTimestamp, but it does conserves space by not keeping a GregorianCalendar object PERFORMANCE OPTIMIZATION: We only instantiate the value field when required due to the overhead of the Date methods. Thus, use isNull() instead of "value == null" and getTimestamp() instead of using value directly.

See Also:

Serialized Form

Field Summary

private static int	BASE_MEMORY_USAGE
(package private) static char	DATE_SEPARATOR
private static char[]	DATE_SEPARATORS
private static char[]	DATE_TIME_SEPARATORS
private static char[]	DATE_TIME_SEPARATORS_OR_END
private int	encodedDate
private int	encodedTime
private static char[]	END_OF_STRING
(package private) static int	FRACTION_TO_NANO
private static char	IBM_DATE_TIME_SEPARATOR
private static char	IBM_TIME_SEPARATOR
(package private) static int	MAX_FRACTION_DIGITS
private int	nanos
private static char	ODBC_DATE_TIME_SEPARATOR
private static char	ODBC_TIME_SEPARATOR
(package private) static int	ONE_BILLION
private static char[]	TIME_SEPARATORS
private static char[]	TIME_SEPARATORS_OR_END
private java.lang.String	valueString

Fields inherited from interface org.apache.derby.iapi.types.DateTimeDataValue

DAY_FIELD, DAY_INTERVAL, FRAC_SECOND_INTERVAL, HOUR_FIELD, HOUR_INTERVAL, MINUTE_FIELD, MINUTE_INTERVAL, MONTH_FIELD, MONTH_INTERVAL, QUARTER_INTERVAL, SECOND_FIELD, SECOND_INTERVAL, WEEK_INTERVAL, YEAR_FIELD, YEAR_INTERVAL

Fields inherited from interface org.apache.derby.iapi.types.Orderable

ORDER_OP_EQUALS, ORDER_OP_GREATEROREQUALS, ORDER_OP_GREATERTHAN, ORDER_OP_LESSOREQUALS, ORDER_OP_LESSTHAN

Constructor Summary

	SQLTimestamp() no-arg constructor required by Formattable
	SQLTimestamp(DataValueDescriptor date, DataValueDescriptor time)
(package private)	SQLTimestamp(int encodedDate, int encodedTime, int nanos)
	SQLTimestamp(java.lang.String timestampStr, boolean isJDBCEscape, LocaleFinder localeFinder) Construct a timestamp from a string.
	SQLTimestamp(java.lang.String timestampStr, boolean isJDBCEscape, LocaleFinder localeFinder, java.util.Calendar cal) Construct a timestamp from a string.
	SQLTimestamp(java.sql.Timestamp value)

Method Summary

private void	addInternal(int calIntervalType, int count, SQLTimestamp tsResult)
int	compare(DataValueDescriptor other) Compare this Orderable with a given Orderable for the purpose of index positioning.
boolean	compare(int op, DataValueDescriptor other, boolean orderedNulls, boolean unknownRV) Compare this Orderable with a given Orderable for the purpose of qualification and sorting.
private static int	computeEncodedDate(java.util.Date value, java.util.Calendar currentCal) computeEncodedDate sets the date in a Calendar object and then uses the SQLDate function to compute an encoded date The encoded date is year << 16 + month << 8 + date
private static int	computeEncodedTime(java.util.Date value, java.util.Calendar currentCal) computeEncodedTime extracts the hour, minute and seconds from a java.util.Date value and encodes them as hour << 16 + minute << 8 + second using the SQLTime function for encoding the data
static DateTimeDataValue	computeTimestampFunction(DataValueDescriptor operand, DataValueFactory dvf) Compute the SQL timestamp function.
int	estimateMemoryUsage() Estimate the memory usage in bytes of the data value and the overhead of the class.
DataValueDescriptor	getClone() Clone this DataValueDescriptor.
java.sql.Date	getDate(java.util.Calendar cal) getDate returns the date portion of the timestamp Time is set to 00:00:00.0 Since Date is a JDBC object we use the JDBC definition for the time portion.
NumberDataValue	getDate(NumberDataValue result) Get the day of the month.
NumberDataValue	getHours(NumberDataValue result) Get the hour of the day out of a time or timestamp.
int	getLength() Gets the length of the data value.
NumberDataValue	getMinutes(NumberDataValue result) Get the minute of the hour out of a time or timestamp.
NumberDataValue	getMonth(NumberDataValue result) Get the month number out of a date.
protected java.lang.String	getNationalString(LocaleFinder localeFinder) International version of getString().
DataValueDescriptor	getNewNull() Get a new null value of the same type as this data value.
java.lang.Object	getObject() Gets the value in the data value descriptor as a Java Object.
NumberDataValue	getSeconds(NumberDataValue source) Get the second of the minute out of a time or timestamp.
java.lang.String	getString() Gets the value in the data value descriptor as a String.
java.sql.Time	getTime(java.util.Calendar cal) getTime returns the time portion of the timestamp Date is set to 1970-01-01 Since Time is a JDBC object we use the JDBC definition for the date portion.
java.sql.Timestamp	getTimestamp(java.util.Calendar cal) Get the value field.
int	getTypeFormatId() Return my format identifier.
java.lang.String	getTypeName() Get the SQL name of the datatype
NumberDataValue	getYear(NumberDataValue result) Get the year number out of a date.
int	hashCode()
boolean	isNull() Check if the value is null.
private java.sql.Date	newDate(java.util.Calendar cal)
private java.sql.Time	newTime(java.util.Calendar cal)
protected java.sql.Timestamp	newTimestamp(java.util.Calendar currentCal)
(package private) static int[]	parseDateOrTimestamp(DateTimeParser parser, boolean timeRequired) Parse a timestamp or a date.
(package private) static int	parseDateTimeInteger(java.lang.String str, int start, int ndigits)
(package private) static int[]	parseLocalTimestamp(java.lang.String str, LocaleFinder localeFinder, java.util.Calendar cal) Parse a localized timestamp.
private void	parseTimestamp(java.lang.String timestampStr, boolean isJDBCEscape, LocaleFinder localeFinder, java.util.Calendar cal)
(package private) static SQLTimestamp	promote(DateTimeDataValue dateTime, java.sql.Date currentDate) Promotes a DateTimeDataValue to a timestamp.
void	readExternal(java.io.ObjectInput in)
void	readExternalFromArray(ArrayInputStream in) Read the DataValueDescriptor from the stream.
void	restoreToNull() Restore this object to its (SQL)null value.
private void	setCalendar(java.util.Calendar cal)
protected void	setFrom(DataValueDescriptor theValue)
void	setInto(java.sql.PreparedStatement ps, int position) Set this value into a PreparedStatement.
private void	setNumericTimestamp(java.sql.Timestamp value, java.util.Calendar cal) Set the encoded values for the timestamp
void	setValue(java.sql.Date value, java.util.Calendar cal) Set the value of this DataValueDescriptor.
void	setValue(java.lang.Object theValue) Set the value of this DataValueDescriptor to the given value
void	setValue(java.lang.String theValue) Set the value of this DataValueDescriptor.
void	setValue(java.sql.Time value, java.util.Calendar cal) Set the value of this DataValueDescriptor.
void	setValue(java.sql.Timestamp value, java.util.Calendar cal) Set the value of this DataValueDescriptor.
void	setValueFromResultSet(java.sql.ResultSet resultSet, int colNumber, boolean isNullable) Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet.
DateTimeDataValue	timestampAdd(int intervalType, NumberDataValue count, java.sql.Date currentDate, DateTimeDataValue resultHolder) Add a number of intervals to a datetime value.
NumberDataValue	timestampDiff(int intervalType, DateTimeDataValue time1, java.sql.Date currentDate, NumberDataValue resultHolder) Finds the difference between two datetime values as a number of intervals.
java.lang.String	toString()
int	typePrecedence() Each built-in type in JSQL has a precedence.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class org.apache.derby.iapi.types.DataType

checkHostVariable, cloneObject, coalesce, dataTypeConversion, equals, equals, flip, genericSetObject, getBoolean, getByte, getBytes, getDouble, getFloat, getInt, getLong, getShort, getStream, greaterOrEquals, greaterThan, in, invalidFormat, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, outOfRange, setBigDecimal, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, throwLangSetMismatch, throwLangSetMismatch, typeToBigDecimal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.derby.iapi.types.DataValueDescriptor

checkHostVariable, coalesce, equals, getBoolean, getByte, getBytes, getDouble, getFloat, getInt, getLong, getShort, getStream, greaterOrEquals, greaterThan, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, setBigDecimal, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, typeToBigDecimal

Field Detail

MAX_FRACTION_DIGITS

static final int MAX_FRACTION_DIGITS

See Also:

Constant Field Values

FRACTION_TO_NANO

static final int FRACTION_TO_NANO

See Also:

Constant Field Values

ONE_BILLION

static final int ONE_BILLION

See Also:

Constant Field Values

encodedDate

private int encodedDate

encodedTime

private int encodedTime

nanos

private int nanos

valueString

private java.lang.String valueString

BASE_MEMORY_USAGE

private static final int BASE_MEMORY_USAGE

DATE_SEPARATOR

static final char DATE_SEPARATOR

See Also:

Constant Field Values

DATE_SEPARATORS

private static final char[] DATE_SEPARATORS

IBM_DATE_TIME_SEPARATOR

private static final char IBM_DATE_TIME_SEPARATOR

See Also:

Constant Field Values

ODBC_DATE_TIME_SEPARATOR

private static final char ODBC_DATE_TIME_SEPARATOR

See Also:

Constant Field Values

DATE_TIME_SEPARATORS

private static final char[] DATE_TIME_SEPARATORS

DATE_TIME_SEPARATORS_OR_END

private static final char[] DATE_TIME_SEPARATORS_OR_END

IBM_TIME_SEPARATOR

private static final char IBM_TIME_SEPARATOR

See Also:

Constant Field Values

ODBC_TIME_SEPARATOR

private static final char ODBC_TIME_SEPARATOR

See Also:

Constant Field Values

TIME_SEPARATORS

private static final char[] TIME_SEPARATORS

TIME_SEPARATORS_OR_END

private static final char[] TIME_SEPARATORS_OR_END

END_OF_STRING

private static final char[] END_OF_STRING

Constructor Detail

SQLTimestamp

public SQLTimestamp()

no-arg constructor required by Formattable

SQLTimestamp

public SQLTimestamp(java.sql.Timestamp value)
             throws StandardException

SQLTimestamp

SQLTimestamp(int encodedDate,
             int encodedTime,
             int nanos)

SQLTimestamp

public SQLTimestamp(DataValueDescriptor date,
                    DataValueDescriptor time)
             throws StandardException

SQLTimestamp

public SQLTimestamp(java.lang.String timestampStr,
                    boolean isJDBCEscape,
                    LocaleFinder localeFinder)
             throws StandardException

Construct a timestamp from a string. The allowed formats are:

1. JDBC escape: yyyy-mm-dd hh:mm:ss[.fffff]
2. IBM: yyyy-mm-dd-hh.mm.ss[.nnnnnn]

The format is specified by a parameter to the constructor. Leading zeroes may be omitted from the month, day, and hour part of the timestamp. The microsecond part may be omitted or truncated.

SQLTimestamp

public SQLTimestamp(java.lang.String timestampStr,
                    boolean isJDBCEscape,
                    LocaleFinder localeFinder,
                    java.util.Calendar cal)
             throws StandardException

Construct a timestamp from a string. The allowed formats are:

1. JDBC escape: yyyy-mm-dd hh:mm:ss[.fffff]
2. IBM: yyyy-mm-dd-hh.mm.ss[.nnnnnn]

The format is specified by a parameter to the constructor. Leading zeroes may be omitted from the month, day, and hour part of the timestamp. The microsecond part may be omitted or truncated.

Method Detail

estimateMemoryUsage

public int estimateMemoryUsage()

Description copied from interface: DataValueDescriptor

Estimate the memory usage in bytes of the data value and the overhead of the class.

Specified by:

estimateMemoryUsage in interface DataValueDescriptor

Returns:

the estimated memory usage

getString

public java.lang.String getString()

Description copied from interface: DataValueDescriptor

Gets the value in the data value descriptor as a String. Throws an exception if the data value is not a string.

Specified by:

getString in interface DataValueDescriptor

Returns:

The data value as a String.

getDate

public java.sql.Date getDate(java.util.Calendar cal)
                      throws StandardException

getDate returns the date portion of the timestamp Time is set to 00:00:00.0 Since Date is a JDBC object we use the JDBC definition for the time portion. See JDBC API Tutorial, 47.3.12.

Specified by:

getDate in interface DataValueDescriptor

Overrides:

getDate in class DataType

Parameters:

cal - calendar for object creation

Returns:

The data value as a java.sql.Date.

Throws:

StandardException - thrown on failure

newDate

private java.sql.Date newDate(java.util.Calendar cal)
                       throws StandardException

Throws:

StandardException

getTime

public java.sql.Time getTime(java.util.Calendar cal)
                      throws StandardException

getTime returns the time portion of the timestamp Date is set to 1970-01-01 Since Time is a JDBC object we use the JDBC definition for the date portion. See JDBC API Tutorial, 47.3.12.

Specified by:

getTime in interface DataValueDescriptor

Overrides:

getTime in class DataType

Parameters:

cal - calendar for object creation

Returns:

The data value as a java.sql.Time.

Throws:

StandardException - thrown on failure

newTime

private java.sql.Time newTime(java.util.Calendar cal)
                       throws StandardException

Throws:

StandardException

getObject

public java.lang.Object getObject()

Description copied from interface: DataValueDescriptor

Gets the value in the data value descriptor as a Java Object. The type of the Object will be the Java object type corresponding to the data value's SQL type. JDBC defines a mapping between Java object types and SQL types - we will allow that to be extended through user type definitions. Throws an exception if the data value is not an object (yeah, right).

Specified by:

getObject in interface DataValueDescriptor

Overrides:

getObject in class DataType

Returns:

The data value as a int.

getLength

public int getLength()

Description copied from interface: DataValueDescriptor

Gets the length of the data value. The meaning of this is implementation-dependent. For string types, it is the number of characters in the string. For numeric types, it is the number of bytes used to store the number. This is the actual length of this value, not the length of the type it was defined as. For example, a VARCHAR value may be shorter than the declared VARCHAR (maximum) length.

Specified by:

getLength in interface DataValueDescriptor

Returns:

The length of the data value

getTypeName

public java.lang.String getTypeName()

Description copied from interface: DataValueDescriptor

Get the SQL name of the datatype

Specified by:

getTypeName in interface DataValueDescriptor

Returns:

The SQL name of the datatype

getTypeFormatId

public int getTypeFormatId()

Return my format identifier.

Specified by:

getTypeFormatId in interface TypedFormat

Returns:

The identifier. (A UUID stuffed in an array of 16 bytes).

See Also:

TypedFormat.getTypeFormatId()

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException - error writing data

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException - Thrown on error reading the object

See Also:

Externalizable.readExternal(java.io.ObjectInput)

readExternalFromArray

public void readExternalFromArray(ArrayInputStream in)
                           throws java.io.IOException

Description copied from interface: DataValueDescriptor

Read the DataValueDescriptor from the stream.

Initialize the data value by reading it's values from the ArrayInputStream. This interface is provided as a way to achieve possible performance enhancement when reading an array can be optimized over reading from a generic stream from readExternal().

Specified by:

readExternalFromArray in interface DataValueDescriptor

Parameters:

in - The array stream positioned at the beginning of the byte stream to read from.

Throws:

java.io.IOException - Usual error is if you try to read past limit on the stream.

getClone

public DataValueDescriptor getClone()

Description copied from interface: DataValueDescriptor

Clone this DataValueDescriptor. Results in a new object that has the same value as this but can be modified independently.

Specified by:

getClone in interface DataValueDescriptor

Returns:

A clone of the DataValueDescriptor with the same initial value as this.

See Also:

DataValueDescriptor.getClone()

getNewNull

public DataValueDescriptor getNewNull()

Description copied from interface: DataValueDescriptor

Get a new null value of the same type as this data value.

Specified by:

getNewNull in interface DataValueDescriptor

See Also:

DataValueDescriptor.getNewNull()

restoreToNull

public void restoreToNull()

Description copied from interface: Storable

Restore this object to its (SQL)null value.

Specified by:

restoreToNull in interface Storable

See Also:

Storable.restoreToNull()

setValueFromResultSet

public void setValueFromResultSet(java.sql.ResultSet resultSet,
                                  int colNumber,
                                  boolean isNullable)
                           throws java.sql.SQLException,
                                  StandardException

Description copied from interface: DataValueDescriptor

Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet.

Specified by:

setValueFromResultSet in interface DataValueDescriptor

Parameters:

resultSet - The specified ResultSet.

colNumber - The 1-based column # into the resultSet.

isNullable - Whether or not the column is nullable (No need to call wasNull() if not)

Returns:

Nothing.

Throws:

java.sql.SQLException - Thrown on error

StandardException - Thrown on error

See Also:

DataValueDescriptor.setValueFromResultSet(java.sql.ResultSet, int, boolean)

compare

public int compare(DataValueDescriptor other)
            throws StandardException

Description copied from interface: DataValueDescriptor

Compare this Orderable with a given Orderable for the purpose of index positioning. This method treats nulls as ordered values - that is, it treats SQL null as equal to null and less than all other values.

Specified by:

compare in interface DataValueDescriptor

Parameters:

other - The Orderable to compare this one to.

Returns:

<0 - this Orderable is less than other. 0 - this Orderable equals other. >0 - this Orderable is greater than other. The code should not explicitly look for -1, or 1.

Throws:

StandardException - Thrown on error

compare

public boolean compare(int op,
                       DataValueDescriptor other,
                       boolean orderedNulls,
                       boolean unknownRV)
                throws StandardException

Description copied from interface: DataValueDescriptor

Compare this Orderable with a given Orderable for the purpose of qualification and sorting. The caller gets to determine how nulls should be treated - they can either be ordered values or unknown values.

Specified by:

compare in interface DataValueDescriptor

Overrides:

compare in class DataType

Throws:

StandardException - thrown on error

parseTimestamp

private void parseTimestamp(java.lang.String timestampStr,
                            boolean isJDBCEscape,
                            LocaleFinder localeFinder,
                            java.util.Calendar cal)
                     throws StandardException

Throws:

StandardException

parseLocalTimestamp

static int[] parseLocalTimestamp(java.lang.String str,
                                 LocaleFinder localeFinder,
                                 java.util.Calendar cal)
                          throws StandardException,
                                 java.text.ParseException

Parse a localized timestamp.

Parameters:

str - the timestamp string, with trailing blanks removed.

Returns:

a {encodedDate, encodedTime} array.

Throws:

java.text.ParseException - If the string is not a valid timestamp.

StandardException

parseDateOrTimestamp

static int[] parseDateOrTimestamp(DateTimeParser parser,
                                  boolean timeRequired)
                           throws StandardException

Parse a timestamp or a date. DB2 allows timestamps to be used as dates or times. So date('2004-04-15-16.15.32') is valid, as is date('2004-04-15'). This method does not handle localized timestamps.

Parameters:

parser - a DateTimeParser initialized with a string.

timeRequired - If true then an error will be thrown if the time is missing. If false then the time may be omitted.

Returns:

{encodedDate, encodedTime, nanosecond} array.

Throws:

StandardException - if the syntax is incorrect for an IBM standard timestamp.

setValue

public void setValue(java.lang.Object theValue)
              throws StandardException

Description copied from interface: DataValueDescriptor

Set the value of this DataValueDescriptor to the given value

Specified by:

setValue in interface DataValueDescriptor

Overrides:

setValue in class DataType

Throws:

StandardException

See Also:

DataValueDescriptor.setValue(java.lang.Object)

setFrom

protected void setFrom(DataValueDescriptor theValue)
                throws StandardException

Overrides:

setFrom in class DataType

Throws:

StandardException

setValue

public void setValue(java.sql.Date value,
                     java.util.Calendar cal)
              throws StandardException

Description copied from interface: DataValueDescriptor

Set the value of this DataValueDescriptor.

Specified by:

setValue in interface DataValueDescriptor

Overrides:

setValue in class DataType

Parameters:

value - The Date value to set this DataValueDescriptor to

cal - The time zone from the calendar is used to construct the database date value

Returns:

This DataValueDescriptor

Throws:

StandardException

See Also:

When converting from a date to a timestamp, time is set to 00:00:00.0

setValue

public void setValue(java.sql.Time value,
                     java.util.Calendar cal)
              throws StandardException

Description copied from interface: DataValueDescriptor

Set the value of this DataValueDescriptor.

Specified by:

setValue in interface DataValueDescriptor

Overrides:

setValue in class DataType

Parameters:

value - The Time value to set this DataValueDescriptor to

cal - The time zone from the calendar is used to construct the database time value

Returns:

This DataValueDescriptor

Throws:

StandardException

See Also:

DataValueDescriptor.setValue(java.lang.Object)

setValue

public void setValue(java.sql.Timestamp value,
                     java.util.Calendar cal)
              throws StandardException

Description copied from interface: DataValueDescriptor

Set the value of this DataValueDescriptor.

Specified by:

setValue in interface DataValueDescriptor

Overrides:

setValue in class DataType

Parameters:

value - The Timestamp value to set this DataValueDescriptor to

cal - The time zone from the calendar is used to construct the database timestamp value

Returns:

This DataValueDescriptor

Throws:

StandardException

See Also:

DataValueDescriptor.setValue(java.lang.Object)

setValue

public void setValue(java.lang.String theValue)
              throws StandardException

Description copied from interface: DataValueDescriptor

Set the value of this DataValueDescriptor.

Specified by:

setValue in interface DataValueDescriptor

Overrides:

setValue in class DataType

Parameters:

theValue - The BigDecimal value to set this DataValueDescriptor to

Returns:

This DataValueDescriptor

Throws:

StandardException

getYear

public NumberDataValue getYear(NumberDataValue result)
                        throws StandardException

Description copied from interface: DateTimeDataValue

Get the year number out of a date.

Specified by:

getYear in interface DateTimeDataValue

Parameters:

result - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the year number.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getYear(org.apache.derby.iapi.types.NumberDataValue)

getMonth

public NumberDataValue getMonth(NumberDataValue result)
                         throws StandardException

Description copied from interface: DateTimeDataValue

Get the month number out of a date.

Specified by:

getMonth in interface DateTimeDataValue

Parameters:

result - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the month number.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getMonth(org.apache.derby.iapi.types.NumberDataValue)

getDate

public NumberDataValue getDate(NumberDataValue result)
                        throws StandardException

Description copied from interface: DateTimeDataValue

Get the day of the month.

Specified by:

getDate in interface DateTimeDataValue

Parameters:

result - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the day of the month.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getDate(org.apache.derby.iapi.types.NumberDataValue)

getHours

public NumberDataValue getHours(NumberDataValue result)
                         throws StandardException

Description copied from interface: DateTimeDataValue

Get the hour of the day out of a time or timestamp.

Specified by:

getHours in interface DateTimeDataValue

Parameters:

result - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the hour of the day.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getHours(org.apache.derby.iapi.types.NumberDataValue)

getMinutes

public NumberDataValue getMinutes(NumberDataValue result)
                           throws StandardException

Description copied from interface: DateTimeDataValue

Get the minute of the hour out of a time or timestamp.

Specified by:

getMinutes in interface DateTimeDataValue

Parameters:

result - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the minute of the hour.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getMinutes(org.apache.derby.iapi.types.NumberDataValue)

getSeconds

public NumberDataValue getSeconds(NumberDataValue source)
                           throws StandardException

Description copied from interface: DateTimeDataValue

Get the second of the minute out of a time or timestamp.

Specified by:

getSeconds in interface DateTimeDataValue

Parameters:

source - The result of the previous call to this method, null if not called yet.

Returns:

A NumberDataValue containing the second of the minute.

Throws:

StandardException - Thrown on error

See Also:

DateTimeDataValue.getSeconds(org.apache.derby.iapi.types.NumberDataValue)

toString

public java.lang.String toString()

hashCode

public int hashCode()

typePrecedence

public int typePrecedence()

Description copied from interface: DataValueDescriptor

Each built-in type in JSQL has a precedence. This precedence determines how to do type promotion when using binary operators. For example, float has a higher precedence than int, so when adding an int to a float, the result type is float. The precedence for some types is arbitrary. For example, it doesn't matter what the precedence of the boolean type is, since it can't be mixed with other types. But the precedence for the number types is critical. The SQL standard requires that exact numeric types be promoted to approximate numeric when one operator uses both. Also, the precedence is arranged so that one will not lose precision when promoting a type.

Specified by:

typePrecedence in interface DataValueDescriptor

Overrides:

typePrecedence in class DataType

Returns:

The precedence of this type.

See Also:

DataValueDescriptor.typePrecedence()

isNull

public final boolean isNull()

Check if the value is null. encodedDate value of 0 is null

Specified by:

isNull in interface Storable

Returns:

Whether or not value is logically null.

getTimestamp

public java.sql.Timestamp getTimestamp(java.util.Calendar cal)

Get the value field. We instantiate the field on demand.

Specified by:

getTimestamp in interface DataValueDescriptor

Overrides:

getTimestamp in class DataType

Parameters:

cal - calendar for object creation

Returns:

The value field.

newTimestamp

protected java.sql.Timestamp newTimestamp(java.util.Calendar currentCal)

setCalendar

private void setCalendar(java.util.Calendar cal)

setNumericTimestamp

private void setNumericTimestamp(java.sql.Timestamp value,
                                 java.util.Calendar cal)
                          throws StandardException

Set the encoded values for the timestamp

Throws:

StandardException

getNationalString

protected java.lang.String getNationalString(LocaleFinder localeFinder)
                                      throws StandardException

International version of getString(). Overrides getNationalString in DataType for date, time, and timestamp.

Overrides:

getNationalString in class DataType

Throws:

StandardException - Thrown on error

computeEncodedDate

private static int computeEncodedDate(java.util.Date value,
                                      java.util.Calendar currentCal)
                               throws StandardException

computeEncodedDate sets the date in a Calendar object and then uses the SQLDate function to compute an encoded date The encoded date is year << 16 + month << 8 + date

Parameters:

value - the value to convert

Returns:

the encodedDate

Throws:

StandardException

computeEncodedTime

private static int computeEncodedTime(java.util.Date value,
                                      java.util.Calendar currentCal)
                               throws StandardException

computeEncodedTime extracts the hour, minute and seconds from a java.util.Date value and encodes them as hour << 16 + minute << 8 + second using the SQLTime function for encoding the data

Parameters:

value - the value to convert

Returns:

the encodedTime

Throws:

StandardException

setInto

public void setInto(java.sql.PreparedStatement ps,
                    int position)
             throws java.sql.SQLException,
                    StandardException

Description copied from interface: DataValueDescriptor

Set this value into a PreparedStatement. This method must handle setting NULL into the PreparedStatement.

Specified by:

setInto in interface DataValueDescriptor

Overrides:

setInto in class DataType

Throws:

java.sql.SQLException

StandardException

computeTimestampFunction

public static DateTimeDataValue computeTimestampFunction(DataValueDescriptor operand,
                                                         DataValueFactory dvf)
                                                  throws StandardException

Compute the SQL timestamp function.

Throws:

StandardException

parseDateTimeInteger

static int parseDateTimeInteger(java.lang.String str,
                                int start,
                                int ndigits)
                         throws StandardException

Throws:

StandardException

timestampAdd

public DateTimeDataValue timestampAdd(int intervalType,
                                      NumberDataValue count,
                                      java.sql.Date currentDate,
                                      DateTimeDataValue resultHolder)
                               throws StandardException

Add a number of intervals to a datetime value. Implements the JDBC escape TIMESTAMPADD function.

Specified by:

timestampAdd in interface DateTimeDataValue

Parameters:

intervalType - One of FRAC_SECOND_INTERVAL, SECOND_INTERVAL, MINUTE_INTERVAL, HOUR_INTERVAL, DAY_INTERVAL, WEEK_INTERVAL, MONTH_INTERVAL, QUARTER_INTERVAL, or YEAR_INTERVAL

currentDate - Used to convert time to timestamp

resultHolder - If non-null a DateTimeDataValue that can be used to hold the result. If null then generate a new holder

count - The number of intervals to add

Returns:

startTime + intervalCount intervals, as a timestamp

Throws:

StandardException

addInternal

private void addInternal(int calIntervalType,
                         int count,
                         SQLTimestamp tsResult)
                  throws StandardException

Throws:

StandardException

timestampDiff

public NumberDataValue timestampDiff(int intervalType,
                                     DateTimeDataValue time1,
                                     java.sql.Date currentDate,
                                     NumberDataValue resultHolder)
                              throws StandardException

Finds the difference between two datetime values as a number of intervals. Implements the JDBC TIMESTAMPDIFF escape function.

Specified by:

timestampDiff in interface DateTimeDataValue

Parameters:

intervalType - One of FRAC_SECOND_INTERVAL, SECOND_INTERVAL, MINUTE_INTERVAL, HOUR_INTERVAL, DAY_INTERVAL, WEEK_INTERVAL, MONTH_INTERVAL, QUARTER_INTERVAL, or YEAR_INTERVAL

time1 -

currentDate - Used to convert time to timestamp

resultHolder - If non-null a NumberDataValue that can be used to hold the result. If null then generate a new holder

Returns:

the number of intervals by which this datetime is greater than time1

Throws:

StandardException

promote

static SQLTimestamp promote(DateTimeDataValue dateTime,
                            java.sql.Date currentDate)
                     throws StandardException

Promotes a DateTimeDataValue to a timestamp.

Returns:

the corresponding timestamp, using the current date if datetime is a time, or time 00:00:00 if datetime is a date.

Throws:

StandardException