org.hsqldb.types

Class BinaryType

java.lang.Object

org.hsqldb.types.Type

org.hsqldb.types.BinaryType

All Implemented Interfaces:

java.lang.Cloneable, SchemaObject

Direct Known Subclasses:

BitType, BlobType

public class BinaryType
extends Type

Type implementation for BINARY, VARBINARY and (part) BLOB.

SQL:2008 Standard specifies silent truncation of zero bytes at the end of the binary strings used for assignment and contatenation.

* A binary string of type BINARY VALYING and BLOB when assigned to a column of similar type but shorter maximum length. The behaviour is similar to trimming of space characters from strings of CHARACTER VARYING and CLOB types.

In most real-world use-cases, all the bytes of variable-length binary values stored in a database are significant and should not be discarded.

HSQLDB follows the Standard completely, despite this inadequecy.

Comparison of binary values follows the Standard. When two values are not the same length and all the bytes of the shorter value equal the initial sequence of bytes of the longer value, then the shorter value is the smaller. The Standard treats this determination as implementation dependent.

BIT types, which were part of the SQL:1999, can be converted to and from BINARY. The BIT strings may be padded with zero bits for byte alignment.

As an extension to the Standard, HSQLDB supports cast from CHARACTER types to BINARY. The length of the string must be even and all character must be hexadecimal characters.

Since:

1.9.0

Nested Class Summary

Nested classes/interfaces inherited from class org.hsqldb.types.Type

Type.TypedComparator

Nested classes/interfaces inherited from interface org.hsqldb.SchemaObject

SchemaObject.ConstraintTypes, SchemaObject.Deferable, SchemaObject.Nullability, SchemaObject.ParameterModes, SchemaObject.ReferentialAction, SchemaObject.ViewCheckModes

Field Summary

Fields

Modifier and Type	Field and Description
static long	maxBinaryPrecision

Fields inherited from class org.hsqldb.types.Type

emptyArray, jdbcConvertTypes, OTHER, precision, scale, SQL_ALL_TYPES, SQL_ARRAY_ALL_TYPES, SQL_BIGINT, SQL_BINARY, SQL_BINARY_16, SQL_BINARY_DEFAULT, SQL_BIT, SQL_BIT_VARYING, SQL_BIT_VARYING_MAX_LENGTH, SQL_BLOB, SQL_BOOLEAN, SQL_CHAR, SQL_CHAR_16, SQL_CHAR_DEFAULT, SQL_CLOB, SQL_DATE, SQL_DECIMAL, SQL_DECIMAL_BIGINT_SQR, SQL_DECIMAL_DEFAULT, SQL_DOUBLE, SQL_INTEGER, SQL_INTERVAL_DAY, SQL_INTERVAL_DAY_MAX_PRECISION, SQL_INTERVAL_DAY_TO_HOUR, SQL_INTERVAL_DAY_TO_MINUTE, SQL_INTERVAL_DAY_TO_SECOND, SQL_INTERVAL_DAY_TO_SECOND_MAX_PRECISION, SQL_INTERVAL_HOUR, SQL_INTERVAL_HOUR_MAX_PRECISION, SQL_INTERVAL_HOUR_TO_MINUTE, SQL_INTERVAL_HOUR_TO_SECOND, SQL_INTERVAL_MINUTE, SQL_INTERVAL_MINUTE_MAX_PRECISION, SQL_INTERVAL_MINUTE_TO_SECOND, SQL_INTERVAL_MONTH, SQL_INTERVAL_MONTH_MAX_PRECISION, SQL_INTERVAL_SECOND, SQL_INTERVAL_SECOND_MAX_FRACTION, SQL_INTERVAL_SECOND_MAX_FRACTION_MAX_PRECISION, SQL_INTERVAL_SECOND_MAX_PRECISION, SQL_INTERVAL_YEAR, SQL_INTERVAL_YEAR_MAX_PRECISION, SQL_INTERVAL_YEAR_TO_MONTH, SQL_INTERVAL_YEAR_TO_MONTH_MAX_PRECISION, SQL_NUMERIC, SQL_SMALLINT, SQL_TIME, SQL_TIME_WITH_TIME_ZONE, SQL_TIMESTAMP, SQL_TIMESTAMP_NO_FRACTION, SQL_TIMESTAMP_WITH_TIME_ZONE, SQL_VARBINARY, SQL_VARBINARY_DEFAULT, SQL_VARCHAR, SQL_VARCHAR_DEFAULT, TINYINT, typeAliases, typeCode, typeComparisonGroup, typeDataGroup, typeNames, userTypeModifier

