Package org.hibernate.metamodel.mapping
Interface JdbcMapping
- All Superinterfaces:
JdbcMappingContainer,MappingType
- All Known Subinterfaces:
AdjustableBasicType<J>,BasicPluralType<C,,E> BasicType<T>,ConvertedBasicType<J>,DiscriminatorType<O>
- All Known Implementing Classes:
AbstractSingleColumnStandardBasicType,AbstractStandardBasicType,BasicArrayType,BasicCollectionType,BasicTypeImpl,BasicTypeImpl,BottomType,ConvertedBasicArrayType,ConvertedBasicCollectionType,ConvertedBasicTypeImpl,CustomMutabilityConvertedBasicTypeImpl,CustomMutabilityConvertedPrimitiveBasicTypeImpl,CustomType,DiscriminatorType,DiscriminatorTypeImpl,ImmutableNamedBasicTypeImpl,JavaObjectType,NamedBasicTypeImpl,NullType,PrimitiveBasicTypeImpl,QueryParameterJavaObjectType,SerializableType,StandardBasicTypeTemplate
Describes the mapping for things which can be expressed in a SQL query.
Generally speaking this models a column. However, it can also model SQL tuples as well
This includes details such as
- the Java type of the mapping
- the JDBC type of the mapping
- how to read values from result-sets as well as callable parameters
- how to write values to JDBC statements
Some mappings will have an associated value converter. The readers and writers for such mappings will already incorporate those conversions
Some mappings support usage as SQL literals. Such mappings will return a non-null literal formatter which handles formatting values as a SQL literal
-
Method Summary
Modifier and TypeMethodDescriptiondefault <T> ObjectconvertToDomainValue(T value) default <T> ObjectconvertToRelationalValue(T value) default intforEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action) Visit each JdbcMapping starting from the given offsetdefault intforEachJdbcType(IndexedConsumer<JdbcMapping> action) Visit each of JdbcMappingdefault CastTypeThe descriptor for the Java type represented by this expressible typedefault JavaType<?> default JdbcLiteralFormatterThe strategy for formatting values of this expressible type to a SQL literal.default JdbcMappinggetJdbcMapping(int index) The descriptor for the SQL type represented by this expressible typedefault intThe number of JDBC mappingsThe strategy for binding values of this expressible type to JDBCPreparedStatements andCallableStatements.The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etcdefault JavaType<?> The descriptor descriptor for the mapped Java typedefault JdbcMappingdefault BasicValueConverter<?, ?> Returns the converter that this basic type uses for transforming from the domain type, to the relational type, ornullif there is no conversion.
-
Method Details
-
getJavaTypeDescriptor
JavaType getJavaTypeDescriptor()The descriptor for the Java type represented by this expressible type -
getJdbcType
JdbcType getJdbcType()The descriptor for the SQL type represented by this expressible type -
getJdbcValueExtractor
ValueExtractor<?> getJdbcValueExtractor()The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc -
getJdbcValueBinder
ValueBinder getJdbcValueBinder()The strategy for binding values of this expressible type to JDBCPreparedStatements andCallableStatements. -
getCastType
-
getJdbcLiteralFormatter
The strategy for formatting values of this expressible type to a SQL literal. -
getMappedJavaType
Description copied from interface:MappingTypeThe descriptor descriptor for the mapped Java type- Specified by:
getMappedJavaTypein interfaceMappingType
-
getJdbcJavaType
-
getValueConverter
Returns the converter that this basic type uses for transforming from the domain type, to the relational type, ornullif there is no conversion. -
convertToRelationalValue
-
convertToDomainValue
-
getJdbcTypeCount
default int getJdbcTypeCount()Description copied from interface:JdbcMappingContainerThe number of JDBC mappings- Specified by:
getJdbcTypeCountin interfaceJdbcMappingContainer
-
getJdbcMapping
- Specified by:
getJdbcMappingin interfaceJdbcMappingContainer
-
getSingleJdbcMapping
- Specified by:
getSingleJdbcMappingin interfaceJdbcMappingContainer
-
forEachJdbcType
Description copied from interface:JdbcMappingContainerVisit each of JdbcMapping- Specified by:
forEachJdbcTypein interfaceJdbcMappingContainer
-
forEachJdbcType
Description copied from interface:JdbcMappingContainerVisit each JdbcMapping starting from the given offset- Specified by:
forEachJdbcTypein interfaceJdbcMappingContainer
-