SQLDate (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.iapi.types.DataType
- - org.apache.derby.iapi.types.SQLDate

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Comparable, Formatable, Storable, TypedFormat, DataValueDescriptor, DateTimeDataValue, Orderable
```
public final class SQLDate
extends DataType
implements DateTimeDataValue
```
This contains an instance of a SQL Date.
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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`BASE_MEMORY_USAGE`
`private int`	`encodedDate`
`private static char[]`	`END_OF_STRING`
`private static char`	`IBM_EUR_SEPARATOR`
`private static char[]`	`IBM_EUR_SEPARATOR_ONLY`
`private static char`	`IBM_USA_SEPARATOR`
`private static char[]`	`IBM_USA_SEPARATOR_ONLY`
`(package private) static char`	`ISO_SEPARATOR`
`private static char[]`	`ISO_SEPARATOR_ONLY`

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

Constructors
Modifier	Constructor	Description
	`SQLDate()`	no-arg constructor required by Formattable
`private`	`SQLDate(int encodedDate)`
	`SQLDate(java.lang.String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder)`	Construct a date from a string.
	`SQLDate(java.lang.String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, java.util.Calendar cal)`	Construct a date from a string.
	`SQLDate(java.sql.Date value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DataValueDescriptor`	`cloneValue(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 interface
`static 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(java.util.Calendar cal)`	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
`private static int`	`computeEncodedDate(java.util.Date value)`	Compute the encoded date given a date
`(package private) static int`	`computeEncodedDate(java.util.Date value, java.util.Calendar currentCal)`
`(package private) static void`	`dateToString(int year, int month, int day, java.lang.StringBuffer sb)`	Convert a date to the JDBC representation and append it to a string buffer.
`(package private) static java.lang.String`	`encodedDateToString(int encodedDate)`	Get the String version from the encodedDate.
`int`	`estimateMemoryUsage()`	Estimate the memory usage in bytes of the data value and the overhead of the class.
`java.sql.Date`	`getDate(java.util.Calendar cal)`	Get the value field.
`NumberDataValue`	`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`	`getEncodedDate()`
`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.
`(package private) static int`	`getMonth(int encodedDate)`	Get the month from the encodedDate, January is one.
`NumberDataValue`	`getMonth(NumberDataValue result)`	Get the month number out of a date.
`DataValueDescriptor`	`getNewNull()`	Get a new null value of the same type as this data value.
`java.lang.Object`	`getObject()`	getObject returns the date value
`NumberDataValue`	`getSeconds(NumberDataValue result)`	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.
`private long`	`getTimeInMillis(java.util.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.
`java.sql.Timestamp`	`getTimestamp(java.util.Calendar cal)`	getTimestamp returns a timestamp with the date value time is set to 00:00:00.0
`int`	`getTypeFormatId()`	Return my format identifier.
`java.lang.String`	`getTypeName()`	Get the SQL name of the datatype
`(package private) static int`	`getYear(int encodedDate)`	Get the year from the encodedDate.
`NumberDataValue`	`getYear(NumberDataValue result)`	Get the year number out of a date.
`int`	`hashCode()`
`boolean`	`isNull()`	Check if the value is null.
`(package private) NumberDataValue`	`nullValueInt()`
`private void`	`parseDate(java.lang.String dateStr, boolean isJdbcEscape, LocaleFinder localeFinder, java.util.Calendar cal)`
`private void`	`parseDate(java.util.Date value)`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`restoreToNull()`	Restore this object to its (SQL)null value.
`(package private) static void`	`setDateInCalendar(java.util.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(java.sql.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`	`setObject(java.lang.Object theValue)`	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`	`setValue(java.lang.String theValue)`	Set the value of this DataValueDescriptor.
`void`	`setValue(java.sql.Date 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 intervalCount, 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()`
`private SQLTimestamp`	`toTimestamp()`
`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, 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 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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - encodedDate
```
private int encodedDate
```
  - BASE_MEMORY_USAGE
```
private static final int BASE_MEMORY_USAGE
```
  - ISO_SEPARATOR
```
static final char ISO_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - ISO_SEPARATOR_ONLY
```
private static final char[] ISO_SEPARATOR_ONLY
```
  - IBM_USA_SEPARATOR
```
private static final char IBM_USA_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - IBM_USA_SEPARATOR_ONLY
```
private static final char[] IBM_USA_SEPARATOR_ONLY
```
  - IBM_EUR_SEPARATOR
```
private static final char IBM_EUR_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - IBM_EUR_SEPARATOR_ONLY
```
private static final char[] IBM_EUR_SEPARATOR_ONLY
```
  - END_OF_STRING
```
private static final char[] END_OF_STRING
```
- Constructor Detail
  - SQLDate
```
public SQLDate()
```
    no-arg constructor required by Formattable
  - SQLDate
```
public SQLDate(java.sql.Date value)
        throws StandardException
```
    Throws:
    
    StandardException
  - SQLDate
```
private SQLDate(int encodedDate)
```
  - SQLDate
```
public SQLDate(java.lang.String dateStr,
               boolean isJdbcEscape,
               LocaleFinder localeFinder)
        throws StandardException
```
    Construct a date from a string. The allowed date formats are:
    1. ISO: yyyy-mm-dd
    2. IBM USA standard: mm/dd/yyyy
    3. IBM European standard: dd.mm.yyyy
    Trailing blanks may be included; leading zeros may be omitted from the month and day portions.
    Parameters:
    
    dateStr -
    
    isJdbcEscape - if true then only the JDBC date escape syntax is allowed
    
    localeFinder -
    
    Throws:
    
    StandardException - if the syntax is invalid or the value is out of range
  - SQLDate
```
public SQLDate(java.lang.String dateStr,
               boolean isJdbcEscape,
               LocaleFinder localeFinder,
               java.util.Calendar cal)
        throws StandardException
```
    Construct a date from a string. The allowed date formats are:
    1. ISO: yyyy-mm-dd
    2. IBM USA standard: mm/dd/yyyy
    3. IBM European standard: dd.mm.yyyy
    Trailing blanks may be included; leading zeros may be omitted from the month and day portions.
    Parameters:
    
    dateStr -
    
    isJdbcEscape - if true then only the JDBC date escape syntax is allowed
    
    localeFinder -
    
    Throws:
    
    StandardException - if the syntax is invalid or the value is out of range
- 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
  - getEncodedDate
```
int getEncodedDate()
```
  - 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.
  - getTimestamp
```
public java.sql.Timestamp getTimestamp(java.util.Calendar cal)
```
    getTimestamp returns a timestamp with the date value time is set to 00:00:00.0
    
    Specified by:
    
    getTimestamp in interface DataValueDescriptor
    
    Overrides:
    
    getTimestamp in class DataType
    
    Parameters:
    
    cal - calendar for object creation
    
    Returns:
    
    The data value as a java.sql.Timestamp.
  - getTimeInMillis
```
private long getTimeInMillis(java.util.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.
  - setDateInCalendar
```
static void setDateInCalendar(java.util.Calendar cal,
                              int encodedDate)
```
    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
```
public java.lang.Object getObject()
```
    getObject returns the date value
    
    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)
  - cloneValue
```
public DataValueDescriptor cloneValue(boolean forceMaterialization)
```
    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 if forceMaterialization is set to false. An example is if you need to access the value you just read using cloneValue after the current transaction has ended, or after the source result set has been closed.
    
    Specified by:
    
    cloneValue in interface DataValueDescriptor
    
    Parameters:
    
    forceMaterialization - any streams representing the data value will be materialized if true, the data value will be kept as a stream if possible if false
    
    Returns:
    
    A clone of the DataValueDescriptor with the same initial value as this.
    
    See Also:
    
    DataValueDescriptor.cloneValue(boolean)
  - 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)
    
    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
```
    Orderable interface
    
    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 failure
    
    See Also:
    
    Orderable
  - 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
    
    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
```
private void parseDate(java.util.Date value)
                throws StandardException
```
    Throws:
    
    StandardException
  - parseDate
```
private void parseDate(java.lang.String dateStr,
                       boolean isJdbcEscape,
                       LocaleFinder localeFinder,
                       java.util.Calendar cal)
                throws StandardException
```
    Throws:
    
    StandardException
  - setObject
```
void setObject(java.lang.Object theValue)
        throws StandardException
```
    Set the value from a correctly typed Date object.
    
    Overrides:
    
    setObject in class DataType
    
    Throws:
    
    StandardException
  - setFrom
```
protected void setFrom(DataValueDescriptor theValue)
                throws StandardException
```
    Description copied from class: DataType
    
    Set the value of this DataValueDescriptor based on the value of the specified DataValueDescriptor.
    
    Overrides:
    
    setFrom in class DataType
    
    Parameters:
    
    theValue - The DataValueDescriptor that holds the value to which we want to set this DataValueDescriptor's value.
    
    Throws:
    
    StandardException
  - setValue
```
public void setValue(java.sql.Date value,
                     java.util.Calendar cal)
              throws StandardException
```
    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 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
    
    Throws:
    
    StandardException
    
    See Also:
    
    DataValueDescriptor.setValue(int)
  - setValue
```
public void setValue(java.sql.Timestamp value,
                     java.util.Calendar cal)
              throws StandardException
```
    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 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
    
    Throws:
    
    StandardException
    
    See Also:
    
    DataValueDescriptor.setValue(int)
  - setValue
```
public void setValue(java.lang.String theValue)
              throws StandardException
```
    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 interface DataValueDescriptor
    
    Overrides:
    
    setValue in class DataType
    
    Parameters:
    
    theValue - The BigDecimal value to set this DataValueDescriptor to
    
    Throws:
    
    StandardException
  - nullValueInt
```
NumberDataValue nullValueInt()
```
  - 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 result)
                           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:
    
    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:
    
    DateTimeDataValue.getSeconds(org.apache.derby.iapi.types.NumberDataValue)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - 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 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 is 0 if the value is null
    
    Specified by:
    
    isNull in interface Storable
    
    Returns:
    
    Whether or not value is logically null.
  - getDate
```
public java.sql.Date getDate(java.util.Calendar cal)
```
    Get the value field. We instantiate the field on demand.
    
    Specified by:
    
    getDate in interface DataValueDescriptor
    
    Overrides:
    
    getDate in class DataType
    
    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
```
static int computeEncodedDate(java.util.Calendar cal)
                       throws StandardException
```
    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
```
static int computeEncodedDate(int y,
                              int m,
                              int d)
                       throws StandardException
```
    Throws:
    
    StandardException
  - dateToString
```
static void dateToString(int year,
                         int month,
                         int day,
                         java.lang.StringBuffer sb)
```
    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
```
static java.lang.String encodedDateToString(int encodedDate)
```
    Get the String version from the encodedDate.
    
    Returns:
    
    string value.
  - setSource
```
static NumberDataValue setSource(int value,
                                 NumberDataValue source)
                          throws StandardException
```
    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
```
private static int computeEncodedDate(java.util.Date value)
                               throws StandardException
```
    Compute the encoded date given a date
    
    Throws:
    
    StandardException
  - computeEncodedDate
```
static int computeEncodedDate(java.util.Date value,
                              java.util.Calendar currentCal)
                       throws StandardException
```
    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
```
public void setInto(java.sql.PreparedStatement ps,
                    int position)
             throws java.sql.SQLException,
                    StandardException
```
    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 interface DataValueDescriptor
    
    Overrides:
    
    setInto in class DataType
    
    Throws:
    
    java.sql.SQLException - thrown by the PreparedStatement object
    
    StandardException - thrown by me accessing my value.
  - timestampAdd
```
public DateTimeDataValue timestampAdd(int intervalType,
                                      NumberDataValue intervalCount,
                                      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
    
    intervalCount - The number of intervals to add
    
    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
    
    Returns:
    
    startTime + intervalCount intervals, as a timestamp
    
    Throws:
    
    StandardException
  - toTimestamp
```
private SQLTimestamp toTimestamp()
                          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

Class SQLDate

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

encodedDate

BASE_MEMORY_USAGE

ISO_SEPARATOR

ISO_SEPARATOR_ONLY

IBM_USA_SEPARATOR

IBM_USA_SEPARATOR_ONLY

IBM_EUR_SEPARATOR

IBM_EUR_SEPARATOR_ONLY

END_OF_STRING

Constructor Detail

SQLDate

SQLDate

SQLDate

SQLDate

SQLDate

Method Detail

estimateMemoryUsage

getEncodedDate

getString

getTimestamp

getTimeInMillis

setDateInCalendar

getObject

getLength

getTypeName

getTypeFormatId

writeExternal

readExternal

cloneValue

getNewNull

restoreToNull

setValueFromResultSet

compare

compare

parseDate

parseDate

setObject

setFrom

setValue

setValue

setValue

nullValueInt

getYear

getMonth

getDate

getHours

getMinutes

getSeconds

toString

hashCode

typePrecedence

isNull

getDate

getYear

getMonth

getDay

computeEncodedDate

computeEncodedDate

dateToString

encodedDateToString

setSource

computeEncodedDate

computeEncodedDate

computeDateFunction

setInto

timestampAdd

toTimestamp

timestampDiff