Fields inherited from interface org.hsqldb.SchemaObject

ASSERTION, CATALOG, CHARSET, COLLATION, COLUMN, CONSTRAINT, CURSOR, DOMAIN, FUNCTION, GRANTEE, INDEX, LABEL, PARAMETER, PROCEDURE, ROUTINE, SCHEMA, SEARCH, SEQUENCE, SERVER, SPECIFIC_ROUTINE, SUBQUERY, TABLE, TRANSITION, TRIGGER, TYPE, VARIABLE, VIEW, WRAPPER

Method Summary

Modifier and Type	Method and Description
boolean	acceptsPrecision()
boolean	canConvertFrom(Type otherType)
int	canMoveFrom(Type otherType) Can convert without changing the object
java.lang.Object	castToType(SessionInterface session, java.lang.Object a, Type otherType) Explicit casts are handled by this method.
int	compare(Session session, java.lang.Object a, java.lang.Object b)
java.lang.Object	concat(Session session, java.lang.Object a, java.lang.Object b)
java.lang.Object	convertJavaToSQL(SessionInterface session, java.lang.Object a)
java.lang.Object	convertSQLToJava(SessionInterface session, java.lang.Object a)
java.lang.Object	convertToDefaultType(SessionInterface session, java.lang.Object a) Converts the object to the given type without limit checks.
java.lang.String	convertToSQLString(java.lang.Object a)
java.lang.String	convertToString(java.lang.Object a)
java.lang.Object	convertToType(SessionInterface session, java.lang.Object a, Type otherType) Same as castToType except for CHARACTER values.
java.lang.Object	convertToTypeLimits(SessionInterface session, java.lang.Object a)
int	displaySize()
Type	getAggregateType(Type other) Common type used in comparison opertions.
static BinaryType	getBinaryType(int type, long precision)
Type	getCombinedType(Session session, Type other, int operation) Returns type for concat
java.lang.String	getDefinition() Returns the full definition of the type, including parameters
java.lang.Class	getJDBCClass()
java.lang.String	getJDBCClassName() Returns the JDBC class name of type, if it exists, otherwise the HSQLDB class name.
int	getJDBCTypeCode() Returns the JDBC type number of type, if it exists, otherwise the HSQLDB / SQL type.
long	getMaxPrecision()
java.lang.String	getNameFullString()
java.lang.String	getNameString() Returns the name of the type
boolean	isBinaryType()
BlobData	overlay(Session session, BlobData data, BlobData overlay, long offset, long length, boolean hasLength)
long	position(SessionInterface session, BlobData data, BlobData otherData, Type otherType, long offset)
int	precedenceDegree(Type other) relaxes the SQL standard list to avoid problems with covnersion of literals and java method parameter type issues
boolean	requiresPrecision()
BlobData	substring(SessionInterface session, BlobData data, long offset, long length, boolean hasLength)
BlobData	trim(Session session, BlobData data, int trim, boolean leading, boolean trailing)

Methods inherited from class org.hsqldb.types.Type

absolute, acceptsFractionalPrecision, acceptsScale, add, arrayLimitCardinality, canBeAssignedFrom, cardinality, collectionBaseType, compare, compare, compareToTypeRange, compile, convertToTypeJDBC, divide, duplicate, equals, getAggregateType, getCatalogName, getChangeTimestamp, getCharacterSet, getCollation, getComponents, getDefaultArrayType, getDefaultType, getDefaultTypeWithSize, getFullNameString, getHSQLDBTypeCode, getJDBCPrecision, getJDBCScale, getJDBCTypeCode, getMaxScale, getName, getOwner, getPrecisionRadix, getReferences, getSchemaName, getSQL, getSQLGenericTypeCode, getType, getType, getType, getTypeDefinition, getTypeForJDBCConvertToken, getTypeNr, hashCode, isArrayType, isBitType, isBooleanType, isCharacterType, isDateOrTimestampType, isDateTimeType, isDateTimeTypeWithZone, isDecimalType, isDistinctType, isDomainType, isExactNumberType, isIntegralType, isIntervalType, isLobType, isMultisetType, isNumberType, isObjectType, isRowType, isStructuredType, isSupportedSQLType, matches, multiply, negate, newComparator, subtract

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

maxBinaryPrecision

public static final long maxBinaryPrecision

See Also:

Constant Field Values

Method Detail

displaySize

public int displaySize()

Specified by:

displaySize in class Type

getJDBCTypeCode

public int getJDBCTypeCode()

Description copied from class: Type

Returns the JDBC type number of type, if it exists, otherwise the HSQLDB / SQL type.

