Class SQLDate
- All Implemented Interfaces:
Externalizable
,Serializable
,Comparable
,Formatable
,Storable
,TypedFormat
,DataValueDescriptor
,DateTimeDataValue
,Orderable
The date is stored as int (year << 16 + month << 8 + day) Null is represented by an encodedDate value of 0. Some of the static methods in this class are also used by SQLTime and SQLTimestamp so check those classes if you change the date encoding PERFORMANCE OPTIMIZATION: The java.sql.Date object is only instantiated when needed do to the overhead of Date.valueOf(), etc. methods.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private int
private static final char[]
private static final char
private static final char[]
private static final char
private static final char[]
(package private) static final char
private static final char[]
Fields inherited from interface org.apache.derby.iapi.types.DataValueDescriptor
UNKNOWN_LOGICAL_LENGTH
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
ConstructorsModifierConstructorDescriptionSQLDate()
no-arg constructor required by Formattableprivate
SQLDate
(int encodedDate) SQLDate
(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder) Construct a date from a string.SQLDate
(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, Calendar cal) Construct a date from a string. -
Method Summary
Modifier and TypeMethodDescriptioncloneValue
(boolean forceMaterialization) Clone this DataValueDescriptor.boolean
compare
(int op, DataValueDescriptor other, boolean orderedNulls, boolean unknownRV) Compare this Orderable with a given Orderable for the purpose of qualification and sorting.int
compare
(DataValueDescriptor other) Orderable interfacestatic DateTimeDataValue
computeDateFunction
(DataValueDescriptor operand, DataValueFactory dvf) Implement the date SQL function: construct a SQL date from a string, number, or timestamp.(package private) static int
computeEncodedDate
(int y, int m, int d) (package private) static int
computeEncodedDate extracts the year, month and date from a Calendar value and encodes them as year << 16 + month << 8 + date Use this function will help to remember to add 1 to month which is 0 based in the Calendar classprivate static int
computeEncodedDate
(Date value) Compute the encoded date given a date(package private) static int
computeEncodedDate
(Date value, Calendar currentCal) (package private) static void
dateToString
(int year, int month, int day, StringBuffer sb) Convert a date to the JDBC representation and append it to a string buffer.(package private) static String
encodedDateToString
(int encodedDate) Get the String version from the encodedDate.int
Estimate the memory usage in bytes of the data value and the overhead of the class.Get the value field.getDate
(NumberDataValue result) Get the day of the month.(package private) static int
getDay
(int encodedDate) Get the day from the encodedDate.(package private) int
getHours
(NumberDataValue result) Get the hour of the day out of a time or timestamp.int
Gets the length of the data value.getMinutes
(NumberDataValue result) Get the minute of the hour out of a time or timestamp.(package private) static int
getMonth
(int encodedDate) Get the month from the encodedDate, January is one.getMonth
(NumberDataValue result) Get the month number out of a date.Get a new null value of the same type as this data value.getObject returns the date valuegetSeconds
(NumberDataValue result) Get the second of the minute out of a time or timestamp.Gets the value in the data value descriptor as a String.private long
getTimeInMillis
(Calendar cal) Convert the date into a milli-seconds since the epoch with the time set to 00:00 based upon the passed in Calendar.getTimestamp
(Calendar cal) getTimestamp returns a timestamp with the date value time is set to 00:00:00.0int
Return my format identifier.Get the SQL name of the datatype(package private) static int
getYear
(int encodedDate) Get the year from the encodedDate.getYear
(NumberDataValue result) Get the year number out of a date.int
hashCode()
final boolean
isNull()
Check if the value is null.(package private) NumberDataValue
private void
parseDate
(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, Calendar cal) private void
void
void
Restore this object to its (SQL)null value.(package private) static void
setDateInCalendar
(Calendar cal, int encodedDate) Set the date portion of a date-time value into the passed in Calendar object from its encodedDate value.protected void
setFrom
(DataValueDescriptor theValue) Set the value of this DataValueDescriptor based on the value of the specified DataValueDescriptor.void
setInto
(PreparedStatement ps, int position) Adding this method to ensure that super class' setInto method doesn't get called that leads to the violation of JDBC spec( untyped nulls ) when batching is turned on.(package private) void
Set the value from a correctly typed Date object.(package private) static NumberDataValue
setSource
(int value, NumberDataValue source) This helper routine tests the nullability of various parameters and sets up the result appropriately.void
Set the value of this DataValueDescriptor.void
Set the value of this DataValueDescriptor.void
Set the value of this DataValueDescriptor.void
setValueFromResultSet
(ResultSet resultSet, int colNumber, boolean isNullable) Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet.timestampAdd
(int intervalType, NumberDataValue intervalCount, Date currentDate, DateTimeDataValue resultHolder) Add a number of intervals to a datetime value.timestampDiff
(int intervalType, DateTimeDataValue time1, Date currentDate, NumberDataValue resultHolder) Finds the difference between two datetime values as a number of intervals.toString()
private SQLTimestamp
int
Each built-in type in JSQL has a precedence.void
Methods inherited from class org.apache.derby.iapi.types.DataType
checkHostVariable, cloneHolder, coalesce, compare, compare, compareTo, dataTypeConversion, equals, equals, flip, genericSetObject, getBoolean, getByte, getBytes, getDouble, getFloat, getInt, getLong, getShort, getStream, getTime, getTraceString, getTypeName, greaterOrEquals, greaterThan, hasStream, in, invalidFormat, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, outOfRange, readExternalFromArray, recycle, setBigDecimal, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, 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, cloneHolder, coalesce, compare, compare, equals, getBoolean, getByte, getBytes, getDouble, getFloat, getInt, getLong, getShort, getStream, getTime, getTraceString, greaterOrEquals, greaterThan, hasStream, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, readExternalFromArray, recycle, setBigDecimal, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, typeToBigDecimal
-
Field Details
-
encodedDate
private int encodedDate -
BASE_MEMORY_USAGE
private static final int BASE_MEMORY_USAGE -
ISO_SEPARATOR
static final char ISO_SEPARATOR- See Also:
-
ISO_SEPARATOR_ONLY
private static final char[] ISO_SEPARATOR_ONLY -
IBM_USA_SEPARATOR
private static final char IBM_USA_SEPARATOR- See Also:
-
IBM_USA_SEPARATOR_ONLY
private static final char[] IBM_USA_SEPARATOR_ONLY -
IBM_EUR_SEPARATOR
private static final char IBM_EUR_SEPARATOR- See Also:
-
IBM_EUR_SEPARATOR_ONLY
private static final char[] IBM_EUR_SEPARATOR_ONLY -
END_OF_STRING
private static final char[] END_OF_STRING
-
-
Constructor Details
-
SQLDate
public SQLDate()no-arg constructor required by Formattable -
SQLDate
- Throws:
StandardException
-
SQLDate
private SQLDate(int encodedDate) -
SQLDate
public SQLDate(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder) throws StandardException Construct a date from a string. The allowed date formats are:- ISO: yyyy-mm-dd
- IBM USA standard: mm/dd/yyyy
- IBM European standard: dd.mm.yyyy
- Parameters:
dateStr
-isJdbcEscape
- if true then only the JDBC date escape syntax is allowedlocaleFinder
-- Throws:
StandardException
- if the syntax is invalid or the value is out of range
-
SQLDate
public SQLDate(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, Calendar cal) throws StandardException Construct a date from a string. The allowed date formats are:- ISO: yyyy-mm-dd
- IBM USA standard: mm/dd/yyyy
- IBM European standard: dd.mm.yyyy
- Parameters:
dateStr
-isJdbcEscape
- if true then only the JDBC date escape syntax is allowedlocaleFinder
-- Throws:
StandardException
- if the syntax is invalid or the value is out of range
-
-
Method Details
-
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 interfaceDataValueDescriptor
- Returns:
- the estimated memory usage
-
getEncodedDate
int getEncodedDate() -
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 interfaceDataValueDescriptor
- Returns:
- The data value as a String.
-
getTimestamp
getTimestamp returns a timestamp with the date value time is set to 00:00:00.0- Specified by:
getTimestamp
in interfaceDataValueDescriptor
- Overrides:
getTimestamp
in classDataType
- Parameters:
cal
- calendar for object creation- Returns:
- The data value as a java.sql.Timestamp.
-
getTimeInMillis
Convert the date into a milli-seconds since the epoch with the time set to 00:00 based upon the passed in Calendar. -
setDateInCalendar
Set the date portion of a date-time value into the passed in Calendar object from its encodedDate value. Only the YEAR, MONTH and DAY_OF_MONTH fields are modified. The remaining state of the Calendar is not modified. -
getObject
getObject returns the date value- Specified by:
getObject
in interfaceDataValueDescriptor
- Overrides:
getObject
in classDataType
- 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 interfaceDataValueDescriptor
- Returns:
- The length of the data value
-
getTypeName
Description copied from interface:DataValueDescriptor
Get the SQL name of the datatype- Specified by:
getTypeName
in interfaceDataValueDescriptor
- Returns:
- The SQL name of the datatype
-
getTypeFormatId
public int getTypeFormatId()Return my format identifier.- Specified by:
getTypeFormatId
in interfaceTypedFormat
- Returns:
- The identifier. (A UUID stuffed in an array of 16 bytes).
- See Also:
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
- error writing data
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
- Thrown on error reading the object- See Also:
-
cloneValue
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.Even though the objects can be modified independently regardless of the value of
forceMaterialization
, both the clone and the original may be dependent on the store state ifforceMaterialization
is set tofalse
. An example is if you need to access the value you just read usingcloneValue
after the current transaction has ended, or after the source result set has been closed.- Specified by:
cloneValue
in interfaceDataValueDescriptor
- Parameters:
forceMaterialization
- any streams representing the data value will be materialized iftrue
, the data value will be kept as a stream if possible iffalse
- Returns:
- A clone of the
DataValueDescriptor
with the same initial value as this. - See Also:
-
getNewNull
Description copied from interface:DataValueDescriptor
Get a new null value of the same type as this data value.- Specified by:
getNewNull
in interfaceDataValueDescriptor
- See Also:
-
restoreToNull
public void restoreToNull()Description copied from interface:Storable
Restore this object to its (SQL)null value.- Specified by:
restoreToNull
in interfaceStorable
- See Also:
-
setValueFromResultSet
public void setValueFromResultSet(ResultSet resultSet, int colNumber, boolean isNullable) throws 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 interfaceDataValueDescriptor
- 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)- Throws:
SQLException
- Thrown on errorStandardException
- Thrown on error- See Also:
-
compare
Orderable interface- Specified by:
compare
in interfaceDataValueDescriptor
- 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 failure- See Also:
-
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 interfaceDataValueDescriptor
- Overrides:
compare
in classDataType
- Parameters:
op
- Orderable.ORDER_OP_EQUALS means do an = comparison. Orderable.ORDER_OP_LESSTHAN means compare this < other. Orderable.ORDER_OP_LESSOREQUALS means compare this <= other.other
- The DataValueDescriptor to compare this one to.orderedNulls
- True means to treat nulls as ordered values, that is, treat SQL null as equal to null, and less than all other values. False means to treat nulls as unknown values, that is, the result of any comparison with a null is the UNKNOWN truth value.unknownRV
- The return value to use if the result of the comparison is the UNKNOWN truth value. In other words, if orderedNulls is false, and a null is involved in the comparison, return unknownRV. This parameter is not used orderedNulls is true.- Returns:
- true if the comparison is true (duh!)
- Throws:
StandardException
- thrown on error
-
parseDate
- Throws:
StandardException
-
parseDate
private void parseDate(String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, Calendar cal) throws StandardException - Throws:
StandardException
-
setObject
Set the value from a correctly typed Date object.- Overrides:
setObject
in classDataType
- Throws:
StandardException
-
setFrom
Description copied from class:DataType
Set the value of this DataValueDescriptor based on the value of the specified DataValueDescriptor.- Overrides:
setFrom
in classDataType
- Parameters:
theValue
- The DataValueDescriptor that holds the value to which we want to set this DataValueDescriptor's value.- Throws:
StandardException
-
setValue
Description copied from class:DataType
Set the value of this DataValueDescriptor. At DataType level just throws an error lower classes will override- Specified by:
setValue
in interfaceDataValueDescriptor
- Overrides:
setValue
in classDataType
- Parameters:
value
- The Date value to set this DataValueDescriptor tocal
- The time zone from the calendar is used to construct the database date value- Throws:
StandardException
- See Also:
-
setValue
Description copied from class:DataType
Set the value of this DataValueDescriptor. At DataType level just throws an error lower classes will override- Specified by:
setValue
in interfaceDataValueDescriptor
- Overrides:
setValue
in classDataType
- Parameters:
value
- The Timestamp value to set this DataValueDescriptor tocal
- The time zone from the calendar is used to construct the database timestamp value- Throws:
StandardException
- See Also:
-
setValue
Description copied from class:DataType
Set the value of this DataValueDescriptor. At DataType level just throws an error lower classes will override- Specified by:
setValue
in interfaceDataValueDescriptor
- Overrides:
setValue
in classDataType
- Parameters:
theValue
- The BigDecimal value to set this DataValueDescriptor to- Throws:
StandardException
-
nullValueInt
NumberDataValue nullValueInt() -
getYear
Description copied from interface:DateTimeDataValue
Get the year number out of a date.- Specified by:
getYear
in interfaceDateTimeDataValue
- 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:
-
getMonth
Description copied from interface:DateTimeDataValue
Get the month number out of a date.- Specified by:
getMonth
in interfaceDateTimeDataValue
- 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:
-
getDate
Description copied from interface:DateTimeDataValue
Get the day of the month.- Specified by:
getDate
in interfaceDateTimeDataValue
- 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:
-
getHours
Description copied from interface:DateTimeDataValue
Get the hour of the day out of a time or timestamp.- Specified by:
getHours
in interfaceDateTimeDataValue
- 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:
-
getMinutes
Description copied from interface:DateTimeDataValue
Get the minute of the hour out of a time or timestamp.- Specified by:
getMinutes
in interfaceDateTimeDataValue
- 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:
-
getSeconds
Description copied from interface:DateTimeDataValue
Get the second of the minute out of a time or timestamp.- Specified by:
getSeconds
in interfaceDateTimeDataValue
- Parameters:
result
- 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:
-
toString
-
hashCode
public int hashCode() -
typePrecedence
public int typePrecedence()Description copied from class:DataType
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 interfaceDataValueDescriptor
- Overrides:
typePrecedence
in classDataType
- Returns:
- The precedence of this type.
- See Also:
-
isNull
public final boolean isNull()Check if the value is null. encodedDate is 0 if the value is null -
getDate
Get the value field. We instantiate the field on demand.- Specified by:
getDate
in interfaceDataValueDescriptor
- Overrides:
getDate
in classDataType
- Parameters:
cal
- calendar for object creation- Returns:
- The value field.
-
getYear
static int getYear(int encodedDate) Get the year from the encodedDate.- Parameters:
encodedDate
- the encoded date- Returns:
- year value.
-
getMonth
static int getMonth(int encodedDate) Get the month from the encodedDate, January is one.- Parameters:
encodedDate
- the encoded date- Returns:
- month value.
-
getDay
static int getDay(int encodedDate) Get the day from the encodedDate.- Parameters:
encodedDate
- the encoded date- Returns:
- day value.
-
computeEncodedDate
computeEncodedDate extracts the year, month and date from a Calendar value and encodes them as year << 16 + month << 8 + date Use this function will help to remember to add 1 to month which is 0 based in the Calendar class- Parameters:
cal
- the Calendar- Returns:
- the encodedDate
- Throws:
StandardException
- if the value is out of the DB2 date range
-
computeEncodedDate
- Throws:
StandardException
-
dateToString
Convert a date to the JDBC representation and append it to a string buffer.- Parameters:
year
-month
- 1 based (January == 1)day
-sb
- The string representation is appended to this StringBuffer
-
encodedDateToString
Get the String version from the encodedDate.- Returns:
- string value.
-
setSource
This helper routine tests the nullability of various parameters and sets up the result appropriately. If source is null, a new NumberDataValue is built.- Throws:
StandardException
- Thrown on error
-
computeEncodedDate
Compute the encoded date given a date- Throws:
StandardException
-
computeEncodedDate
- Throws:
StandardException
-
computeDateFunction
public static DateTimeDataValue computeDateFunction(DataValueDescriptor operand, DataValueFactory dvf) throws StandardException Implement the date SQL function: construct a SQL date from a string, number, or timestamp.- Parameters:
operand
- Must be a date or a string convertible to a date.dvf
- the DataValueFactory- Throws:
StandardException
- standard error policy
-
setInto
Adding this method to ensure that super class' setInto method doesn't get called that leads to the violation of JDBC spec( untyped nulls ) when batching is turned on.- Specified by:
setInto
in interfaceDataValueDescriptor
- Overrides:
setInto
in classDataType
- Throws:
SQLException
- thrown by the PreparedStatement objectStandardException
- thrown by me accessing my value.
-
timestampAdd
public DateTimeDataValue timestampAdd(int intervalType, NumberDataValue intervalCount, 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 interfaceDateTimeDataValue
- Parameters:
intervalType
- One of FRAC_SECOND_INTERVAL, SECOND_INTERVAL, MINUTE_INTERVAL, HOUR_INTERVAL, DAY_INTERVAL, WEEK_INTERVAL, MONTH_INTERVAL, QUARTER_INTERVAL, or YEAR_INTERVALintervalCount
- The number of intervals to addcurrentDate
- Used to convert time to timestampresultHolder
- If non-null a DateTimeDataValue that can be used to hold the result. If null then generate a new holder- Returns:
- startTime + intervalCount intervals, as a timestamp
- Throws:
StandardException
-
toTimestamp
- Throws:
StandardException
-
timestampDiff
public NumberDataValue timestampDiff(int intervalType, DateTimeDataValue time1, 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 interfaceDateTimeDataValue
- Parameters:
intervalType
- One of FRAC_SECOND_INTERVAL, SECOND_INTERVAL, MINUTE_INTERVAL, HOUR_INTERVAL, DAY_INTERVAL, WEEK_INTERVAL, MONTH_INTERVAL, QUARTER_INTERVAL, or YEAR_INTERVALtime1
-currentDate
- Used to convert time to timestampresultHolder
- 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
-