org.hsqldb.types

Class BitType

java.lang.Object

org.hsqldb.types.Type

org.hsqldb.types.BinaryType

org.hsqldb.types.BitType

All Implemented Interfaces:

java.lang.Cloneable, SchemaObject

public final class BitType
extends BinaryType

Operations allowed on BIT strings are CONCAT, SUBSTRING, POSITION, BIT_LENGTH and OCTECT_LENGTH.

BIT values can be cast to BINARY and vice-versa. In casts, BIT values are converted to their counterpart BINARY values by treating each set of 8 bits or less as a signle byte. The first bit of a BIT string is treated as the most significan bit of the resutling byte value. Binary values are converted by treating the bits in the sequence of bytes as sequence of bits in the BIT string

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 inherited from class org.hsqldb.types.BinaryType

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

Constructor Summary

Constructors

Constructor and Description
BitType(int type, long precision)

Method Summary

Modifier and Type	Method and Description
boolean	canConvertFrom(Type otherType)
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	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	getBitType(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	getNameString() Returns the name of the type
int	getSQLGenericTypeCode() Returns the generic SQL CLI type number of type, if it exists, otherwise the HSQLDB type.
boolean	isBitType()
BlobData	overlay(Session session, BlobData value, BlobData overlay, long offset, long length, boolean hasLength)
long	position(SessionInterface session, BlobData data, BlobData otherData, Type otherType, long offset)
boolean	requiresPrecision()
BlobData	substring(SessionInterface session, BlobData data, long offset, long length, boolean hasLength)

Methods inherited from class org.hsqldb.types.BinaryType

acceptsPrecision, canMoveFrom, convertSQLToJava, getBinaryType, getNameFullString, isBinaryType, precedenceDegree, trim

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, getType, getType, getType, getTypeDefinition, getTypeForJDBCConvertToken, getTypeNr, hashCode, isArrayType, 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

Constructor Detail

BitType

public BitType(int type,
               long precision)

Method Detail

displaySize

public int displaySize()

Overrides:

displaySize in class BinaryType

getJDBCTypeCode

public int getJDBCTypeCode()

Description copied from class: Type

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

Overrides:

getJDBCTypeCode in class BinaryType

getJDBCClass

public java.lang.Class getJDBCClass()

Overrides:

getJDBCClass in class BinaryType

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.

Overrides:

getJDBCClassName in class BinaryType

getSQLGenericTypeCode

public int getSQLGenericTypeCode()

Description copied from class: Type

Returns the generic SQL CLI type number of type, if it exists, otherwise the HSQLDB type. The generic type is returned for DATETIME and INTERVAL types.

Overrides:

getSQLGenericTypeCode in class Type

getNameString

public java.lang.String getNameString()

Description copied from class: Type

Returns the name of the type

Overrides:

getNameString in class BinaryType

getDefinition

public java.lang.String getDefinition()

Description copied from class: Type

Returns the full definition of the type, including parameters

Overrides:

getDefinition in class BinaryType

isBitType

public boolean isBitType()

Overrides:

isBitType in class Type

getMaxPrecision

public long getMaxPrecision()

Overrides:

getMaxPrecision in class BinaryType

requiresPrecision

public boolean requiresPrecision()

Overrides:

requiresPrecision in class BinaryType

getAggregateType

public Type getAggregateType(Type other)

Description copied from class: Type

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

Overrides:

getAggregateType in class BinaryType

getCombinedType

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

Returns type for concat

Overrides:

getCombinedType in class BinaryType

compare

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

Overrides:

compare in class BinaryType

convertToTypeLimits

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

Overrides:

convertToTypeLimits in class BinaryType

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 BinaryType

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.

Overrides:

convertToType in class BinaryType

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.

Overrides:

convertToDefaultType in class BinaryType

convertJavaToSQL

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

Overrides:

convertJavaToSQL in class BinaryType

convertToString

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

Overrides:

convertToString in class BinaryType

convertToSQLString

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

Overrides:

convertToSQLString in class BinaryType

canConvertFrom

public boolean canConvertFrom(Type otherType)

Overrides:

canConvertFrom in class BinaryType

position

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

Overrides:

position in class BinaryType

substring

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

Overrides:

substring in class BinaryType

overlay

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

Overrides:

overlay in class BinaryType

concat

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

Overrides:

concat in class BinaryType

getBitType

public static BinaryType getBitType(int type,
                                    long precision)