| /* |
| |
| Derby - Class org.apache.derby.iapi.types.SQLInteger |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to you under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| */ |
| |
| package org.apache.derby.iapi.types; |
| |
| import org.apache.derby.iapi.reference.SQLState; |
| |
| import org.apache.derby.iapi.services.io.StoredFormatIds; |
| import org.apache.derby.iapi.services.io.Storable; |
| |
| import org.apache.derby.iapi.error.StandardException; |
| import org.apache.derby.shared.common.sanity.SanityManager; |
| |
| import org.apache.derby.iapi.services.cache.ClassSize; |
| |
| import java.io.ObjectOutput; |
| import java.io.ObjectInput; |
| import java.io.IOException; |
| |
| import java.sql.ResultSet; |
| import java.sql.PreparedStatement; |
| import java.sql.SQLException; |
| |
| /** |
| * SQLInteger represents an INTEGER value. |
| */ |
| public final class SQLInteger |
| extends NumberDataType |
| { |
| /* |
| * DataValueDescriptor interface |
| * (mostly implemented in DataType) |
| */ |
| |
| |
| // JDBC is lax in what it permits and what it |
| // returns, so we are similarly lax |
| // @see DataValueDescriptor |
| public int getInt() |
| { |
| /* This value is 0 if the SQLInteger is null */ |
| return value; |
| } |
| |
| /** |
| * @exception StandardException thrown on failure to convert |
| */ |
| public byte getByte() throws StandardException |
| { |
| if (value > Byte.MAX_VALUE || value < Byte.MIN_VALUE) |
| throw StandardException.newException(SQLState.LANG_OUTSIDE_RANGE_FOR_DATATYPE, "TINYINT"); |
| return (byte) value; |
| } |
| |
| /** |
| * @exception StandardException thrown on failure to convert |
| */ |
| public short getShort() throws StandardException |
| { |
| if (value > Short.MAX_VALUE || value < Short.MIN_VALUE) |
| throw StandardException.newException(SQLState.LANG_OUTSIDE_RANGE_FOR_DATATYPE, "SMALLINT"); |
| return (short) value; |
| } |
| |
| public long getLong() |
| { |
| return (long) value; |
| } |
| |
| public float getFloat() |
| { |
| return (float) value; |
| } |
| |
| public double getDouble() |
| { |
| return (double) value; |
| } |
| |
| // for lack of a specification: 0 or null is false, |
| // all else is true |
| public boolean getBoolean() |
| { |
| return (value != 0); |
| } |
| |
| public String getString() |
| { |
| if (isNull()) |
| return null; |
| else |
| return Integer.toString(value); |
| } |
| |
| public Object getObject() |
| { |
| if (isNull()) |
| return null; |
| else |
| return value; |
| } |
| |
| public int getLength() |
| { |
| return INTEGER_LENGTH; |
| } |
| |
| // this is for DataType's error generator |
| public String getTypeName() |
| { |
| return TypeId.INTEGER_NAME; |
| } |
| |
| /* |
| * Storable interface, implies Externalizable, TypedFormat |
| */ |
| |
| |
| /** |
| Return my format identifier. |
| |
| @see org.apache.derby.iapi.services.io.TypedFormat#getTypeFormatId |
| */ |
| public int getTypeFormatId() { |
| return StoredFormatIds.SQL_INTEGER_ID; |
| } |
| |
| /* |
| * see if the integer value is null. |
| */ |
| /** @see Storable#isNull */ |
| public boolean isNull() |
| { |
| return isnull; |
| } |
| |
| public void writeExternal(ObjectOutput out) throws IOException { |
| |
| // never called when value is null |
| if (SanityManager.DEBUG) |
| SanityManager.ASSERT(! isNull()); |
| |
| out.writeInt(value); |
| } |
| |
| /** @see java.io.Externalizable#readExternal */ |
| public final void readExternal(ObjectInput in) |
| throws IOException { |
| |
| value = in.readInt(); |
| isnull = false; |
| } |
| |
| /** |
| * @see Storable#restoreToNull |
| * |
| */ |
| |
| public void restoreToNull() |
| { |
| value = 0; |
| isnull = true; |
| } |
| |
| |
| /** @exception StandardException Thrown on error */ |
| protected int typeCompare(DataValueDescriptor arg) throws StandardException |
| { |
| /* neither are null, get the value */ |
| |
| int thisValue = this.getInt(); |
| |
| int otherValue = arg.getInt(); |
| |
| if (thisValue == otherValue) |
| return 0; |
| else if (thisValue > otherValue) |
| return 1; |
| else |
| return -1; |
| } |
| |
| |
| /* |
| * DataValueDescriptor interface |
| */ |
| |
| /** @see DataValueDescriptor#cloneValue */ |
| public DataValueDescriptor cloneValue(boolean forceMaterialization) |
| { |
| SQLInteger nsi = new SQLInteger(value); |
| |
| nsi.isnull = isnull; |
| return nsi; |
| } |
| |
| /** |
| * @see DataValueDescriptor#getNewNull |
| */ |
| public DataValueDescriptor getNewNull() |
| { |
| return new SQLInteger(); |
| } |
| |
| /** |
| * @see DataValueDescriptor#setValueFromResultSet |
| * |
| * @exception SQLException Thrown on error |
| */ |
| public void setValueFromResultSet(ResultSet resultSet, int colNumber, |
| boolean isNullable) |
| throws SQLException |
| { |
| if ((value = resultSet.getInt(colNumber)) == 0) |
| isnull = (isNullable && resultSet.wasNull()); |
| else |
| isnull = false; |
| } |
| /** |
| Set the value into a PreparedStatement. |
| |
| @exception SQLException Error setting value in PreparedStatement |
| */ |
| public final void setInto(PreparedStatement ps, int position) throws SQLException { |
| |
| if (isNull()) { |
| ps.setNull(position, java.sql.Types.INTEGER); |
| return; |
| } |
| |
| ps.setInt(position, value); |
| } |
| /** |
| Set this value into a ResultSet for a subsequent ResultSet.insertRow |
| or ResultSet.updateRow. This method will only be called for non-null values. |
| |
| @exception SQLException thrown by the ResultSet object |
| */ |
| public final void setInto(ResultSet rs, int position) throws SQLException { |
| rs.updateInt(position, value); |
| } |
| |
| /* |
| * class interface |
| */ |
| |
| /* |
| * constructors |
| */ |
| |
| /** no-arg constructor, required by Formattable */ |
| // This constructor also gets used when we are |
| // allocating space for an integer. |
| public SQLInteger() |
| { |
| isnull = true; |
| } |
| |
| public SQLInteger(int val) |
| { |
| value = val; |
| } |
| |
| public SQLInteger(char val) |
| { |
| value = val; |
| } |
| |
| public SQLInteger(Integer obj) { |
| if (isnull = (obj == null)) |
| ; |
| else |
| value = obj.intValue(); |
| } |
| |
| /** |
| @exception StandardException thrown if string not accepted |
| */ |
| public void setValue(String theValue) |
| throws StandardException |
| { |
| if (theValue == null) |
| { |
| value = 0; |
| isnull = true; |
| } |
| else |
| { |
| try { |
| value = Integer.parseInt(theValue.trim()); |
| } catch (NumberFormatException nfe) { |
| throw invalidFormat(); |
| } |
| isnull = false; |
| } |
| } |
| |
| public void setValue(int theValue) |
| { |
| value = theValue; |
| isnull = false; |
| } |
| |
| /** |
| @exception StandardException thrown on overflow |
| */ |
| public void setValue(long theValue) throws StandardException |
| { |
| if (theValue > Integer.MAX_VALUE || theValue < Integer.MIN_VALUE) { |
| throw outOfRange(); |
| } |
| |
| value = (int)theValue; |
| isnull = false; |
| } |
| |
| /** |
| * @see NumberDataValue#setValue |
| * |
| * @exception StandardException Thrown on error |
| */ |
| public void setValue(float theValue) throws StandardException |
| { |
| theValue = NumberDataType.normalizeREAL(theValue); |
| |
| if (theValue > Integer.MAX_VALUE || theValue < Integer.MIN_VALUE) |
| throw outOfRange(); |
| |
| float floorValue = (float)Math.floor(theValue); |
| |
| value = (int)floorValue; |
| isnull = false; |
| } |
| |
| /** |
| * @see NumberDataValue#setValue |
| * |
| * @exception StandardException Thrown on error |
| */ |
| public void setValue(double theValue) throws StandardException |
| { |
| theValue = NumberDataType.normalizeDOUBLE(theValue); |
| |
| if (theValue > Integer.MAX_VALUE || theValue < Integer.MIN_VALUE) |
| throw outOfRange(); |
| |
| double floorValue = Math.floor(theValue); |
| |
| value = (int)floorValue; |
| isnull = false; |
| } |
| |
| public void setValue(boolean theValue) |
| { |
| value = theValue?1:0; |
| isnull = false; |
| } |
| |
| protected void setFrom(DataValueDescriptor theValue) throws StandardException { |
| |
| setValue(theValue.getInt()); |
| } |
| |
| /* |
| * DataValueDescriptor interface |
| */ |
| |
| /** @see DataValueDescriptor#typePrecedence */ |
| public int typePrecedence() |
| { |
| return TypeId.INT_PRECEDENCE; |
| } |
| |
| /* |
| ** SQL Operators |
| */ |
| |
| /** |
| * The = operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the = |
| * @param right The value on the right side of the = |
| * |
| * @return A SQL boolean value telling whether the two parameters are equal |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue equals(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() == right.getInt()); |
| } |
| |
| /** |
| * The <> operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the operator |
| * @param right The value on the right side of the operator |
| * |
| * @return A SQL boolean value telling whether the two parameters |
| * are not equal |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue notEquals(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() != right.getInt()); |
| } |
| |
| /** |
| * The < operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the operator |
| * @param right The value on the right side of the operator |
| * |
| * @return A SQL boolean value telling whether the first operand is less |
| * than the second operand |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue lessThan(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() < right.getInt()); |
| } |
| |
| /** |
| * The > operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the operator |
| * @param right The value on the right side of the operator |
| * |
| * @return A SQL boolean value telling whether the first operand is greater |
| * than the second operand |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue greaterThan(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() > right.getInt()); |
| } |
| |
| /** |
| * The <= operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the operator |
| * @param right The value on the right side of the operator |
| * |
| * @return A SQL boolean value telling whether the first operand is less |
| * than or equal to the second operand |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue lessOrEquals(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() <= right.getInt()); |
| } |
| |
| /** |
| * The >= operator as called from the language module, as opposed to |
| * the storage module. |
| * |
| * @param left The value on the left side of the operator |
| * @param right The value on the right side of the operator |
| * |
| * @return A SQL boolean value telling whether the first operand is greater |
| * than or equal to the second operand |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public BooleanDataValue greaterOrEquals(DataValueDescriptor left, |
| DataValueDescriptor right) |
| throws StandardException |
| { |
| return SQLBoolean.truthValue(left, |
| right, |
| left.getInt() >= right.getInt()); |
| } |
| |
| /** |
| * This method implements the * operator for "int * int". |
| * |
| * @param left The first value to be multiplied |
| * @param right The second value to be multiplied |
| * @param result The result of a previous call to this method, null |
| * if not called yet |
| * |
| * @return A SQLInteger containing the result of the multiplication |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public NumberDataValue times(NumberDataValue left, |
| NumberDataValue right, |
| NumberDataValue result) |
| throws StandardException |
| { |
| if (result == null) |
| { |
| result = new SQLInteger(); |
| } |
| |
| if (left.isNull() || right.isNull()) |
| { |
| result.setToNull(); |
| return result; |
| } |
| |
| /* |
| ** Java does not check for overflow with integral types. We have to |
| ** check the result ourselves. |
| ** |
| ** We can't use sign checking tricks like we do for '+' and '-' since |
| ** the product of 2 integers can wrap around multiple times. So, we |
| ** do long arithmetic and then verify that the result is within the |
| ** range of an int, throwing an error if it isn't. |
| */ |
| long tempResult = left.getLong() * right.getLong(); |
| |
| result.setValue(tempResult); |
| return result; |
| } |
| |
| |
| /** |
| mod(int, int) |
| */ |
| public NumberDataValue mod(NumberDataValue dividend, |
| NumberDataValue divisor, |
| NumberDataValue result) |
| throws StandardException { |
| if (result == null) |
| { |
| result = new SQLInteger(); |
| } |
| |
| if (dividend.isNull() || divisor.isNull()) |
| { |
| result.setToNull(); |
| return result; |
| } |
| |
| /* Catch divide by 0 */ |
| int intDivisor = divisor.getInt(); |
| if (intDivisor == 0) |
| { |
| throw StandardException.newException(SQLState.LANG_DIVIDE_BY_ZERO); |
| } |
| |
| result.setValue(dividend.getInt() % intDivisor); |
| return result; |
| } |
| /** |
| * This method implements the unary minus operator for int. |
| * |
| * @param result The result of a previous call to this method, null |
| * if not called yet |
| * |
| * @return A SQLInteger containing the result of the division |
| * |
| * @exception StandardException Thrown on error |
| */ |
| |
| public NumberDataValue minus(NumberDataValue result) |
| throws StandardException |
| { |
| int operandValue; |
| |
| if (result == null) |
| { |
| result = new SQLInteger(); |
| } |
| |
| if (this.isNull()) |
| { |
| result.setToNull(); |
| return result; |
| } |
| |
| operandValue = this.getInt(); |
| |
| /* |
| ** In two's complement arithmetic, the minimum value for a number |
| ** can't be negated, since there is no representation for its |
| ** positive value. For integers, the minimum value is -2147483648, |
| ** and the maximum value is 2147483647. |
| */ |
| if (operandValue == Integer.MIN_VALUE) |
| { |
| throw outOfRange(); |
| } |
| |
| result.setValue(-operandValue); |
| return result; |
| } |
| |
| /** |
| * This method implements the isNegative method. |
| * |
| * @return A boolean. If this.value is negative, return true. |
| * For positive values or null, return false. |
| */ |
| |
| protected boolean isNegative() |
| { |
| return !isNull() && value < 0; |
| } |
| |
| /* |
| * String display of value |
| */ |
| |
| public String toString() |
| { |
| if (isNull()) |
| return "NULL"; |
| else |
| return Integer.toString(value); |
| } |
| |
| /* |
| * Hash code |
| */ |
| public int hashCode() |
| { |
| return value; |
| } |
| |
| /* |
| * useful constants... |
| */ |
| static final int INTEGER_LENGTH = 4; // must match the number of bytes written by DataOutput.writeInt() |
| |
| private static final int BASE_MEMORY_USAGE = ClassSize.estimateBaseFromCatalog( SQLInteger.class); |
| |
| public int estimateMemoryUsage() |
| { |
| return BASE_MEMORY_USAGE; |
| } |
| |
| /* |
| * object state |
| */ |
| private int value; |
| private boolean isnull; |
| } |