Specified by:

getJDBCTypeCode in class Type

getJDBCClass

public java.lang.Class getJDBCClass()

Specified by:

getJDBCClass in class Type

getJDBCClassName

public java.lang.String getJDBCClassName()

Description copied from class: Type

Returns the JDBC class name of type, if it exists, otherwise the HSQLDB class name.

Specified by:

getJDBCClassName in class Type

getNameString

public java.lang.String getNameString()

Description copied from class: Type

Returns the name of the type

Specified by:

getNameString in class Type

getNameFullString

public java.lang.String getNameFullString()

getDefinition

public java.lang.String getDefinition()

Description copied from class: Type

Returns the full definition of the type, including parameters

Specified by:

getDefinition in class Type

isBinaryType

public boolean isBinaryType()

Overrides:

isBinaryType in class Type

acceptsPrecision

public boolean acceptsPrecision()

Overrides:

acceptsPrecision in class Type

getMaxPrecision

public long getMaxPrecision()

Overrides:

getMaxPrecision in class Type

requiresPrecision

public boolean requiresPrecision()

Overrides:

requiresPrecision in class Type

precedenceDegree

public int precedenceDegree(Type other)

relaxes the SQL standard list to avoid problems with covnersion of literals and java method parameter type issues

Overrides:

precedenceDegree in class Type

getAggregateType

public Type getAggregateType(Type other)

Description copied from class: Type

Common type used in comparison opertions. other must be comparable with this.

Specified by:

getAggregateType in class Type

getCombinedType

public Type getCombinedType(Session session,
                            Type other,
                            int operation)

Returns type for concat

Specified by:

getCombinedType in class Type

compare

public int compare(Session session,
                   java.lang.Object a,
                   java.lang.Object b)

Specified by:

compare in class Type

convertToTypeLimits

public java.lang.Object convertToTypeLimits(SessionInterface session,
                                            java.lang.Object a)

Specified by:

convertToTypeLimits in class Type

castToType

public java.lang.Object castToType(SessionInterface session,
                                   java.lang.Object a,
                                   Type otherType)

Description copied from class: Type

Explicit casts are handled by this method. SQL standard 6.12 rules for enforcement of size, precision and scale are implemented. For CHARACTER values, it performs truncation in all cases of long strings.

Overrides:

castToType in class Type

convertToType

public java.lang.Object convertToType(SessionInterface session,
                                      java.lang.Object a,
                                      Type otherType)

Description copied from class: Type

Same as castToType except for CHARACTER values. Perform string truncation of trailing spaces only. For other long strings, it raises an exception.

Specified by:

convertToType in class Type

convertJavaToSQL

public java.lang.Object convertJavaToSQL(SessionInterface session,
                                         java.lang.Object a)

Overrides:

convertJavaToSQL in class Type

convertSQLToJava

public java.lang.Object convertSQLToJava(SessionInterface session,
                                         java.lang.Object a)

Overrides:

convertSQLToJava in class Type

convertToDefaultType

public java.lang.Object convertToDefaultType(SessionInterface session,
                                             java.lang.Object a)

Description copied from class: Type

Converts the object to the given type without limit checks. Used for JDBC writes.

Specified by:

convertToDefaultType in class Type

convertToString

public java.lang.String convertToString(java.lang.Object a)

Specified by:

convertToString in class Type

convertToSQLString

public java.lang.String convertToSQLString(java.lang.Object a)

Specified by:

convertToSQLString in class Type

canConvertFrom

public boolean canConvertFrom(Type otherType)

Specified by:

canConvertFrom in class Type

canMoveFrom

public int canMoveFrom(Type otherType)

Description copied from class: Type

Can convert without changing the object

Overrides:

canMoveFrom in class Type

Returns:

0 always, 1 range check required, -1 never

position

public long position(SessionInterface session,
                     BlobData data,
                     BlobData otherData,
                     Type otherType,
                     long offset)

substring

public BlobData substring(SessionInterface session,
                          BlobData data,
                          long offset,
                          long length,
                          boolean hasLength)

trim

public BlobData trim(Session session,
                     BlobData data,
                     int trim,
                     boolean leading,
                     boolean trailing)

overlay

public BlobData overlay(Session session,
                        BlobData data,
                        BlobData overlay,
                        long offset,
                        long length,
                        boolean hasLength)

concat

public java.lang.Object concat(Session session,
                               java.lang.Object a,
                               java.lang.Object b)

Overrides:

concat in class Type

getBinaryType

public static BinaryType getBinaryType(int type,
                                       long precision)