Package org.hibernate.type.descriptor.sql

Interface SqlTypeDescriptor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractHANADialect.HANABlobTypeDescriptor, AttributeConverterSqlTypeDescriptorAdapter, BigIntTypeDescriptor, BinaryTypeDescriptor, BitTypeDescriptor, BlobTypeDescriptor, BooleanTypeDescriptor, CharTypeDescriptor, ClobTypeDescriptor, DateTypeDescriptor, DB2GeometryTypeDescriptor, DecimalTypeDescriptor, DoubleTypeDescriptor, FloatTypeDescriptor, GeoDBGeometryTypeDescriptor, HANAGeometryTypeDescriptor, HANAPointTypeDescriptor, IntegerTypeDescriptor, LongNVarcharTypeDescriptor, LongVarbinaryTypeDescriptor, LongVarcharTypeDescriptor, MariaDBGeometryTypeDescriptor, MySQLGeometryTypeDescriptor, NCharTypeDescriptor, NClobTypeDescriptor, NumericTypeDescriptor, NVarcharTypeDescriptor, PGGeometryTypeDescriptor, PostgresUUIDType.PostgresUUIDSqlTypeDescriptor, RealTypeDescriptor, SDOGeometryTypeDescriptor, SmallIntTypeDescriptor, SqlServer2008GeometryTypeDescriptor, SqlTypeDescriptorRegistry.ObjectSqlTypeDescriptor, TimestampTypeDescriptor, TimeTypeDescriptor, TinyIntTypeDescriptor, VarbinaryTypeDescriptor, VarcharTypeDescriptor

public interface SqlTypeDescriptor
extends java.io.Serializable

Descriptor for the SQL/JDBC side of a value mapping.

NOTE : Implementations should be registered with the SqlTypeDescriptor. The built-in Hibernate implementations register themselves on construction.

Method Summary

Modifier and Type	Method	Description
boolean	canBeRemapped()	Is this descriptor available for remapping?
<X> ValueBinder<X>	getBinder(JavaTypeDescriptor<X> javaTypeDescriptor)	Get the binder (setting JDBC in-going parameter values) capable of handling values of the type described by the passed descriptor.
<X> ValueExtractor<X>	getExtractor(JavaTypeDescriptor<X> javaTypeDescriptor)	Get the extractor (pulling out-going values from JDBC objects) capable of handling values of the type described by the passed descriptor.
default <T> BasicJavaDescriptor<T>	getJdbcRecommendedJavaTypeMapping(TypeConfiguration typeConfiguration)
int	getSqlType()	Return the JDBC type-code for the column mapped by this type.

Method Detail

getSqlType

int getSqlType()

Return the JDBC type-code for the column mapped by this type.

Returns:

typeCode The JDBC type-code

canBeRemapped

boolean canBeRemapped()

Is this descriptor available for remapping?

Returns:

true indicates this descriptor can be remapped; otherwise, false

See Also:

WrapperOptions.remapSqlTypeDescriptor(org.hibernate.type.descriptor.sql.SqlTypeDescriptor), Dialect.remapSqlTypeDescriptor(org.hibernate.type.descriptor.sql.SqlTypeDescriptor)

getJdbcRecommendedJavaTypeMapping

default <T> BasicJavaDescriptor<T> getJdbcRecommendedJavaTypeMapping(TypeConfiguration typeConfiguration)

getBinder

<X> ValueBinder<X> getBinder(JavaTypeDescriptor<X> javaTypeDescriptor)

Get the binder (setting JDBC in-going parameter values) capable of handling values of the type described by the passed descriptor.

Parameters:

javaTypeDescriptor - The descriptor describing the types of Java values to be bound

Returns:

The appropriate binder.

getExtractor

<X> ValueExtractor<X> getExtractor(JavaTypeDescriptor<X> javaTypeDescriptor)

Get the extractor (pulling out-going values from JDBC objects) capable of handling values of the type described by the passed descriptor.

Parameters:

javaTypeDescriptor - The descriptor describing the types of Java values to be extracted

Returns:

The appropriate extractor