Package org.hibernate.type

Interface BasicType<T>

All Superinterfaces:: BasicDomainType<T>,BasicType<T>,BasicValuedMapping,Bindable,BindableType<T>,DomainType<T>,JavaTypedExpressible,JdbcMapping,JdbcMappingContainer,MappingModelExpressible,MappingType,OutputableType<T>,ReturnableType<T>,Serializable,SimpleDomainType<T>,SqlExpressible,SqmBindableType<T>,SqmDomainType<T>,SqmExpressible<T>,Type<T>,Type,ValueMapping

All Known Subinterfaces:: AdjustableBasicType<J>,BasicPluralType<C,E>,ConvertedBasicType<J>,DiscriminatorType<O>

All Known Implementing Classes:: AbstractSingleColumnStandardBasicType,AbstractStandardBasicType,BasicArrayType,BasicCollectionType,BasicTypeImpl,BottomType,ConvertedBasicArrayType,ConvertedBasicCollectionType,ConvertedBasicTypeImpl,CustomMutabilityConvertedBasicTypeImpl,CustomMutabilityConvertedPrimitiveBasicTypeImpl,CustomType,DiscriminatorType,DiscriminatorTypeImpl,ImmutableNamedBasicTypeImpl,JavaObjectType,NamedBasicTypeImpl,NullType,QueryParameterJavaObjectType,SerializableType,StandardBasicTypeTemplate

public interfaceBasicType<T>extendsType,BasicDomainType<T>,MappingType,BasicValuedMapping,JdbcMapping,SqmDomainType<T>

Marker interface for basic types.

Nested Class Summary
Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable
Bindable.JdbcValuesBiConsumer<X,Y>,Bindable.JdbcValuesConsumer
Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Type
Type.PersistenceType
Method Summary
Modifier and Type
Method
Description
default int
compare(Object x,Object y,SessionFactoryImplementor sessionFactory)

defaultObject
disassemble(Object value,SharedSessionContractImplementor session)
Breaks down a value ofJ into its simple pieces.
default <X,Y> int
forEachDisassembledJdbcValue(Object value, int offset, X x, Y y,Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,SharedSessionContractImplementor session)
LikeBindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when callingBindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
default int
forEachJdbcType(int offset,IndexedConsumer<JdbcMapping> action)
Visit each JdbcMapping starting from the given offset
default int
forEachJdbcType(IndexedConsumer<JdbcMapping> action)
Visit each of JdbcMapping
defaultString
getCheckCondition(String columnName,Dialect dialect)
The check constraint that should be added to the column definition in generated DDL.
defaultJavaType<T>
getExpressibleJavaType()
TheJavaType representing this domain type.
defaultClass<T>
getJavaType()
The Java class which represents by this domain type.
defaultJavaType<T>
getJavaTypeDescriptor()
The descriptor for the Java type represented by this expressible type
defaultJdbcLiteralFormatter<T>
getJdbcLiteralFormatter()
The strategy for formatting values of this expressible type to a SQL literal.
defaultJdbcMapping
getJdbcMapping()
Anything that is expressible at the SQL AST level would be of basic type.
defaultJdbcMapping
getJdbcMapping(int index)

default int
getJdbcTypeCount()
The number of JDBC mappings
defaultValueBinder<T>
getJdbcValueBinder()
The strategy for binding values of this expressible type to JDBCPreparedStatements andCallableStatements.
defaultValueExtractor<T>
getJdbcValueExtractor()
The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc
defaultJavaType<T>
getMappedJavaType()
Thedescriptor descriptor for the mapped Java type
defaultMappingType
getMappedType()
Descriptor for the type of this mapping
String[]
getRegistrationKeys()
Get the names under which this type should be registered in the type registry.
defaultJdbcMapping
getSingleJdbcMapping()

defaultSqmDomainType<T>
getSqmType()

