| Modifier and Type | Field and Description |
|---|---|
| private static final int | |
| private int |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public DataValueDescriptor | cloneValue(boolean
any streams representing the data value will
be materialized if forceMaterialization)true, the data value will be kept as a
stream if possible if falseImplements org. Clone this DataValueDescriptor. |
| public int | 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.The Orderable to compare this one to. other)Implements org. Compare this Orderable with a given Orderable for the purpose of index positioning. |
| public int | estimateMemoryUsage()
Implements org. Estimate the memory usage in bytes of the data value and the overhead of the class. |
| public int | Returns: The length of the data valueImplements org. Gets the length of the data value. |
| public DataValueDescriptor | getNewNull()
Implements org. Get a new null value of the same type as this data value. |
| public Object | Returns: The data value as an Object.Overrides org. Implements org. Gets the value in the data value descriptor as a Java Object. |
| public String | Returns: The data value as a String.Implements org. Gets the value in the data value descriptor as a String. |
| public int | getTypeFormatId()
Implements org. Return my format identifier. |
| public String | Returns: The SQL name of the datatypeImplements org. Get the SQL name of the datatype |
| public int | |
| public boolean | isNull()
Implements org. Return whether the value is null or not. |
| public void | readExternal(ObjectInput
the stream to read data from in order to restore the object in)Implements java. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. |
| public void | restoreToNull()
Implements org. Restore this object to its (SQL)null value. |
| protected void | setFrom(DataValueDescriptor
The Date value to set this DataValueDescriptor to theValue)Overrides org. Set the value of this DataValueDescriptor from another. |
| public void | setValue(int
The value to set this DataValueDescriptor to input_value)Overrides org. Implements org. Set the value of this DataValueDescriptor to the given int value At DataType level just throws an error lower classes will override |
| public void | setValueFromResultSet(ResultSet
The specified ResultSet. resultSet, int The 1-based column # into the resultSet. colNumber, boolean Whether or not the column is nullable
(No need to call wasNull() if not) isNullable)Implements org. Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet. |
| public void | writeExternal(ObjectOutput
the stream to write the object to out)Implements java. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. |
| BASE_MEMORY_USAGE | back to summary |
|---|---|
| private static final int BASE_MEMORY_USAGE | |
| format_id | back to summary |
|---|---|
| private int format_id | |
| StorableFormatId | back to summary |
|---|---|
| public StorableFormatId() | |
| StorableFormatId | back to summary |
|---|---|
| public StorableFormatId(int value) | |
| cloneValue | back to summary |
|---|---|
| public DataValueDescriptor cloneValue(boolean forceMaterialization) Implements org. Doc from org. 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
| |
| compare | back to summary |
|---|---|
| public int compare(DataValueDescriptor other) throws StandardException Implements org. Compare this Orderable with a given Orderable for the purpose of index positioning. This method treats nulls as ordered values - that is, it treats SQL null as equal to null and less than all other values.
| |
| estimateMemoryUsage | back to summary |
|---|---|
| public int estimateMemoryUsage() Implements org. Doc from org. Estimate the memory usage in bytes of the data value and the overhead of the class.
| |
| getLength | back to summary |
|---|---|
| public int getLength() throws StandardException Implements org. 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.
| |
| getNewNull | back to summary |
|---|---|
| public DataValueDescriptor getNewNull() Implements org. Get a new null value of the same type as this data value. | |
| getObject | back to summary |
|---|---|
| public Object getObject() throws StandardException Overrides org. Implements org. Gets the value in the data value descriptor as a Java Object. The type of the Object will be the Java object type corresponding to the data value's SQL type. JDBC defines a mapping between Java object types and SQL types - we will allow that to be extended through user type definitions. Throws an exception if the data value is not an object (yeah, right).
| |
| getString | back to summary |
|---|---|
| public String getString() throws StandardException Implements org. Gets the value in the data value descriptor as a String. Throws an exception if the data value is not a string.
| |
| getTypeFormatId | back to summary |
|---|---|
| public int getTypeFormatId() Implements org. Return my format identifier.
| |
| getTypeName | back to summary |
|---|---|
| public String getTypeName() Implements org. Get the SQL name of the datatype
| |
| getValue | back to summary |
|---|---|
| public int getValue() | |
| isNull | back to summary |
|---|---|
| public boolean isNull() Implements org. Doc from org. Return whether the value is null or not.
| |
| readExternal | back to summary |
|---|---|
| public void readExternal(ObjectInput in) throws IOException Implements java. Doc from java. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
| |
| restoreToNull | back to summary |
|---|---|
| public void restoreToNull() Implements org. Doc from org. Restore this object to its (SQL)null value. | |
| setFrom | back to summary |
|---|---|
| protected void setFrom(DataValueDescriptor theValue) throws StandardException Overrides org. Set the value of this DataValueDescriptor from another.
| |
| setValue | back to summary |
|---|---|
| public void setValue(int input_value) Overrides org. Implements org. Doc from org. Set the value of this DataValueDescriptor to the given int value At DataType level just throws an error lower classes will override
| |
| setValueFromResultSet | back to summary |
|---|---|
| public void setValueFromResultSet(ResultSet resultSet, int colNumber, boolean isNullable) throws StandardException, SQLException Implements org. Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet.
| |
| writeExternal | back to summary |
|---|---|
| public void writeExternal(ObjectOutput out) throws IOException Implements java. Doc from java. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
| |