Package org.apache.derby.iapi.types
Class SQLInteger
- java.lang.Object
-
- org.apache.derby.iapi.types.DataType
-
- org.apache.derby.iapi.types.NumberDataType
-
- org.apache.derby.iapi.types.SQLInteger
-
- All Implemented Interfaces:
java.io.Externalizable,java.io.Serializable,java.lang.Comparable,Formatable,Storable,TypedFormat,DataValueDescriptor,NumberDataValue,Orderable
public final class SQLInteger extends NumberDataType
SQLInteger represents an INTEGER value.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static intBASE_MEMORY_USAGE(package private) static intINTEGER_LENGTHprivate booleanisnullprivate intvalue-
Fields inherited from class org.apache.derby.iapi.types.NumberDataType
MAXLONG_PLUS_ONE, MINLONG_MINUS_ONE
-
Fields inherited from interface org.apache.derby.iapi.types.DataValueDescriptor
UNKNOWN_LOGICAL_LENGTH
-
Fields inherited from interface org.apache.derby.iapi.types.NumberDataValue
MAX_DECIMAL_PRECISION_SCALE, MIN_DECIMAL_DIVIDE_SCALE
-
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
Constructors Constructor Description SQLInteger()no-arg constructor, required by FormattableSQLInteger(char val)SQLInteger(int val)SQLInteger(java.lang.Integer obj)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataValueDescriptorcloneValue(boolean forceMaterialization)Clone this DataValueDescriptor.BooleanDataValueequals(DataValueDescriptor left, DataValueDescriptor right)The = operator as called from the language module, as opposed to the storage module.intestimateMemoryUsage()Estimate the memory usage in bytes of the data value and the overhead of the class.booleangetBoolean()Gets the value in the data value descriptor as a boolean.bytegetByte()Gets the value in the data value descriptor as a byte.doublegetDouble()Gets the value in the data value descriptor as a double.floatgetFloat()Gets the value in the data value descriptor as a float.intgetInt()Gets the value in the data value descriptor as a int.intgetLength()Gets the length of the data value.longgetLong()Gets the value in the data value descriptor as a long.DataValueDescriptorgetNewNull()Get a new null value of the same type as this data value.java.lang.ObjectgetObject()Gets the value in the data value descriptor as a int.shortgetShort()Gets the value in the data value descriptor as a short.java.lang.StringgetString()Gets the value in the data value descriptor as a String.intgetTypeFormatId()Return my format identifier.java.lang.StringgetTypeName()Get the SQL name of the datatypeBooleanDataValuegreaterOrEquals(DataValueDescriptor left, DataValueDescriptor right)The >= operator as called from the language module, as opposed to the storage module.BooleanDataValuegreaterThan(DataValueDescriptor left, DataValueDescriptor right)The > operator as called from the language module, as opposed to the storage module.inthashCode()protected booleanisNegative()This method implements the isNegative method.booleanisNull()Return whether the value is null or not.BooleanDataValuelessOrEquals(DataValueDescriptor left, DataValueDescriptor right)The <= operator as called from the language module, as opposed to the storage module.BooleanDataValuelessThan(DataValueDescriptor left, DataValueDescriptor right)The < operator as called from the language module, as opposed to the storage module.NumberDataValueminus(NumberDataValue result)This method implements the unary minus operator for int.NumberDataValuemod(NumberDataValue dividend, NumberDataValue divisor, NumberDataValue result)mod(int, int)BooleanDataValuenotEquals(DataValueDescriptor left, DataValueDescriptor right)The <> operator as called from the language module, as opposed to the storage module.voidreadExternal(java.io.ObjectInput in)voidrestoreToNull()Restore this object to its (SQL)null value.protected voidsetFrom(DataValueDescriptor theValue)Set the value of this DataValueDescriptor based on the value of the specified DataValueDescriptor.voidsetInto(java.sql.PreparedStatement ps, int position)Set the value into a PreparedStatement.voidsetInto(java.sql.ResultSet rs, int position)Set this value into a ResultSet for a subsequent ResultSet.insertRow or ResultSet.updateRow.voidsetValue(boolean theValue)Set the value.voidsetValue(double theValue)Set the value of this DataValueDescriptor to the given double value At DataType level just throws an error lower classes will overridevoidsetValue(float theValue)Set the value of this DataValueDescriptor to the given float value At DataType level just throws an error lower classes will overridevoidsetValue(int theValue)Set the value of this DataValueDescriptor to the given int value At DataType level just throws an error lower classes will overridevoidsetValue(long theValue)Set the value of this DataValueDescriptor to the given long value At DataType level just throws an error lower classes will overridevoidsetValue(java.lang.String theValue)Set the value of this DataValueDescriptor.voidsetValueFromResultSet(java.sql.ResultSet resultSet, int colNumber, boolean isNullable)Set the value based on the value for the specified DataValueDescriptor from the specified ResultSet.NumberDataValuetimes(NumberDataValue left, NumberDataValue right, NumberDataValue result)This method implements the * operator for "int * int".java.lang.StringtoString()protected inttypeCompare(DataValueDescriptor arg)Compare this (not null) to a non-null value.inttypePrecedence()Each built-in type in JSQL has a precedence.voidwriteExternal(java.io.ObjectOutput out)-
Methods inherited from class org.apache.derby.iapi.types.NumberDataType
absolute, compare, compare, divide, divide, minus, normalizeDOUBLE, normalizeREAL, normalizeREAL, objectNull, plus, setBigDecimal, setObject, setValue, setValue, setValue, sqrt, typeToBigDecimal
-
Methods inherited from class org.apache.derby.iapi.types.DataType
checkHostVariable, cloneHolder, coalesce, compare, compare, compareTo, dataTypeConversion, equals, flip, genericSetObject, getBytes, getDate, getStream, getTime, getTimestamp, getTraceString, getTypeName, hasStream, in, invalidFormat, isNotNull, isNullOp, normalize, outOfRange, readExternalFromArray, recycle, setObjectForCast, setToNull, 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, cloneHolder, coalesce, compare, compare, getBytes, getDate, getStream, getTime, getTimestamp, getTraceString, hasStream, in, isNotNull, isNullOp, normalize, readExternalFromArray, recycle, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue
-
-
-
-
Field Detail
-
INTEGER_LENGTH
static final int INTEGER_LENGTH
- See Also:
- Constant Field Values
-
BASE_MEMORY_USAGE
private static final int BASE_MEMORY_USAGE
-
value
private int value
-
isnull
private boolean isnull
-
-
Method Detail
-
getInt
public int getInt()
Description copied from class:DataTypeGets 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:
getIntin interfaceDataValueDescriptor- Overrides:
getIntin classDataType- Returns:
- The data value as a int.
-
getByte
public byte getByte() throws StandardExceptionDescription copied from class:DataTypeGets the value in the data value descriptor as a byte. Throws an exception if the data value is not receivable as a byte.- Specified by:
getBytein interfaceDataValueDescriptor- Overrides:
getBytein classDataType- Returns:
- The data value as a byte.
- Throws:
StandardException- thrown on failure to convert
-
getShort
public short getShort() throws StandardExceptionDescription copied from class:DataTypeGets the value in the data value descriptor as a short. Throws an exception if the data value is not receivable as a short.- Specified by:
getShortin interfaceDataValueDescriptor- Overrides:
getShortin classDataType- Returns:
- The data value as a short.
- Throws:
StandardException- thrown on failure to convert
-
getLong
public long getLong()
Description copied from class:DataTypeGets the value in the data value descriptor as a long. Throws an exception if the data value is not receivable as a long.- Specified by:
getLongin interfaceDataValueDescriptor- Overrides:
getLongin classDataType- Returns:
- The data value as a long.
-
getFloat
public float getFloat()
Description copied from class:DataTypeGets the value in the data value descriptor as a float. Throws an exception if the data value is not receivable as a float.- Specified by:
getFloatin interfaceDataValueDescriptor- Overrides:
getFloatin classDataType- Returns:
- The data value as a float.
-
getDouble
public double getDouble()
Description copied from class:DataTypeGets the value in the data value descriptor as a double. Throws an exception if the data value is not receivable as a double.- Specified by:
getDoublein interfaceDataValueDescriptor- Overrides:
getDoublein classDataType- Returns:
- The data value as a double.
-
getBoolean
public boolean getBoolean()
Description copied from class:DataTypeGets the value in the data value descriptor as a boolean. Throws an exception if the data value is not receivable as a boolean.- Specified by:
getBooleanin interfaceDataValueDescriptor- Overrides:
getBooleanin classDataType- Returns:
- The data value as a boolean.
-
getString
public java.lang.String getString()
Description copied from interface:DataValueDescriptorGets the value in the data value descriptor as a String. Throws an exception if the data value is not a string.- Returns:
- The data value as a String.
-
getObject
public java.lang.Object getObject()
Description copied from class:DataTypeGets 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:
getObjectin interfaceDataValueDescriptor- Overrides:
getObjectin classDataType- Returns:
- The data value as a int.
-
getLength
public int getLength()
Description copied from interface:DataValueDescriptorGets 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.- Returns:
- The length of the data value
-
getTypeName
public java.lang.String getTypeName()
Description copied from interface:DataValueDescriptorGet the SQL name of the datatype- Returns:
- The SQL name of the datatype
-
getTypeFormatId
public int getTypeFormatId()
Return my format identifier.- Returns:
- The identifier. (A UUID stuffed in an array of 16 bytes).
- See Also:
TypedFormat.getTypeFormatId()
-
isNull
public boolean isNull()
Description copied from interface:StorableReturn whether the value is null or not.- Returns:
- true if the value is null and false otherwise.
- See Also:
Storable.isNull()
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException- Throws:
java.io.IOException
-
readExternal
public final void readExternal(java.io.ObjectInput in) throws java.io.IOException- Throws:
java.io.IOException- See Also:
Externalizable.readExternal(java.io.ObjectInput)
-
restoreToNull
public void restoreToNull()
Description copied from interface:StorableRestore this object to its (SQL)null value.- See Also:
Storable.restoreToNull()
-
typeCompare
protected int typeCompare(DataValueDescriptor arg) throws StandardException
Description copied from class:NumberDataTypeCompare this (not null) to a non-null value.- Specified by:
typeComparein classNumberDataType- Throws:
StandardException- Thrown on error
-
cloneValue
public DataValueDescriptor cloneValue(boolean forceMaterialization)
Description copied from interface:DataValueDescriptorClone 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 ifforceMaterializationis set tofalse. An example is if you need to access the value you just read usingcloneValueafter the current transaction has ended, or after the source result set has been closed.- Parameters:
forceMaterialization- any streams representing the data value will be materialized iftrue, the data value will be kept as a stream if possible iffalse- Returns:
- A clone of the
DataValueDescriptorwith the same initial value as this. - See Also:
DataValueDescriptor.cloneValue(boolean)
-
getNewNull
public DataValueDescriptor getNewNull()
Description copied from interface:DataValueDescriptorGet a new null value of the same type as this data value.- See Also:
DataValueDescriptor.getNewNull()
-
setValueFromResultSet
public void setValueFromResultSet(java.sql.ResultSet resultSet, int colNumber, boolean isNullable) throws java.sql.SQLExceptionDescription copied from interface:DataValueDescriptorSet the value based on the value for the specified DataValueDescriptor from the specified ResultSet.- 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)
-
setInto
public final void setInto(java.sql.PreparedStatement ps, int position) throws java.sql.SQLExceptionSet the value into a PreparedStatement.- Specified by:
setIntoin interfaceDataValueDescriptor- Overrides:
setIntoin classDataType- Throws:
java.sql.SQLException- Error setting value in PreparedStatement
-
setInto
public final void setInto(java.sql.ResultSet rs, int position) throws java.sql.SQLExceptionSet this value into a ResultSet for a subsequent ResultSet.insertRow or ResultSet.updateRow. This method will only be called for non-null values.- Specified by:
setIntoin interfaceDataValueDescriptor- Overrides:
setIntoin classDataType- Throws:
java.sql.SQLException- thrown by the ResultSet object
-
setValue
public void setValue(java.lang.String theValue) throws StandardExceptionDescription copied from class:DataTypeSet the value of this DataValueDescriptor. At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- The BigDecimal value to set this DataValueDescriptor to- Throws:
StandardException- thrown if string not accepted
-
setValue
public void setValue(int theValue)
Description copied from class:DataTypeSet the value of this DataValueDescriptor to the given int value At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- The value to set this DataValueDescriptor to
-
setValue
public void setValue(long theValue) throws StandardExceptionDescription copied from class:DataTypeSet the value of this DataValueDescriptor to the given long value At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- The value to set this DataValueDescriptor to- Throws:
StandardException- thrown on overflow
-
setValue
public void setValue(float theValue) throws StandardExceptionDescription copied from class:DataTypeSet the value of this DataValueDescriptor to the given float value At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- The value to set this DataValueDescriptor to- Throws:
StandardException- Thrown on error- See Also:
NumberDataValue.setValue(java.lang.Number)
-
setValue
public void setValue(double theValue) throws StandardExceptionDescription copied from class:DataTypeSet the value of this DataValueDescriptor to the given double value At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- The value to set this DataValueDescriptor to- Throws:
StandardException- Thrown on error- See Also:
NumberDataValue.setValue(java.lang.Number)
-
setValue
public void setValue(boolean theValue)
Description copied from class:DataTypeSet the value. At DataType level just throws an error lower classes will override- Specified by:
setValuein interfaceDataValueDescriptor- Overrides:
setValuein classDataType- Parameters:
theValue- Contains the boolean value to set this to
-
setFrom
protected void setFrom(DataValueDescriptor theValue) throws StandardException
Description copied from class:DataTypeSet the value of this DataValueDescriptor based on the value of the specified DataValueDescriptor.- Overrides:
setFromin classDataType- Parameters:
theValue- The DataValueDescriptor that holds the value to which we want to set this DataValueDescriptor's value.- Throws:
StandardException
-
typePrecedence
public int typePrecedence()
Description copied from class:DataTypeEach 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:
typePrecedencein interfaceDataValueDescriptor- Overrides:
typePrecedencein classDataType- Returns:
- The precedence of this type.
- See Also:
DataValueDescriptor.typePrecedence()
-
equals
public BooleanDataValue equals(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The = operator as called from the language module, as opposed to the storage module.- Specified by:
equalsin interfaceDataValueDescriptor- Overrides:
equalsin classDataType- Parameters:
left- The value on the left side of the =right- The value on the right side of the =- Returns:
- A SQL boolean value telling whether the two parameters are equal
- Throws:
StandardException- Thrown on error
-
notEquals
public BooleanDataValue notEquals(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The <> operator as called from the language module, as opposed to the storage module.- Specified by:
notEqualsin interfaceDataValueDescriptor- Overrides:
notEqualsin classDataType- Parameters:
left- The value on the left side of the operatorright- The value on the right side of the operator- Returns:
- A SQL boolean value telling whether the two parameters are not equal
- Throws:
StandardException- Thrown on error
-
lessThan
public BooleanDataValue lessThan(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The < operator as called from the language module, as opposed to the storage module.- Specified by:
lessThanin interfaceDataValueDescriptor- Overrides:
lessThanin classDataType- Parameters:
left- The value on the left side of the operatorright- The value on the right side of the operator- Returns:
- A SQL boolean value telling whether the first operand is less than the second operand
- Throws:
StandardException- Thrown on error
-
greaterThan
public BooleanDataValue greaterThan(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The > operator as called from the language module, as opposed to the storage module.- Specified by:
greaterThanin interfaceDataValueDescriptor- Overrides:
greaterThanin classDataType- Parameters:
left- The value on the left side of the operatorright- The value on the right side of the operator- Returns:
- A SQL boolean value telling whether the first operand is greater than the second operand
- Throws:
StandardException- Thrown on error
-
lessOrEquals
public BooleanDataValue lessOrEquals(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The <= operator as called from the language module, as opposed to the storage module.- Specified by:
lessOrEqualsin interfaceDataValueDescriptor- Overrides:
lessOrEqualsin classDataType- Parameters:
left- The value on the left side of the operatorright- The value on the right side of the operator- Returns:
- A SQL boolean value telling whether the first operand is less than or equal to the second operand
- Throws:
StandardException- Thrown on error
-
greaterOrEquals
public BooleanDataValue greaterOrEquals(DataValueDescriptor left, DataValueDescriptor right) throws StandardException
The >= operator as called from the language module, as opposed to the storage module.- Specified by:
greaterOrEqualsin interfaceDataValueDescriptor- Overrides:
greaterOrEqualsin classDataType- Parameters:
left- The value on the left side of the operatorright- The value on the right side of the operator- Returns:
- A SQL boolean value telling whether the first operand is greater than or equal to the second operand
- Throws:
StandardException- Thrown on error
-
times
public NumberDataValue times(NumberDataValue left, NumberDataValue right, NumberDataValue result) throws StandardException
This method implements the * operator for "int * int".- Parameters:
left- The first value to be multipliedright- The second value to be multipliedresult- The result of a previous call to this method, null if not called yet- Returns:
- A SQLInteger containing the result of the multiplication
- Throws:
StandardException- Thrown on error
-
mod
public NumberDataValue mod(NumberDataValue dividend, NumberDataValue divisor, NumberDataValue result) throws StandardException
mod(int, int)- Specified by:
modin interfaceNumberDataValue- Overrides:
modin classNumberDataType- Parameters:
dividend- The numeratordivisor- The denominatorresult- The result of the previous call to this method, null if not called yet.- Returns:
- dividend / divisor
- Throws:
StandardException- Thrown on error, if result is non-null then its value will be unchanged.
-
minus
public NumberDataValue minus(NumberDataValue result) throws StandardException
This method implements the unary minus operator for int.- Parameters:
result- The result of a previous call to this method, null if not called yet- Returns:
- A SQLInteger containing the result of the division
- Throws:
StandardException- Thrown on error
-
isNegative
protected boolean isNegative()
This method implements the isNegative method.- Specified by:
isNegativein classNumberDataType- Returns:
- A boolean. If this.value is negative, return true. For positive values or null, return false.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
estimateMemoryUsage
public int estimateMemoryUsage()
Description copied from interface:DataValueDescriptorEstimate the memory usage in bytes of the data value and the overhead of the class.- Returns:
- the estimated memory usage
-
-