Package org.hibernate.metamodel.mapping
Interface JdbcMapping
-
- All Superinterfaces:
JdbcMappingContainer
,MappingType
- All Known Subinterfaces:
AdjustableBasicType<J>
,BasicPluralType<C,E>
,BasicType<T>
,ConvertedBasicType<J>
- All Known Implementing Classes:
AbstractSingleColumnStandardBasicType
,AbstractStandardBasicType
,BasicArrayType
,BasicCollectionType
,BasicTypeImpl
,ConvertedBasicTypeImpl
,CustomMutabilityConvertedBasicTypeImpl
,CustomType
,DiscriminatorType
,ImmutableNamedBasicTypeImpl
,JavaObjectType
,NamedBasicTypeImpl
,NullType
,SerializableToBlobType
,SerializableType
,StandardBasicTypeTemplate
public interface JdbcMapping extends MappingType, JdbcMappingContainer
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Object
convertToDomainValue(Object value)
default Object
convertToRelationalValue(Object value)
default int
forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)
Visit each JdbcMapping starting from the given offsetdefault int
forEachJdbcType(IndexedConsumer<JdbcMapping> action)
Visit each of JdbcMappingdefault CastType
getCastType()
JavaType
getJavaTypeDescriptor()
The descriptor for the Java type represented by this expressible typedefault JavaType<?>
getJdbcJavaType()
default JdbcLiteralFormatter
getJdbcLiteralFormatter()
The strategy for formatting values of this expressible type to a SQL literal.default List<JdbcMapping>
getJdbcMappings()
The list of JDBC mappingsJdbcType
getJdbcType()
The descriptor for the SQL type represented by this expressible typedefault int
getJdbcTypeCount()
The number of JDBC mappingsValueBinder
getJdbcValueBinder()
The strategy for binding values of this expressible type to JDBCPreparedStatement
s andCallableStatement
s.ValueExtractor<?>
getJdbcValueExtractor()
The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etcdefault JavaType<?>
getMappedJavaType()
The descriptor descriptor for the mapped Java typedefault BasicValueConverter
getValueConverter()
Returns the converter that this basic type uses for transforming from the domain type, to the relational type, ornull
if there is no conversion.
-
-
-
Method Detail
-
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
-
getCastType
default CastType getCastType()
-
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 JDBCPreparedStatement
s andCallableStatement
s.
-
getJdbcLiteralFormatter
default JdbcLiteralFormatter getJdbcLiteralFormatter()
The strategy for formatting values of this expressible type to a SQL literal.
-
getMappedJavaType
default JavaType<?> getMappedJavaType()
Description copied from interface:MappingType
The descriptor descriptor for the mapped Java type- Specified by:
getMappedJavaType
in interfaceMappingType
-
getJdbcJavaType
default JavaType<?> getJdbcJavaType()
-
getValueConverter
default BasicValueConverter getValueConverter()
Returns the converter that this basic type uses for transforming from the domain type, to the relational type, ornull
if there is no conversion.
-
getJdbcTypeCount
default int getJdbcTypeCount()
Description copied from interface:JdbcMappingContainer
The number of JDBC mappings- Specified by:
getJdbcTypeCount
in interfaceJdbcMappingContainer
-
getJdbcMappings
default List<JdbcMapping> getJdbcMappings()
Description copied from interface:JdbcMappingContainer
The list of JDBC mappings- Specified by:
getJdbcMappings
in interfaceJdbcMappingContainer
-
forEachJdbcType
default int forEachJdbcType(IndexedConsumer<JdbcMapping> action)
Description copied from interface:JdbcMappingContainer
Visit each of JdbcMapping- Specified by:
forEachJdbcType
in interfaceJdbcMappingContainer
-
forEachJdbcType
default int forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)
Description copied from interface:JdbcMappingContainer
Visit each JdbcMapping starting from the given offset- Specified by:
forEachJdbcType
in interfaceJdbcMappingContainer
-
-