Int64Type.java
/*
** Module : Int64Type.java
** Abstract : Handles conversion from/to SQL/FWD big integer type.
**
** Copyright (c) 2019-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 OM 20191101 Created initial version.
** 002 ECF 20200919 Performance: use ResultSet.wasNull only if ResultSet.getLong returns ambiguous default
** value, which might represent SQL NULL.
** OM 20221117 Some properties (datetime-tz) may take a different number of positional parameters when
** used in insert/update or where predicate.
** 003 TJD 20240123 Java 17 compatibility updates
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.persist.orm.types;
import com.goldencode.p2j.persist.Record;
import com.goldencode.p2j.persist.orm.*;
import com.goldencode.p2j.util.*;
import java.sql.*;
/** This object handles conversion from/to SQL/FWD {@code int64} type. */
public class Int64Type
implements DataHandler
{
/**
* Creates and returns a new {@link int64} from a SQL counterpart.
*
* @param sqlVal
* A value obtained from a SQL query, which needs to be converted to a
* {@code BaseDataType}.
*
* @return A FWD {@code int64} object representing the same value as {@code sqlVal}.
*/
@Override
public int64 convert(Object sqlVal)
{
return new int64((Long) sqlVal);
}
/**
* Use the data from an {@link int64} field stored in {@code BaseRecord.data} and use it
* to initialize a parameter of type bigint/long in a SQL prepared query.
*
* @param stmt
* The prepared statement whose parameter is to be set.
* @param index
* The index/position of the parameter.
* @param val
* The value of the parameter. Must be a {@code int64}.
* @param forUpdate
* {@code true} if the parameter in the statement is used to update a field and {@code false} if
* it is used as part of the where predicate. Ignored here.
*
* @return 1 (the number of position used by this value).
*
* @throws SQLException
* when an error is encountered while setting the value.
*/
@Override
public int setParameter(PreparedStatement stmt, int index, Object val, boolean forUpdate)
throws SQLException
{
return TypeManager.setLongParameter(stmt, index, val, forUpdate);
}
/**
* Reads data from one or more positions from the {@code ResultSet}, eventually converting it
* to a proper type and storing the result directly to the {@code Record}'s data structure.
*
* @param rs
* The {@code ResultSet} to read from.
* @param rsOffset
* The index/position in current row of {@code rs} to start reading.
* @param data
* The destination. Ie. the record's {@code data} field member.
* @param propIndex
* The destination offset. Ie. the property index.
*
* @return always 1.
*
* @throws SQLException
* when an error is encountered while setting the value.
*/
@Override
public int readProperty(ResultSet rs, int rsOffset, Object[] data, int propIndex)
throws SQLException
{
long datum = rs.getLong(rsOffset);
data[propIndex] = datum == 0L && rs.wasNull() ? null : datum;
return 1;
}
/**
* Instantiate a low-level initial value suitable for storage in a {@link BaseRecord}'s data
* array, parsed from a string representation.
*
* @param text
* String representation of the initial value.
* @param meta
* Property metadata.
*/
@Override
public Object initialValue(String text, PropertyMeta meta)
{
return new int64(text).toJavaLongType();
}
/**
* Compute the size in bytes taken by a specified value for the data type handled by this
* class. The returned value is used to compute the index size.
*
* @param value
* The value to be computed the size.
*
* @return the number of bytes the {@code val} object occupies.
*/
@Override
public int getFieldSizeInIndex(Object value)
{
if (value == null)
{
return 3;
}
long val = (value instanceof Long) ? (long) value : (int) value;
if (-16 <= val && val <= 15)
{ // FFFF FF90 ... 0000 000F
return 2;
}
else if (-1022 <= val && val <= 1022)
{ // FFFF FC02 ... 0000 03FE
return 3;
}
else if (-65022 <= val && val <= 65278)
{ // FFFF 0202 ... 0000 FEFE
// 65279 (FEFF) uses 5
// however, I found out that 123456 uses only 4 bytes !
// 1048318 (0F FEFE) uses 4, BUT 1048319 (0F FEFF) uses 5
return 4;
}
else if (-15999998 <= val && val <= 16711422)
{ // FF0B DC02 ... 00FE FEFE
return 5;
}
else if (-2130574846 <= val && val <= 2130640638)
{ // 8102 0202 ... 7EFE FEFE
return 6;
}
// other 4 exceptions, detected empirically:
if (val == 2147483646 || val == -2147483646)
{
return 8;
}
else if (val == 2147483647 || val == -2147483648 )
{
return 9;
}
// keep processing until all the 8-bytes int64 are covered
if (-545427160574L <= val && val <= 1095199817470L)
{ // FFFF FF81 0202 0202 ... 0000 00FE FEFE FEFE
return 7;
}
else if (-139629353106942L <= val && val <= 280371153272574L)
{ // FFFF 8102 0202 0202 ... 0000 FEFE FEFE FEFE
return 8;
}
else if (-35745114395377150L <= val && val <= 71775015237779198L)
{ // FF81 0202 0202 0202 ... 00FE FEFE FEFE FEFE
return 9;
}
else if (-9150749285216550398L <= val && val <= 9151031864016699134L)
{ // 8102 0202 0202 0202 ... 7EFE FEFE FEFE FEFE
return 10;
}
// larger index-keys use 11 bytes
return 11;
}
/**
* Sets a value of a property in a {@code Record}. The specified value is converted from
* {@code BaseDataType} FWD standard to plain Java, as the {@code data} array expects before
* assigning the value to right offset.
*
* @param data
* The {@code data} array of the record to be altered.
* @param val
* The {@code BaseDataType} value to be set. Assumed to be a {@code datetime}.
* @param offset
* The offset of the property, ie, the entry in {@code data} array. This includes both
* base property offset and the eventual extent index.
* @param meta
* Property metadata. Used to fine-tune stored data.
*/
@Override
public void setField(Object[] data, BaseDataType val, int offset, PropertyMeta meta)
{
if (val == null || val.isUnknown())
{
data[offset] = null;
return;
}
int64 asBDT = (int64) val;
data[offset] = asBDT.toJavaLongType();
}
/**
* Obtain the value of the property of a {@code Record} located at a specified offset in {@code data}
* array. It assumes the data at specified offset is compatible with this data handler.
*
* @param r
* The {@code Record}.
* @param offset
* The offset.
*
* @return The value requested wrapped as a {@code BaseDataType}.
*/
@Override
public BaseDataType getField(Record r, int offset)
{
return r._getInt64(offset);
}
}