defaultBasicValueConverter<T,?>
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.
Methods inherited from interface org.hibernate.metamodel.model.domain.BasicDomainType
getPersistenceType
Methods inherited from interface org.hibernate.metamodel.mapping.BasicValuedMapping
addToCacheKey
Methods inherited from interface org.hibernate.metamodel.mapping.Bindable
forEachDisassembledJdbcValue,forEachDisassembledJdbcValue,forEachDisassembledJdbcValue,forEachJdbcValue,forEachJdbcValue,forEachJdbcValue,forEachJdbcValue
Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMapping
convertToDomainValue,convertToRelationalValue,getCastType,getJdbcJavaType,getJdbcType
Methods inherited from interface org.hibernate.type.OutputableType
canDoExtraction,extract,extract,getJdbcType
Methods inherited from interface org.hibernate.query.sqm.SqmBindableType
resolveExpressible
Methods inherited from interface org.hibernate.query.sqm.tree.domain.SqmDomainType
getTupleLength,getTypeName
Methods inherited from interface org.hibernate.query.sqm.SqmExpressible
getRelationalJavaType
Methods inherited from interface org.hibernate.type.Type
assemble,beforeAssemble,compare,deepCopy,disassemble,disassemble,getColumnSpan,getHashCode,getHashCode,getName,getReturnedClass,getReturnedClassName,getSqlTypeCodes,getTypeForEqualsHashCode,isAnyType,isAssociationType,isCollectionType,isComponentType,isDirty,isDirty,isEntityType,isEqual,isEqual,isModified,isMutable,isSame,nullSafeSet,nullSafeSet,replace,replace,toColumnNullness,toLoggableString
Methods inherited from interface org.hibernate.metamodel.mapping.ValueMapping
treatAs

Method Details
- getRegistrationKeys
  String[] getRegistrationKeys()
  Get the names under which this type should be registered in the type registry.
  Returns:
  The keys under which to register this type.
- getJavaType
  default Class<T> getJavaType()
  Description copied from interface: DomainType
  The Java class which represents by this domain type.
  Specified by:
  getJavaType in interface BasicDomainType<T>
  Specified by:
  getJavaType in interface DomainType<T>
  Specified by:
  getJavaType in interface SimpleDomainType<T>
  Specified by:
  getJavaType in interface Type<T>
  See Also:
  Type.getJavaType()
- getMappedType
  default MappingType getMappedType()
  Description copied from interface: ValueMapping
  Descriptor for the type of this mapping
  Specified by:
  getMappedType in interface ValueMapping
- getJavaTypeDescriptor
  default JavaType<T> getJavaTypeDescriptor()
  Description copied from interface: JdbcMapping
  The descriptor for the Java type represented by this expressible type
  Specified by:
  getJavaTypeDescriptor in interface JdbcMapping
- getExpressibleJavaType
  default JavaType<T> getExpressibleJavaType()
  Description copied from interface: DomainType
  TheJavaType representing this domain type.
  Specified by:
  getExpressibleJavaType in interface DomainType<T>
  Specified by:
  getExpressibleJavaType in interface JavaTypedExpressible<T>
  Specified by:
  getExpressibleJavaType in interface SqmExpressible<T>
  Specified by:
  getExpressibleJavaType in interface ValueMapping
- forEachJdbcType
  default int forEachJdbcType(IndexedConsumer<JdbcMapping> action)
  Description copied from interface: Bindable
  Visit each of JdbcMapping
  Specified by:
  forEachJdbcType in interface Bindable
  Specified by:
  forEachJdbcType in interface JdbcMapping
  Specified by:
  forEachJdbcType in interface JdbcMappingContainer
- getJdbcMapping
  default JdbcMapping getJdbcMapping()
  Description copied from interface: SqlExpressible
  Anything that is expressible at the SQL AST level would be of basic type.
  Specified by:
  getJdbcMapping in interface BasicValuedMapping
  Specified by:
  getJdbcMapping in interface SqlExpressible
- getJdbcTypeCount
  default int getJdbcTypeCount()
  Description copied from interface: Bindable
  The number of JDBC mappings
  Specified by:
  getJdbcTypeCount in interface BasicValuedMapping
  Specified by:
  getJdbcTypeCount in interface Bindable
  Specified by:
  getJdbcTypeCount in interface JdbcMapping
  Specified by:
  getJdbcTypeCount in interface JdbcMappingContainer
- getJdbcMapping
  default JdbcMapping getJdbcMapping(int index)
  Specified by:
  getJdbcMapping in interface BasicValuedMapping
  Specified by:
  getJdbcMapping in interface JdbcMapping
  Specified by:
  getJdbcMapping in interface JdbcMappingContainer
  Specified by:
  getJdbcMapping in interface SqlExpressible
- getSingleJdbcMapping
  default JdbcMapping getSingleJdbcMapping()
  Specified by:
  getSingleJdbcMapping in interface BasicValuedMapping
  Specified by:
  getSingleJdbcMapping in interface JdbcMapping
  Specified by:
  getSingleJdbcMapping in interface JdbcMappingContainer
