org.hsqldb.types

Class CharacterType

java.lang.Object

org.hsqldb.types.Type

org.hsqldb.types.CharacterType

All Implemented Interfaces:

java.lang.Cloneable, SchemaObject

Direct Known Subclasses:

ClobType

public class CharacterType
extends Type

Type subclass for CHARACTER, VARCHAR, etc.

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	maxCharPrecision

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
CharacterType(Collation collation, int type, long precision)
CharacterType(int type, long precision) Always ASCII collation

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	castOrConvertToType(SessionInterface session, java.lang.Object a, Type otherType, boolean cast)
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)
int	compare(Session session, java.lang.Object a, java.lang.Object b, int opType)
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) Relaxes SQL parameter type enforcement, allowing long strings.
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	convertToTypeJDBC(SessionInterface session, java.lang.Object a, Type otherType) Convert type for JDBC reads.
java.lang.Object	convertToTypeLimits(SessionInterface session, java.lang.Object a)
int	displaySize()
Type	getAggregateType(Type other) Common type used in comparison opertions.
Charset	getCharacterSet()
static CharacterType	getCharacterType(int type, long length)
static CharacterType	getCharacterType(int type, long length, Collation collation)
Type	getCharacterType(long length)
Collation	getCollation()
Type	getCombinedType(Session session, Type other, int operation) For concatenation
java.lang.String	getDefinition() Returns the full definition of the type, including parameters
java.lang.String	getFullNameString() Returns the name of the type
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
static int	getRightTrimSise(java.lang.String s, char trim)
int	getSQLGenericTypeCode() Returns the generic SQL CLI type number of type, if it exists, otherwise the HSQLDB type.
boolean	isCharacterType()
java.lang.Object	lower(Session session, java.lang.Object data)
java.lang.Boolean	match(Session session, java.lang.String string, java.lang.String[] array) Matches the string against array containing part strings.
java.lang.Object	overlay(SessionInterface session, java.lang.Object data, java.lang.Object overlay, long offset, long length, boolean hasLength)
long	position(SessionInterface session, java.lang.Object data, java.lang.Object otherData, Type otherType, long offset)
int	precedenceDegree(Type other)
boolean	requiresPrecision()
long	size(SessionInterface session, java.lang.Object data)
java.lang.Object	substring(SessionInterface session, java.lang.Object data, long offset, long length, boolean hasLength, boolean trailing)
java.lang.Object	trim(SessionInterface session, java.lang.Object data, char trim, boolean leading, boolean trailing)
java.lang.Object	upper(Session session, java.lang.Object data) Memory limits apply to Upper and Lower implementations with Clob data

Methods inherited from class org.hsqldb.types.Type

absolute, acceptsFractionalPrecision, acceptsScale, add, arrayLimitCardinality, canBeAssignedFrom, cardinality, collectionBaseType, compare, compareToTypeRange, compile, convertSQLToJava, divide, duplicate, equals, getAggregateType, getCatalogName, getChangeTimestamp, getComponents, getDefaultArrayType, getDefaultType, getDefaultTypeWithSize, getHSQLDBTypeCode, getJDBCPrecision, getJDBCScale, getJDBCTypeCode, getMaxScale, getName, getOwner, getPrecisionRadix, getReferences, getSchemaName, getSQL, getType, getType, getType, getTypeDefinition, getTypeForJDBCConvertToken, getTypeNr, hashCode, isArrayType, isBinaryType, isBitType, isBooleanType, 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

maxCharPrecision

public static final long maxCharPrecision

See Also:

Constant Field Values

Constructor Detail

CharacterType

public CharacterType(Collation collation,
                     int type,
                     long precision)

CharacterType

public CharacterType(int type,
                     long precision)

Always ASCII collation

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

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

Specified by:

getNameString in class Type

getFullNameString

public java.lang.String getFullNameString()

Description copied from class: Type

Returns the name of the type

Overrides:

getFullNameString in class Type

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

isCharacterType

public boolean isCharacterType()

Overrides:

isCharacterType in class Type

getMaxPrecision

public long getMaxPrecision()

Overrides:

getMaxPrecision in class Type

acceptsPrecision

public boolean acceptsPrecision()

Overrides:

acceptsPrecision in class Type

requiresPrecision

public boolean requiresPrecision()

Overrides:

requiresPrecision in class Type

precedenceDegree

public int precedenceDegree(Type other)

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)

For concatenation

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

compare

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

Overrides:

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

castOrConvertToType

public java.lang.Object castOrConvertToType(SessionInterface session,
                                            java.lang.Object a,
                                            Type otherType,
                                            boolean cast)

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

convertToTypeJDBC

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

Description copied from class: Type

Convert type for JDBC reads. Same as convertToType, but supports non-standard SQL conversions supported by JDBC

Overrides:

convertToTypeJDBC in class Type

convertToDefaultType

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

Relaxes SQL parameter type enforcement, allowing long strings.

Specified by:

convertToDefaultType in class Type

convertJavaToSQL

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

Overrides:

convertJavaToSQL 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

getCollation

public Collation getCollation()

Overrides:

getCollation in class Type

getCharacterSet

public Charset getCharacterSet()

Overrides:

getCharacterSet in class Type

position

public long position(SessionInterface session,
                     java.lang.Object data,
                     java.lang.Object otherData,
                     Type otherType,
                     long offset)

substring

public java.lang.Object substring(SessionInterface session,
                                  java.lang.Object data,
                                  long offset,
                                  long length,
                                  boolean hasLength,
                                  boolean trailing)

upper

public java.lang.Object upper(Session session,
                              java.lang.Object data)

Memory limits apply to Upper and Lower implementations with Clob data

lower

public java.lang.Object lower(Session session,
                              java.lang.Object data)

trim

public java.lang.Object trim(SessionInterface session,
                             java.lang.Object data,
                             char trim,
                             boolean leading,
                             boolean trailing)

overlay

public java.lang.Object overlay(SessionInterface session,
                                java.lang.Object data,
                                java.lang.Object 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

size

public long size(SessionInterface session,
                 java.lang.Object data)

match

public java.lang.Boolean match(Session session,
                               java.lang.String string,
                               java.lang.String[] array)

Matches the string against array containing part strings. Null element in array indicates skip one character. Empty string in array indicates skip any number of characters.

getCharacterType

public Type getCharacterType(long length)

getRightTrimSise

public static int getRightTrimSise(java.lang.String s,
                                   char trim)

getCharacterType

public static CharacterType getCharacterType(int type,
                                             long length)

getCharacterType

public static CharacterType getCharacterType(int type,
                                             long length,
                                             Collation collation)