Package org.apache.derby.iapi.types

Class SQLTime

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Comparable, Formatable, Storable, TypedFormat, DataValueDescriptor, DateTimeDataValue, Orderable
    public final class SQLTime
extends DataType
implements DateTimeDataValue
    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.

    See Also:
    Serialized Form

    • Field Detail

      • encodedTime

        private int encodedTime

      • encodedTimeFraction

        private int encodedTimeFraction

      • BASE_MEMORY_USAGE

        private static final int BASE_MEMORY_USAGE

      • IBM_EUR_SEPARATOR_OR_END

        private static final char[] IBM_EUR_SEPARATOR_OR_END

      • US_OR_JIS_MINUTE_END

        private static final char[] US_OR_JIS_MINUTE_END

      • ANY_SEPARATOR

        private static final char[] ANY_SEPARATOR

      • AM_PM

        private static final java.lang.String[] AM_PM

      • END_OF_STRING

        private static final char[] END_OF_STRING

    • Constructor Detail

      • SQLTime

        public SQLTime()
        no-arg constructor required by Formattable

      • SQLTime

        private SQLTime​(int encodedTime,
                int encodedTimeFraction)

      • SQLTime

        public SQLTime​(java.lang.String timeStr,
               boolean isJdbcEscape,
               LocaleFinder localeFinder)
        throws StandardException
        Construct a time from a string. The allowed time formats are:
        1. old ISO and IBM European standard: hh.mm[.ss]
        2. IBM USA standard: hh[:mm] {AM | PM}
        3. JIS and current ISO: hh:mm[:ss]
        Throws:
        StandardException - if the syntax is invalid or the value is out of range

      • SQLTime

        public SQLTime​(java.lang.String timeStr,
               boolean isJdbcEscape,
               LocaleFinder localeFinder,
               java.util.Calendar cal)
        throws StandardException
        Construct a time from a string. The allowed time formats are:
        1. old ISO and IBM European standard: hh.mm[.ss]
        2. IBM USA standard: hh[:mm] {AM | PM}
        3. JIS and current ISO: hh:mm[:ss]
        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

      • 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.

      • getEncodedTime

        int getEncodedTime()

      • getTimestamp

        public java.sql.Timestamp getTimestamp​(java.util.Calendar cal)
        Convert a SQL TIME to a JDBC java.sql.Timestamp. Behaviour is to set the date portion of the Timestamp to the actual current date, which may not match the SQL CURRENT DATE, which remains fixed for the lifetime of a SQL statement. JDBC drivers (especially network client drivers) could not be expected to fetch the CURRENT_DATE SQL value on every query that involved a TIME value, so the current date as seen by the JDBC client was picked as the logical behaviour. See DERBY-1811.
        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.

      • getObject

        public java.lang.Object getObject()
        Description copied from class: DataType
        Gets the value in the data value descriptor as a int. Throws an exception if the data value is not receivable as a int.
        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

      • 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)

      • 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

      • 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.Time 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 Time value to set this DataValueDescriptor to
        cal - The time zone from the calendar is used to construct the database time value
        Throws:
        StandardException - thrown on failure.
        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 - thrown on failure.
        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

      • 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.
        Specified by:
        isNull in interface Storable
        Returns:
        Whether or not value is logically null.

      • getTime

        public 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
        Specified by:
        getTime in interface DataValueDescriptor
        Overrides:
        getTime in class DataType
        Parameters:
        cal - calendar for object creation
        Returns:
        The localized time value.

      • setTimeInCalendar

        static void setTimeInCalendar​(java.util.Calendar cal,
                              int encodedTime)
        Set the time portion of a date-time value into the passed in Calendar object from its encodedTime value. Note that this is only the time down to a resolution of one second. Only the HOUR_OF_DAY, MINUTE and SECOND fields are modified. The remaining state of the Calendar is not modified.

      • getTime

        static java.sql.Time getTime​(java.util.Calendar cal,
                             int encodedTime,
                             int nanos)
        Get a java.sql.Time object from an encoded time and nano-second value. As required by JDBC the date component of the Time object will be set to Jan. 1, 1970
        Parameters:
        cal - Calendar to use for conversion
        encodedTime - Derby encoded time value
        nanos - number of nano-seconds.
        Returns:
        Valid Time object.

      • getHour

        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)
        Returns:
        hour value

      • getMinute

        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)
        Returns:
        minute value

      • getSecond

        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)
        Returns:
        second value

      • computeEncodedTime

        static int computeEncodedTime​(java.util.Calendar cal)
                       throws StandardException
        Calculate the encoded time from a Calendar object encoded time is hour << 16 + min << 8 + sec this function is also used by SQLTimestamp
        Parameters:
        cal - calendar with time set
        Returns:
        encoded time
        Throws:
        StandardException - if the time is not in the DB2 range

      • timeToString

        static void timeToString​(int hour,
                         int minute,
                         int second,
                         java.lang.StringBuffer sb)
        Convert a time to a JDBC escape format string
        Parameters:
        hour -
        minute -
        second -
        sb - The resulting string is appended to this StringBuffer

      • encodedTimeToString

        protected static java.lang.String encodedTimeToString​(int encodedTime)
        Get the String version from the encodedTime.
        Returns:
        string value.

      • computeEncodedTime

        private int computeEncodedTime​(java.util.Date value)
                        throws StandardException
        Compute encoded time value Time is represented by hour << 16 + minute << 8 + seconds
        Throws:
        StandardException

      • 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

      • 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