- getMappedJavaType
  default JavaType<T> getMappedJavaType()
  Description copied from interface: MappingType
  Thedescriptor descriptor for the mapped Java type
  Specified by:
  getMappedJavaType in interface JdbcMapping
  Specified by:
  getMappedJavaType in interface MappingType
- getValueConverter
  @Incubatingdefault BasicValueConverter<T,?> getValueConverter()
  Description copied from interface: JdbcMapping
  Returns the converter that this basic type uses for transforming from the domain type, to the relational type, ornull if there is no conversion.
  Specified by:
  getValueConverter in interface JdbcMapping
- getJdbcValueExtractor
  default ValueExtractor<T> getJdbcValueExtractor()
  Description copied from interface: JdbcMapping
  The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc
  Specified by:
  getJdbcValueExtractor in interface JdbcMapping
- getJdbcValueBinder
  default ValueBinder<T> getJdbcValueBinder()
  Description copied from interface: JdbcMapping
  The strategy for binding values of this expressible type to JDBCPreparedStatements andCallableStatements.
  Specified by:
  getJdbcValueBinder in interface JdbcMapping
- getJdbcLiteralFormatter
  default JdbcLiteralFormatter<T> getJdbcLiteralFormatter()
  Description copied from interface: JdbcMapping
  The strategy for formatting values of this expressible type to a SQL literal.
  Specified by:
  getJdbcLiteralFormatter in interface JdbcMapping
- 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 interface JdbcMapping
  Specified by:
  forEachJdbcType in interface JdbcMappingContainer
- getSqmType
  default SqmDomainType<T> getSqmType()
  Specified by:
  getSqmType in interface SqmExpressible<T>
- disassemble
  default Object disassemble(Object value,SharedSessionContractImplementor session)
  Description copied from interface: Bindable
  Breaks down a value ofJ into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.
  Generally speaking, this is the form in which entity state is kept relative to a Session viaEntityEntry.
  @Entity class Person { @Id Integer id; @Embedded Name name; int age; } @Embeddable class Name { String familiarName; String familyName; }
  At the top level, we would want to disassemble aPerson value, so we'd ask theBindable for thePerson entity to disassemble. Given aPerson value:
  Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
  this disassemble would result in a multidimensional array:
  [ ["Steve", "Ebersole"], 28 ]
  Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.
  Specified by:
  disassemble in interface BasicValuedMapping
  Specified by:
  disassemble in interface Bindable
  See Also:
- forEachDisassembledJdbcValue
  default <X,Y> int forEachDisassembledJdbcValue(Object value, int offset, X x, Y y,Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,SharedSessionContractImplementor session)
  Description copied from interface: Bindable
  LikeBindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when callingBindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
  Specified by:
  forEachDisassembledJdbcValue in interface Bindable
- getCheckCondition
  @Incubatingdefault String getCheckCondition(String columnName,Dialect dialect)
  The check constraint that should be added to the column definition in generated DDL.
  Parameters:
  columnName - the name of the column
  dialect - the SQLDialect
  Returns:
  a check constraint condition or null
  Since:
  6.2
- compare
  default int compare(Object x,Object y,SessionFactoryImplementor sessionFactory)
  Specified by:
  compare in interface Type

Movatterモバイル変換

Interface BasicType<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Type

Method Summary

Methods inherited from interface org.hibernate.metamodel.model.domain.BasicDomainType

Methods inherited from interface org.hibernate.metamodel.mapping.BasicValuedMapping

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMapping

Methods inherited from interface org.hibernate.type.OutputableType

Methods inherited from interface org.hibernate.query.sqm.SqmBindableType

Methods inherited from interface org.hibernate.query.sqm.tree.domain.SqmDomainType

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

Methods inherited from interface org.hibernate.type.Type

Methods inherited from interface org.hibernate.metamodel.mapping.ValueMapping

Method Details

getRegistrationKeys

getJavaType

getMappedType

getJavaTypeDescriptor

getExpressibleJavaType

forEachJdbcType

getJdbcMapping

getJdbcTypeCount

getJdbcMapping

getSingleJdbcMapping

getMappedJavaType

getValueConverter

getJdbcValueExtractor

getJdbcValueBinder

getJdbcLiteralFormatter

forEachJdbcType

getSqmType

disassemble

forEachDisassembledJdbcValue

getCheckCondition

compare