Package org.hibernate.persister.entity

Class DiscriminatorType<T>

java.lang.Object
org.hibernate.type.AbstractType
org.hibernate.persister.entity.DiscriminatorType<T>
All Implemented Interfaces:
BasicType<T>, Type<T>, Serializable, BasicValuedMapping, Bindable, JdbcMapping, JdbcMappingContainer, MappingModelExpressible, MappingType, SqlExpressible, ValueMapping, BasicDomainType<T>, DomainType<T>, SimpleDomainType<T>, BindableType<T>, OutputableType<T>, ReturnableType<T>, SqmExpressible<T>, BasicType<T>, JavaTypedExpressible, Type
@Internal @Deprecated(since="6.2", forRemoval=true) public class DiscriminatorType<T> extends AbstractType implements BasicType<T>
Deprecated, for removal: This API element is subject to removal in a future version.
The functionality of DiscriminatorType, DiscriminatorMetadata and MetaType have been consolidated into EntityDiscriminatorMapping and DiscriminatorConverter
See Also:

  • Constructor Details

  • Method Details

    • getUnderlyingType

      public BasicType<?> getUnderlyingType()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getValueConverter

      public DiscriminatorConverter getValueConverter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbcMapping
      Returns the converter that this basic type uses for transforming from the domain type, to the relational type, or null if there is no conversion.
      Specified by:
      getValueConverter in interface BasicType<T>
      Specified by:
      getValueConverter in interface JdbcMapping

    • getJdbcJavaType

      public JavaType<?> getJdbcJavaType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getJdbcJavaType in interface JdbcMapping

    • getReturnedClass

      public Class<?> getReturnedClass()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      The class handled by this type.
      Specified by:
      getReturnedClass in interface Type
      Returns:
      The Java class handled by this type.

    • getJavaType

      public Class getJavaType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getJavaType in interface Type<T>

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Returns the abbreviated name of the type.
      Specified by:
      getName in interface Type
      Returns:
      the Hibernate type name

    • isMutable

      public boolean isMutable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Are objects of this type mutable with respect to the referencing object? Entities and collections are considered immutable because they manage their own internal state.
      Specified by:
      isMutable in interface Type
      Returns:
      boolean

    • extract

      public T extract(CallableStatement statement, int paramIndex, SharedSessionContractImplementor session) throws SQLException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OutputableType
      Perform the extraction
      Specified by:
      extract in interface OutputableType<T>
      Parameters:
      statement - The CallableStatement from which to extract the parameter value(s).
      paramIndex - The parameter index from which to extract
      session - The originating session
      Returns:
      The extracted value.
      Throws:
      SQLException - Indicates an issue calling into the CallableStatement

    • extract

      public T extract(CallableStatement statement, String paramName, SharedSessionContractImplementor session) throws SQLException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OutputableType
      Perform the extraction
      Specified by:
      extract in interface OutputableType<T>
      Parameters:
      statement - The CallableStatement from which to extract the parameter value(s).
      paramName - The parameter names.
      session - The originating session
      Returns:
      The extracted value.
      Throws:
      SQLException - Indicates an issue calling into the CallableStatement

    • nullSafeSet

      public void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Bind a value represented by an instance of the mapped class to the given JDBC PreparedStatement, ignoring some columns as dictated by the settable parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting from index.
      Specified by:
      nullSafeSet in interface Type
      Parameters:
      st - The JDBC prepared statement to which to bind
      value - the object to write
      index - starting parameter bind index
      settable - an array indicating which columns to bind/ignore
      session - The originating session
      Throws:
      HibernateException - An error from Hibernate
      SQLException - An error from the JDBC driver

    • nullSafeSet

      public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Bind a value represented by an instance of the mapped class to the given JDBC PreparedStatement, ignoring some columns as dictated by the settable parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting from index.
      Specified by:
      nullSafeSet in interface Type
      Parameters:
      st - The JDBC prepared statement to which to bind
      value - the object to write
      index - starting parameter bind index
      session - The originating session
      Throws:
      HibernateException - An error from Hibernate
      SQLException - An error from the JDBC driver

    • toLoggableString

      public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Generate a representation of the given value for logging purposes.
      Specified by:
      toLoggableString in interface Type
      Parameters:
      value - The value to be logged
      factory - The session factory
      Returns:
      The loggable representation
      Throws:
      HibernateException - An error from Hibernate

    • deepCopy

      public Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Return a deep copy of the persistent state, stopping at entities and at collections.
      Specified by:
      deepCopy in interface Type
      Parameters:
      value - The value to be copied
      factory - The session factory
      Returns:
      The deep copy
      Throws:
      HibernateException - An error from Hibernate

    • replace

      public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map<Object,Object> copyCache) throws HibernateException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.
      Specified by:
      replace in interface Type
      Parameters:
      original - the value from the detached entity being merged
      target - the value in the managed entity
      session - The originating session
      owner - The owner of the value
      copyCache - The cache of already copied/replaced values
      Returns:
      the value to be merged
      Throws:
      HibernateException - An error from Hibernate

    • toColumnNullness

      public boolean[] toColumnNullness(Object value, MappingContext mapping)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Given an instance of the type, return an array of boolean values indicating which mapped columns would be null.
      Specified by:
      toColumnNullness in interface Type
      Parameters:
      value - an instance of the type
      mapping - The mapping context MappingContext
      Returns:
      array indicating column nullness for a value instance

    • isDirty

      public boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Should the parent be considered dirty, given both the old and current value?
      Specified by:
      isDirty in interface Type
      Parameters:
      old - the old value
      current - the current value
      checkable - An array of booleans indicating which columns making up the value are actually checkable
      session - The session from which the request originated.
      Returns:
      true if the field is dirty
      Throws:
      HibernateException - A problem occurred performing the checking

    • disassemble

      public Object disassemble(Object value, SharedSessionContractImplementor session)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Bindable
      Breaks down a value of J 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 via EntityEntry. 

       @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 a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person 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 BasicType<T>
      Specified by:
      disassemble in interface BasicValuedMapping
      Specified by:
      disassemble in interface Bindable
      See Also:

    • addToCacheKey

      public void addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Bindable
      Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
      Specified by:
      addToCacheKey in interface BasicValuedMapping
      Specified by:
      addToCacheKey in interface Bindable
      Specified by:
      addToCacheKey in interface JavaTypedExpressible<T>
      Parameters:
      cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode
      value - the value to disassemble
      session - the SharedSessionContractImplementor

    • getSqlTypeCodes

      public int[] getSqlTypeCodes(MappingContext mappingContext) throws MappingException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      Return the JDBC types codes as defined by Types or SqlTypes for the columns mapped by this type.

      The number of elements in this array must match the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

      Specified by:
      getSqlTypeCodes in interface Type
      Parameters:
      mappingContext - The mapping context MappingContext :/
      Returns:
      The JDBC type codes.
      Throws:
      MappingException - Generally indicates an issue accessing the passed mapping object.

    • getColumnSpan

      public int getColumnSpan(MappingContext mapping) throws MappingException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Type
      How many columns are used to persist this type?

      Always the same as getSqlTypCodes(mappingContext).length.

      Specified by:
      getColumnSpan in interface Type
      Parameters:
      mapping - The mapping Context object MappingContext
      Returns:
      The number of columns
      Throws:
      MappingException - Generally indicates an issue accessing the passed mappingContext object.

    • canDoExtraction

      public boolean canDoExtraction()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OutputableType
      Can the given instance of this type actually perform the parameter value extractions?
      Specified by:
      canDoExtraction in interface OutputableType<T>
      Returns:
      true indicates that OutputableType.extract(java.sql.CallableStatement, int, org.hibernate.engine.spi.SharedSessionContractImplementor) calls will not fail due to IllegalStateException.

    • getExpressibleJavaType

      public JavaType<T> getExpressibleJavaType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SqmExpressible
      The Java type descriptor for this expressible
      Specified by:
      getExpressibleJavaType in interface BasicType<T>
      Specified by:
      getExpressibleJavaType in interface JavaTypedExpressible<T>
      Specified by:
      getExpressibleJavaType in interface SqmExpressible<T>
      Specified by:
      getExpressibleJavaType in interface ValueMapping

    • getJavaTypeDescriptor

      public JavaType<T> getJavaTypeDescriptor()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbcMapping
      The descriptor for the Java type represented by this expressible type
      Specified by:
      getJavaTypeDescriptor in interface BasicType<T>
      Specified by:
      getJavaTypeDescriptor in interface JdbcMapping

    • getMappedJavaType

      public JavaType<T> getMappedJavaType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: MappingType
      The descriptor descriptor for the mapped Java type
      Specified by:
      getMappedJavaType in interface BasicType<T>
      Specified by:
      getMappedJavaType in interface JdbcMapping
      Specified by:
      getMappedJavaType in interface MappingType

    • getJdbcType

      public JdbcType getJdbcType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OutputableType
      Descriptor for the SQL type mapped by this type.
      Specified by:
      getJdbcType in interface JdbcMapping
      Specified by:
      getJdbcType in interface OutputableType<T>

    • getJdbcValueExtractor

      public ValueExtractor<T> getJdbcValueExtractor()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbcMapping
      The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc
      Specified by:
      getJdbcValueExtractor in interface BasicType<T>
      Specified by:
      getJdbcValueExtractor in interface JdbcMapping

    • getJdbcValueBinder

      public ValueBinder<T> getJdbcValueBinder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbcMapping
      The strategy for binding values of this expressible type to JDBC PreparedStatements and CallableStatements.
      Specified by:
      getJdbcValueBinder in interface BasicType<T>
      Specified by:
      getJdbcValueBinder in interface JdbcMapping

    • getJdbcLiteralFormatter

      public JdbcLiteralFormatter getJdbcLiteralFormatter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbcMapping
      The strategy for formatting values of this expressible type to a SQL literal.
      Specified by:
      getJdbcLiteralFormatter in interface BasicType<T>
      Specified by:
      getJdbcLiteralFormatter in interface JdbcMapping

    • getRegistrationKeys

      public String[] getRegistrationKeys()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: BasicType
      Get the names under which this type should be registered in the type registry.
      Specified by:
      getRegistrationKeys in interface BasicType<T>
      Returns:
      The keys under which to register this type.