|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.derby.iapi.types.DataType
org.apache.derby.iapi.types.SQLTime
This contains an instance of a SQL Time Our current implementation doesn't implement time precision so the fractional seconds portion of the time is always 0. The default when no time precision is specified is 0 fractional seconds. A SQL Time without timezone information is assumed to be in the local time zone. The local time is stored as is and doesn't change if the timezone changes. This is in conformance with the SQL99 standard. The SQL92 standard indicates that the time is in GMT and changes with the timezone. The SQL99 standard clarifies this to allow time without timezoned to be stored as the local time.
Time is stored as two ints. The first int represents hour, minute, second and the second represents fractional seconds (currently 0 since we don't support time precision) encodedTime = -1 indicates null PERFORMANCE OPTIMIZATION: The java.sql.Time object is only instantiated on demand for performance reasons.
Field Summary | |
private static java.lang.String[] |
AM_PM
|
private static char[] |
ANY_SEPARATOR
|
private static int |
BASE_MEMORY_USAGE
|
private int |
encodedTime
|
private int |
encodedTimeFraction
|
private static char[] |
END_OF_STRING
|
private static char |
IBM_EUR_SEPARATOR
|
private static char[] |
IBM_EUR_SEPARATOR_OR_END
|
(package private) static char |
JIS_SEPARATOR
|
private static char[] |
US_OR_JIS_MINUTE_END
|
private java.lang.String |
valueString
|
Fields inherited from interface org.apache.derby.iapi.types.DateTimeDataValue |
DAY_FIELD, HOUR_FIELD, MINUTE_FIELD, MONTH_FIELD, SECOND_FIELD, YEAR_FIELD |
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 | |
|
SQLTime()
no-arg constructor required by Formattable |
private |
SQLTime(int encodedTime,
int encodedTimeFraction)
|
|
SQLTime(java.lang.String timeStr,
boolean isJdbcEscape,
LocaleFinder localeFinder)
Construct a time from a string. |
|
SQLTime(java.lang.String timeStr,
boolean isJdbcEscape,
LocaleFinder localeFinder,
java.util.Calendar cal)
Construct a time from a string. |
|
SQLTime(java.sql.Time value)
|
Method Summary | |
int |
compare(DataValueDescriptor other)
Orderable interface |
boolean |
compare(int op,
DataValueDescriptor other,
boolean orderedNulls,
boolean unknownRV)
Compare this Orderable with a given Orderable for the purpose of qualification and sorting. |
(package private) static int |
computeEncodedTime(java.util.Calendar cal)
Calculate the encoded time from a Calendar object encoded time is hour << 16 + min << 8 + sec this function is also used by SQLTimestamp |
private int |
computeEncodedTime(java.util.Date value)
Compute encoded time value Time is represented by hour << 16 + minute << 8 + seconds |
(package private) static int |
computeEncodedTime(java.util.Date value,
java.util.Calendar currentCal)
|
(package private) static int |
computeEncodedTime(int hour,
int minute,
int second)
|
protected static java.lang.String |
encodedTimeToString(int encodedTime)
Get the String version from the encodedTime. |
int |
estimateMemoryUsage()
Estimate the memory usage in bytes of the data value and the overhead of the class. |
DataValueDescriptor |
getClone()
Shallow copy. |
NumberDataValue |
getDate(NumberDataValue result)
Get the day of the month. |
(package private) int |
getEncodedTime()
|
protected static int |
getHour(int encodedTime)
Get the encoded hour value (may be different than hour value for current timezone if value encoded in a different timezone) |
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. |
protected static int |
getMinute(int encodedTime)
Get the encoded minute value (may be different than the minute value for current timezone if value encoded in a different timezone) |
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. |
protected static int |
getSecond(int encodedTime)
Get the encoded second value (may be different than the second value for current timezone if value encoded in a different timezone) |
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. |
java.sql.Time |
getTime(java.util.Calendar cal)
Get the time value Since this is a JDBC object we use the JDBC definition we use the JDBC definition, see JDBC API Tutorial and Reference section 47.3.12 Date is set to Jan. 1, 1970 |
java.sql.Timestamp |
getTimestamp(java.util.Calendar cal)
Gets the value in the data value descriptor as a java.sql.Timestamp. |
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. |
protected java.sql.Time |
newTime(java.util.Calendar cal)
|
private void |
parseTime(java.util.Date value)
|
private void |
parseTime(java.lang.String timeStr,
boolean isJdbcEscape,
LocaleFinder localeFinder,
java.util.Calendar cal)
|
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. |
protected void |
setFrom(DataValueDescriptor theValue)
|
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. |
(package private) static void |
timeToString(int hour,
int minute,
int second,
java.lang.StringBuffer sb)
Convert a time to a JDBC escape format string |
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, getBigDecimal, getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getShort, getStream, greaterOrEquals, greaterThan, in, invalidFormat, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, outOfRange, setInto, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, throwLangSetMismatch, throwLangSetMismatch |
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, getBigDecimal, getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getShort, getStream, greaterOrEquals, greaterThan, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, setInto, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue |
Field Detail |
private int encodedTime
private int encodedTimeFraction
private java.lang.String valueString
private static final int BASE_MEMORY_USAGE
private static final char IBM_EUR_SEPARATOR
private static final char[] IBM_EUR_SEPARATOR_OR_END
static final char JIS_SEPARATOR
private static final char[] US_OR_JIS_MINUTE_END
private static final char[] ANY_SEPARATOR
private static final java.lang.String[] AM_PM
private static final char[] END_OF_STRING
Constructor Detail |
public SQLTime()
public SQLTime(java.sql.Time value) throws StandardException
private SQLTime(int encodedTime, int encodedTimeFraction)
public SQLTime(java.lang.String timeStr, boolean isJdbcEscape, LocaleFinder localeFinder) throws StandardException
Standard
- exception if the syntax is invalid or the value is out of range.
StandardException
public SQLTime(java.lang.String timeStr, boolean isJdbcEscape, LocaleFinder localeFinder, java.util.Calendar cal) throws StandardException
Standard
- exception if the syntax is invalid or the value is out of range.
StandardException
Method Detail |
public int estimateMemoryUsage()
DataValueDescriptor
estimateMemoryUsage
in interface DataValueDescriptor
public java.lang.String getString()
DataValueDescriptor
getString
in interface DataValueDescriptor
int getEncodedTime()
public java.sql.Timestamp getTimestamp(java.util.Calendar cal) throws StandardException
DataValueDescriptor
getTimestamp
in interface DataValueDescriptor
getTimestamp
in class DataType
cal
- calendar for object creation
StandardException
- thrown on failurepublic java.lang.Object getObject()
DataValueDescriptor
getObject
in interface DataValueDescriptor
getObject
in class DataType
public int getLength()
DataValueDescriptor
getLength
in interface DataValueDescriptor
public java.lang.String getTypeName()
DataValueDescriptor
getTypeName
in interface DataValueDescriptor
public int getTypeFormatId()
getTypeFormatId
in interface TypedFormat
TypedFormat.getTypeFormatId()
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
- error writing datapublic void readExternal(java.io.ObjectInput in) throws java.io.IOException
readExternal
in interface java.io.Externalizable
java.io.IOException
- Thrown on error reading the objectExternalizable.readExternal(java.io.ObjectInput)
public void readExternalFromArray(ArrayInputStream in) throws java.io.IOException
DataValueDescriptor
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().
readExternalFromArray
in interface DataValueDescriptor
in
- The array stream positioned at the beginning of the
byte stream to read from.
java.io.IOException
- Usual error is if you try to read
past limit on the stream.public DataValueDescriptor getClone()
DataValueDescriptor
Clone the DataValueDescriptor and copy its contents. We clone the data value wrapper (e.g. SQLDecimal) and reuse its contents (the underlying BigDecimal). The resultant DataValueDescriptor will point to the same value as the original DataValueDescriptor (unless the value is a primitive type, e.g. SQLInteger/integer).
getClone
in interface DataValueDescriptor
DataValueDescriptor.getClone()
public DataValueDescriptor getNewNull()
DataValueDescriptor
getNewNull
in interface DataValueDescriptor
DataValueDescriptor.getNewNull()
public void restoreToNull()
Storable
restoreToNull
in interface Storable
Storable.restoreToNull()
public void setValueFromResultSet(java.sql.ResultSet resultSet, int colNumber, boolean isNullable) throws java.sql.SQLException, StandardException
DataValueDescriptor
setValueFromResultSet
in interface DataValueDescriptor
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)
java.sql.SQLException
- Thrown on error
StandardException
- Thrown on errorDataValueDescriptor.setValueFromResultSet(java.sql.ResultSet, int, boolean)
public int compare(DataValueDescriptor other) throws StandardException
compare
in interface DataValueDescriptor
other
- The Orderable to compare this one to.
StandardException
- thrown on failureOrderable
public boolean compare(int op, DataValueDescriptor other, boolean orderedNulls, boolean unknownRV) throws StandardException
DataValueDescriptor
compare
in interface DataValueDescriptor
compare
in class DataType
StandardException
- thrown on errorprivate void parseTime(java.util.Date value) throws StandardException
StandardException
private void parseTime(java.lang.String timeStr, boolean isJdbcEscape, LocaleFinder localeFinder, java.util.Calendar cal) throws StandardException
StandardException
public void setValue(java.lang.Object theValue) throws StandardException
DataValueDescriptor
setValue
in interface DataValueDescriptor
setValue
in class DataType
StandardException
protected void setFrom(DataValueDescriptor theValue) throws StandardException
setFrom
in class DataType
StandardException
public void setValue(java.sql.Time value, java.util.Calendar cal) throws StandardException
DataValueDescriptor
setValue
in interface DataValueDescriptor
setValue
in class DataType
value
- The Time value to set this DataValueDescriptor tocal
- The time zone from the calendar is used to construct the database time value
StandardException
- thrown on failure.DataValueDescriptor.setValue(java.lang.Object)
public void setValue(java.sql.Timestamp value, java.util.Calendar cal) throws StandardException
DataValueDescriptor
setValue
in interface DataValueDescriptor
setValue
in class DataType
value
- The Timestamp value to set this DataValueDescriptor tocal
- The time zone from the calendar is used to construct the database timestamp value
StandardException
- thrown on failure.DataValueDescriptor.setValue(java.lang.Object)
public void setValue(java.lang.String theValue) throws StandardException
DataValueDescriptor
setValue
in interface DataValueDescriptor
setValue
in class DataType
theValue
- The BigDecimal value to set this DataValueDescriptor to
StandardException
public NumberDataValue getYear(NumberDataValue result) throws StandardException
DateTimeDataValue
getYear
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getYear(org.apache.derby.iapi.types.NumberDataValue)
public NumberDataValue getMonth(NumberDataValue result) throws StandardException
DateTimeDataValue
getMonth
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getMonth(org.apache.derby.iapi.types.NumberDataValue)
public NumberDataValue getDate(NumberDataValue result) throws StandardException
DateTimeDataValue
getDate
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getDate(org.apache.derby.iapi.types.NumberDataValue)
public NumberDataValue getHours(NumberDataValue result) throws StandardException
DateTimeDataValue
getHours
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getHours(org.apache.derby.iapi.types.NumberDataValue)
public NumberDataValue getMinutes(NumberDataValue result) throws StandardException
DateTimeDataValue
getMinutes
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getMinutes(org.apache.derby.iapi.types.NumberDataValue)
public NumberDataValue getSeconds(NumberDataValue result) throws StandardException
DateTimeDataValue
getSeconds
in interface DateTimeDataValue
result
- The result of the previous call to this method, null
if not called yet.
StandardException
- Thrown on errorDateTimeDataValue.getSeconds(org.apache.derby.iapi.types.NumberDataValue)
public java.lang.String toString()
public int hashCode()
public int typePrecedence()
DataValueDescriptor
typePrecedence
in interface DataValueDescriptor
typePrecedence
in class DataType
DataValueDescriptor.typePrecedence()
public final boolean isNull()
isNull
in interface Storable
public java.sql.Time getTime(java.util.Calendar cal)
getTime
in interface DataValueDescriptor
getTime
in class DataType
cal
- calendar for object creation
protected java.sql.Time newTime(java.util.Calendar cal)
protected static int getHour(int encodedTime)
protected static int getMinute(int encodedTime)
protected static int getSecond(int encodedTime)
static int computeEncodedTime(java.util.Calendar cal) throws StandardException
StandardException
- if the time is not in the DB2 rangestatic int computeEncodedTime(int hour, int minute, int second) throws StandardException
StandardException
static void timeToString(int hour, int minute, int second, java.lang.StringBuffer sb)
hour
- minute
- second
- sb
- The resulting string is appended to this StringBufferprotected static java.lang.String encodedTimeToString(int encodedTime)
protected java.lang.String getNationalString(LocaleFinder localeFinder) throws StandardException
getNationalString
in class DataType
StandardException
- Thrown on errorprivate int computeEncodedTime(java.util.Date value) throws StandardException
StandardException
static int computeEncodedTime(java.util.Date value, java.util.Calendar currentCal) throws StandardException
StandardException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |