| java.lang.Object
 org.hsqldb.DITypeInfo
| DITypeInfo | | final class DITypeInfo (Code) | | Provides information intrinsic to each standard data type known to
HSQLDB. This includes all types for which standard type codes are known
at the time of writing and thus includes types that may not yet be
supported as table or procedure columns.
author:
boucherb@users
version:
1.8.0
since:
1.7.2 |
| Constructor Summary | |
| | DITypeInfo()
Creates a new DITypeInfo object having the default Locale. |
| Method Summary | |
| Integer | getCharOctLen()
Retrieves the maximum Integer.MAX_VALUE bounded length, in bytes, for
character types. | | Long | getCharOctLenAct()
Retrieves the maximum Long.MAX_VALUE bounded length, in bytes, for
character types. | | String | getColStClsName()
Retrieves the fully-qualified name of the Java class whose instances
are manufactured by HSQLDB to store table column values in
memory. | | String | getCreateParams()
Retrieves a character sequence representing a CSV list, in
DDL declaraion order, of the create parameters for the type. | | String | getCstMapClsName()
Retrieves the fully-qualified name of the HSQLDB-provided java.sql
interface implementation class whose instances would be manufactured
by HSQLDB to retrieve column values of this type, if the
the type does not have a standard Java mapping. | | Integer | getDataType()
Retrieves the data type, as an Integer. | | Integer | getDataTypeSub()
Retrieves the data subtype, as an Integer. | | Integer | getDefaultScale()
Retrieves the implied or single permitted scale for exact numeric
types, when no scale is declared or no scale declaration is
permitted. | | Integer | getIntervalPrecision()
Retrieves null (not implemented). | | String | getLiteralPrefix()
Retrieves the character(s) prefixing a literal of this type. | | String | getLiteralSuffix()
Retrieves the character(s) terminating a literal of this type. | | String | getLocalName()
Retrieves a localized representation of the type's name, for human
consumption only. | | int | getMaxDisplaySize()
Retrieves the maximum length that a String representation of
the type may have. | | Integer | getMaxScale()
Retrieves the maximum Short.MAX_VALUE bounded scale supported
for the type. | | Integer | getMaxScaleAct()
Retrieves the maximum Integer.MAX_VALUE bounded scale supported for
the type. | | Integer | getMinScale()
Retrieves the minumum Short.MIN_VALUE bounded scale supported for
the type. | | Integer | getMinScaleAct()
Retrieves the minumum Integer.MIN_VALUE bounded scale supported
for the type. | | Integer | getNullability()
Retrieves the DatabaseMetaData default nullability code for
the type. | | Integer | getNumPrecRadix()
Retrieves the number base which is to be used to interpret the value
reported by getPrecision(). | | Integer | getPrecision()
Retrieves the maximum Integer.MAX_VALUE bounded length or precision for
the type. | | Long | getPrecisionAct()
Retrieves the maximum Long.MAX_VALUE bounded length or precision for
the type. | | String | getRemarks()
Retrieves the localized remarks (if any) on the type. | | Integer | getSearchability()
Retrieves the DatabaseMetaData searchability code for the type. | | Integer | getSqlDataType()
Retrieves the SQL CLI data type code for the type. | | Integer | getSqlDateTimeSub()
Retrieves the SQL CLI datetime subcode for the type. | | String | getStdMapClsName()
Retrieve the fully qualified name of the recommended standard Java
primitive, class or java.sql interface mapping for the type. | | int | getTypeCode()
Retrieves the data type as an int. | | String | getTypeName()
Retrieves the canonical data type name HSQLDB associates with
the type. | | int | getTypeSub()
Retrieves the HSQLDB data subtype as an int. | | Boolean | isAutoIncrement()
Retrieves whether the type can be an IDENTITY type. | | Boolean | isCaseSensitive()
Retrieves whether the type is case-sensitive in collations and
comparisons. | | Boolean | isColStClsSupported()
Retrieves whether, under the current release, class path and hosting
JVM, HSQLDB supports storing this type in table columns. | | Boolean | isFixedPrecisionScale()
Retrieves whether values of this type have a fixed precision and
scale. | | Boolean | isStdMapClsSupported()
Retrieve whether the fully qualified name reported by getStdMapClsName()
is supported as a jdbcResultSet.getXXX return type under the current
HSQLDB release, class path and hosting JVM. | | Boolean | isSupportedAsPCol()
Retrieves whether, under the current release, class path and
hosting JVM, HSQLDB supports passing or receiving this type as
the value of a procedure column. | | Boolean | isSupportedAsTCol()
Retrieves whether, under the current release, class path and
hosting JVM, HSQLDB supports this as the type of a table
column. | | Boolean | isUnsignedAttribute()
Retrieves whether values of this type are unsigned. | | void | setLocale(Locale l)
Assigns the Locale object used to retrieve this object's
resource bundle dependent values. | | void | setTypeCode(int type)
Assigns the SQL data type code on which this object is to report. | | void | setTypeSub(int typeSub)
Assigns the HSQLDB data subtype code on which this object is
to report. |
| columnNoNulls | | final static int columnNoNulls(Code) | | |
| columnNullable | | final static int columnNullable(Code) | | |
| locale_set | | boolean locale_set(Code) | | |
| typePredBasic | | final static int typePredBasic(Code) | | |
| typePredChar | | final static int typePredChar(Code) | | |
| typePredNone | | final static int typePredNone(Code) | | |
| typeSearchable | | final static int typeSearchable(Code) | | |
| DITypeInfo | | DITypeInfo()(Code) | | Creates a new DITypeInfo object having the default Locale.
|
| getCharOctLen | | Integer getCharOctLen()(Code) | | Retrieves the maximum Integer.MAX_VALUE bounded length, in bytes, for
character types.
the maximum Integer.MAX_VALUE bounded length, inbytes, for character types |
| getCharOctLenAct | | Long getCharOctLenAct()(Code) | | Retrieves the maximum Long.MAX_VALUE bounded length, in bytes, for
character types.
the maximum Long.MAX_VALUE bounded length, inbytes, for character types |
| getColStClsName | | String getColStClsName()(Code) | | Retrieves the fully-qualified name of the Java class whose instances
are manufactured by HSQLDB to store table column values in
memory.
This is also typically the fully-qualified name of the Java class whose
instances are manufactured by HSQLDB in response to
jdbcResultSet.getObject(int).
the fully-qualified name of the Java class whoseinstances are manufactured by HSQLDB to storetable column values in memory |
| getCreateParams | | String getCreateParams()(Code) | | Retrieves a character sequence representing a CSV list, in
DDL declaraion order, of the create parameters for the type.
a character sequence representing a CSVlist, in DDL declaraion order, of the createparameters for the type. |
| getCstMapClsName | | String getCstMapClsName()(Code) | | Retrieves the fully-qualified name of the HSQLDB-provided java.sql
interface implementation class whose instances would be manufactured
by HSQLDB to retrieve column values of this type, if the
the type does not have a standard Java mapping.
This value is simply the expected class name, regardless of whether
HSQLDB, the specific HSQLDB distribution instance or the hosting JVM
actually provide or support such implementations. That is, as of a
specific release, HSQLDB may not yet provide such an implementation
or may not automatically map to it or may not support it as a table
column type, the version of java.sql may not define the interface to
implement and the HSQLDB jar may not contain the implementation
classes, even if they are defined in the corresponding release
and build options and are supported under the hosting JVM's java.sql
version.
the fully-qualified name of the HSQLDB-provided java.sqlinterface implementation class whose instances wouldbe manufactured by HSQLDB to retrieve column values ofthis type, given that the type does not have a standard Javamapping and regardless of whether a class with the indicatedname is actually implemented or available on the class path |
| getDataType | | Integer getDataType()(Code) | | Retrieves the data type, as an Integer.
the data type, as an Integer. |
| getDataTypeSub | | Integer getDataTypeSub()(Code) | | Retrieves the data subtype, as an Integer.
the data subtype, as an Integer |
| getDefaultScale | | Integer getDefaultScale()(Code) | | Retrieves the implied or single permitted scale for exact numeric
types, when no scale is declared or no scale declaration is
permitted.
the implied or single permitted scale for exact numerictypes, when no scale is declared or no scale declarationis permitted |
| getIntervalPrecision | | Integer getIntervalPrecision()(Code) | | Retrieves null (not implemented).
null (not implemented) |
| getLiteralPrefix | | String getLiteralPrefix()(Code) | | Retrieves the character(s) prefixing a literal of this type.
the character(s) prefixing a literal of this type. |
| getLiteralSuffix | | String getLiteralSuffix()(Code) | | Retrieves the character(s) terminating a literal of this type.
the character(s) terminating a literal of this type |
| getLocalName | | String getLocalName()(Code) | | Retrieves a localized representation of the type's name, for human
consumption only.
a localized representation of the type's name |
| getMaxDisplaySize | | int getMaxDisplaySize()(Code) | | Retrieves the maximum length that a String representation of
the type may have.
The calculation follows these rules:
- Long character and datetime types:
The maximum length/precision, repectively.
- CHAR and VARCHAR types:
The value of the system property hsqldb.max_xxxchar_display_size
or the magic value 32766 (0x7FFE) (tested usable/accepted by most
tools and compatible with assumptions made by java.io read/write
UTF) when the system property is not defined or is not accessible,
due to security constraints.
- Number types:
The max precision, plus the length of the negation character (1),
plus (if applicable) the maximum number of characters that may
occupy the exponent character sequence.
- BOOLEAN/BIT types:
The length of the character sequence "false" (5), the longer of the
two boolean value String representations.
- All remaining types:
The result of whatever calculation must be performed to determine
the maximum length of the type's String representation. If the
maximum display size is unknown, unknowable or inapplicable, then
zero is returned.
the maximum length that a String representation ofthe type may have, or zero (0) if unknown or unknowable |
| getMaxScale | | Integer getMaxScale()(Code) | | Retrieves the maximum Short.MAX_VALUE bounded scale supported
for the type.
the maximum Short.MAX_VALUE bounded scale supportedfor the type |
| getMaxScaleAct | | Integer getMaxScaleAct()(Code) | | Retrieves the maximum Integer.MAX_VALUE bounded scale supported for
the type.
the maximum Integer.MAX_VALUE bounded scale supportedfor the type |
| getMinScale | | Integer getMinScale()(Code) | | Retrieves the minumum Short.MIN_VALUE bounded scale supported for
the type.
the minumum Short.MIN_VALUE bounded scalesupported for the type |
| getMinScaleAct | | Integer getMinScaleAct()(Code) | | Retrieves the minumum Integer.MIN_VALUE bounded scale supported
for the type.
the minumum Integer.MIN_VALUE bounded scale supportedfor the type |
| getNullability | | Integer getNullability()(Code) | | Retrieves the DatabaseMetaData default nullability code for
the type.
the DatabaseMetaData nullability code for the type. |
| getNumPrecRadix | | Integer getNumPrecRadix()(Code) | | Retrieves the number base which is to be used to interpret the value
reported by getPrecision().
the number base which is to be used to interpret thevalue reported by getPrecision() |
| getPrecision | | Integer getPrecision()(Code) | | Retrieves the maximum Integer.MAX_VALUE bounded length or precision for
the type.
the maximum Integer.MAX_VALUE bounded length orprecision for the type |
| getPrecisionAct | | Long getPrecisionAct()(Code) | | Retrieves the maximum Long.MAX_VALUE bounded length or precision for
the type.
the maximum Long.MAX_VALUE bounded length orprecision for the type |
| getRemarks | | String getRemarks()(Code) | | Retrieves the localized remarks (if any) on the type.
the localized remarks on the type. |
| getSearchability | | Integer getSearchability()(Code) | | Retrieves the DatabaseMetaData searchability code for the type.
the DatabaseMetaData searchability code for the type |
| getSqlDataType | | Integer getSqlDataType()(Code) | | Retrieves the SQL CLI data type code for the type.
the SQL CLI data type code for the type |
| getSqlDateTimeSub | | Integer getSqlDateTimeSub()(Code) | | Retrieves the SQL CLI datetime subcode for the type.
the SQL CLI datetime subcode for the type |
| getStdMapClsName | | String getStdMapClsName()(Code) | | Retrieve the fully qualified name of the recommended standard Java
primitive, class or java.sql interface mapping for the type.
the fully qualified name of the recommended standard Javaprimitive, class or java.sql interface mapping forthe type |
| getTypeCode | | int getTypeCode()(Code) | | Retrieves the data type as an int.
the data type as an int |
| getTypeName | | String getTypeName()(Code) | | Retrieves the canonical data type name HSQLDB associates with
the type.
This typically matches the designated JDBC name, with one or
two exceptions.
the canonical data type name HSQLDB associates with the type |
| getTypeSub | | int getTypeSub()(Code) | | Retrieves the HSQLDB data subtype as an int.
the HSQLDB data subtype as an int |
| isAutoIncrement | | Boolean isAutoIncrement()(Code) | | Retrieves whether the type can be an IDENTITY type.
whether the type can be an IDENTITY type. |
| isCaseSensitive | | Boolean isCaseSensitive()(Code) | | Retrieves whether the type is case-sensitive in collations and
comparisons.
whether the type is case-sensitive in collations andcomparisons. |
| isColStClsSupported | | Boolean isColStClsSupported()(Code) | | Retrieves whether, under the current release, class path and hosting
JVM, HSQLDB supports storing this type in table columns.
This value also typically represents whether HSQLDB supports retrieving
values of this type in the columns of ResultSets.
whether, under the current release, class pathand hosting JVM, HSQLDB supports storing thistype in table columns |
| isFixedPrecisionScale | | Boolean isFixedPrecisionScale()(Code) | | Retrieves whether values of this type have a fixed precision and
scale.
whether values of this type have a fixedprecision and scale. |
| isStdMapClsSupported | | Boolean isStdMapClsSupported()(Code) | | Retrieve whether the fully qualified name reported by getStdMapClsName()
is supported as a jdbcResultSet.getXXX return type under the current
HSQLDB release, class path and hosting JVM.
whether the fully qualified name reported by getStdMapClsName()is supported as a jdbcResultSet.getXXX return type under the currentHSQLDB release, class path and hosting JVM. |
| isSupportedAsPCol | | Boolean isSupportedAsPCol()(Code) | | Retrieves whether, under the current release, class path and
hosting JVM, HSQLDB supports passing or receiving this type as
the value of a procedure column.
whether, under the current release, class path andhosting JVM, HSQLDB supports passing or receivingthis type as the value of a procedure column. |
| isSupportedAsTCol | | Boolean isSupportedAsTCol()(Code) | | Retrieves whether, under the current release, class path and
hosting JVM, HSQLDB supports this as the type of a table
column.
whether, under the current release, class pathand hosting JVM, HSQLDB supports this typeas the values of a table column |
| isUnsignedAttribute | | Boolean isUnsignedAttribute()(Code) | | Retrieves whether values of this type are unsigned.
whether values of this type are unsigned |
| setLocale | | void setLocale(Locale l)(Code) | | Assigns the Locale object used to retrieve this object's
resource bundle dependent values.
Parameters:
l - the Locale object used to retrieve this object's resourcebundle dependent values |
| setTypeCode | | void setTypeCode(int type)(Code) | | Assigns the SQL data type code on which this object is to report.
Parameters:
type - the SQL data type code on which this object is to report |
| setTypeSub | | void setTypeSub(int typeSub)(Code) | | Assigns the HSQLDB data subtype code on which this object is
to report.
Parameters:
typeSub - the HSQLDB data subtype code on which this objectis to report |
|
|