Package org.apache.derby.iapi.types

Class UserType

    • Field Detail

      • value

        private java.lang.Object value

      • BASE_MEMORY_USAGE

        private static final int BASE_MEMORY_USAGE

    • Constructor Detail

      • UserType

        public UserType()
        no-arg constructor required by Formattable

      • UserType

        public UserType​(java.lang.Object value)

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

      • getBytes

        public byte[] getBytes()
                throws StandardException
        Description copied from class: DataType
        Gets the value in the data value descriptor as a byte[]. Throws an exception if the data value is not receivable as a Binary or Varbinary.
        Specified by:
        getBytes in interface DataValueDescriptor
        Overrides:
        getBytes in class DataType
        Returns:
        The Binary value as a byte[].
        Throws:
        StandardException - thrown on failure to convert

      • getDate

        public java.sql.Date getDate​(java.util.Calendar cal)
                      throws StandardException
        Description copied from class: DataType
        Gets the value in the data value descriptor as a java.sql.Date. Throws an exception if the data value is not receivable as a Date.
        Specified by:
        getDate in interface DataValueDescriptor
        Overrides:
        getDate in class DataType
        Parameters:
        cal - calendar for object creation
        Returns:
        The data value as a java.sql.Date.
        Throws:
        StandardException - thrown on failure

      • getTime

        public java.sql.Time getTime​(java.util.Calendar cal)
                      throws StandardException
        Description copied from class: DataType
        Gets the value in the data value descriptor as a java.sql.Time. Throws an exception if the data value is not receivable as a Time.
        Specified by:
        getTime in interface DataValueDescriptor
        Overrides:
        getTime in class DataType
        Parameters:
        cal - calendar for object creation
        Returns:
        The data value as a java.sql.Time.
        Throws:
        StandardException - thrown on failure

      • getTimestamp

        public java.sql.Timestamp getTimestamp​(java.util.Calendar cal)
                                throws StandardException
        Description copied from class: DataType
        Gets the value in the data value descriptor as a java.sql.Timestamp. Throws an exception if the data value is not receivable as a Timestamp.
        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.
        Throws:
        StandardException - thrown on failure

      • setObject

        void setObject​(java.lang.Object theValue)
        Description copied from class: DataType
        Set the value from an non-null object. Usually overridden. This implementation throws an exception. The object will have been correctly typed from the call to setObjectForCast.
        Overrides:
        setObject in class DataType

      • 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

      • getTypeName

        java.lang.String getTypeName​(java.lang.String className)
        Get the type name of this value, overriding with the passed in class name (for user/java types).
        Overrides:
        getTypeName in class DataType

      • 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,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException - Thrown on error reading the object
        java.lang.ClassNotFoundException - Thrown if the class of the object is not found
        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)

      • setValueFromResultSet

        public void setValueFromResultSet​(java.sql.ResultSet resultSet,
                                  int colNumber,
                                  boolean isNullable)
                           throws java.sql.SQLException
        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
        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

      • 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.lang.String theValue)
        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

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