org.apache.derby.iapi.types
Interface DateTimeDataValue

All Superinterfaces:
DataValueDescriptor, java.io.Externalizable, Formatable, Orderable, java.io.Serializable, Storable, TypedFormat
All Known Implementing Classes:
SQLDate, SQLTime, SQLTimestamp

public interface DateTimeDataValue
extends DataValueDescriptor


Field Summary
static int DAY_FIELD
           
static int DAY_INTERVAL
           
static int FRAC_SECOND_INTERVAL
           
static int HOUR_FIELD
           
static int HOUR_INTERVAL
           
static int MINUTE_FIELD
           
static int MINUTE_INTERVAL
           
static int MONTH_FIELD
           
static int MONTH_INTERVAL
           
static int QUARTER_INTERVAL
           
static int SECOND_FIELD
           
static int SECOND_INTERVAL
           
static int WEEK_INTERVAL
           
static int YEAR_FIELD
           
static int YEAR_INTERVAL
           
 
Fields inherited from interface org.apache.derby.iapi.types.DataValueDescriptor
UNKNOWN_LOGICAL_LENGTH
 
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
 
Method Summary
 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.
 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.
 NumberDataValue getSeconds(NumberDataValue result)
          Get the second of the minute out of a time or timestamp.
 NumberDataValue getYear(NumberDataValue result)
          Get the year number out of a date.
 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.
 
Methods inherited from interface org.apache.derby.iapi.types.DataValueDescriptor
checkHostVariable, cloneHolder, cloneValue, coalesce, compare, compare, compare, compare, equals, estimateMemoryUsage, getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLength, getLong, getNewNull, getObject, getShort, getStream, getString, getTime, getTimestamp, getTraceString, getTypeName, greaterOrEquals, greaterThan, hasStream, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, readExternalFromArray, recycle, setBigDecimal, setInto, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromResultSet, typePrecedence, typeToBigDecimal
 
Methods inherited from interface org.apache.derby.iapi.services.io.Storable
isNull, restoreToNull
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 
Methods inherited from interface org.apache.derby.iapi.services.io.TypedFormat
getTypeFormatId
 

Field Detail

YEAR_FIELD

static final int YEAR_FIELD
See Also:
Constant Field Values

MONTH_FIELD

static final int MONTH_FIELD
See Also:
Constant Field Values

DAY_FIELD

static final int DAY_FIELD
See Also:
Constant Field Values

HOUR_FIELD

static final int HOUR_FIELD
See Also:
Constant Field Values

MINUTE_FIELD

static final int MINUTE_FIELD
See Also:
Constant Field Values

SECOND_FIELD

static final int SECOND_FIELD
See Also:
Constant Field Values

FRAC_SECOND_INTERVAL

static final int FRAC_SECOND_INTERVAL
See Also:
Constant Field Values

SECOND_INTERVAL

static final int SECOND_INTERVAL
See Also:
Constant Field Values

MINUTE_INTERVAL

static final int MINUTE_INTERVAL
See Also:
Constant Field Values

HOUR_INTERVAL

static final int HOUR_INTERVAL
See Also:
Constant Field Values

DAY_INTERVAL

static final int DAY_INTERVAL
See Also:
Constant Field Values

WEEK_INTERVAL

static final int WEEK_INTERVAL
See Also:
Constant Field Values

MONTH_INTERVAL

static final int MONTH_INTERVAL
See Also:
Constant Field Values

QUARTER_INTERVAL

static final int QUARTER_INTERVAL
See Also:
Constant Field Values

YEAR_INTERVAL

static final int YEAR_INTERVAL
See Also:
Constant Field Values
Method Detail

getYear

NumberDataValue getYear(NumberDataValue result)
                        throws StandardException
Get the year number out of a date.

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

getMonth

NumberDataValue getMonth(NumberDataValue result)
                         throws StandardException
Get the month number out of a date.

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

getDate

NumberDataValue getDate(NumberDataValue result)
                        throws StandardException
Get the day of the month.

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

getHours

NumberDataValue getHours(NumberDataValue result)
                         throws StandardException
Get the hour of the day out of a time or timestamp.

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

getMinutes

NumberDataValue getMinutes(NumberDataValue result)
                           throws StandardException
Get the minute of the hour out of a time or timestamp.

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

getSeconds

NumberDataValue getSeconds(NumberDataValue result)
                           throws StandardException
Get the second of the minute out of a time or timestamp.

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

timestampAdd

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.

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

timestampDiff

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.

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 DateTimeDataValue 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

Built on Thu 2012-03-29 21:53:33+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.