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, BasicValueConverter<T,Object>, BasicDomainType<T>, DomainType<T>, SimpleDomainType<T>, BindableType<T>, OutputableType<T>, ReturnableType<T>, SqmExpressible<T>, BasicType<T>, JavaTypedExpressible, Type

public class DiscriminatorType<T>
extends AbstractType
implements BasicType<T>, BasicValueConverter<T,Object>

TODO : javadoc

See Also:

Serialized Form

Nested Class Summary

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

Bindable.JdbcValuesConsumer

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

Type.PersistenceType

Field Summary

Fields inherited from class org.hibernate.type.AbstractType

LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE

Constructor Summary

Constructors

Constructor	Description
DiscriminatorType(BasicType<?> underlyingType, Loadable persister)

Method Summary

Modifier and Type	Method	Description
boolean	canDoExtraction()	Can the given instance of this type actually perform the parameter value extractions?
Object	deepCopy(Object value, SessionFactoryImplementor factory)	Return a deep copy of the persistent state, stopping at entities and at collections.
Object	disassemble(Object value, SharedSessionContractImplementor session)
T	extract(CallableStatement statement, int paramIndex, SharedSessionContractImplementor session)	Perform the extraction
T	extract(CallableStatement statement, String paramName, SharedSessionContractImplementor session)	Perform the extraction
int	getColumnSpan(Mapping mapping)	How many columns are used to persist this type.
JavaType<T>	getDomainJavaType()	Descriptor for the Java type for the domain portion of this converter
JavaType<T>	getExpressibleJavaType()	The descriptor for the Java type (i.e.
Class	getJavaType()
JavaType<T>	getJavaTypeDescriptor()	The descriptor for the Java type represented by this expressible type
JavaType<?>	getJdbcJavaType()
JdbcLiteralFormatter	getJdbcLiteralFormatter()	The strategy for formatting values of this expressible type to a SQL literal.
JdbcType	getJdbcType()	Descriptor for the SQL type mapped by this type.
ValueBinder<T>	getJdbcValueBinder()	The strategy for binding values of this expressible type to JDBC PreparedStatements and CallableStatements.
ValueExtractor<T>	getJdbcValueExtractor()	The strategy for extracting values of this expressible type from JDBC ResultSets, CallableStatements, etc
JavaType<T>	getMappedJavaType()
String	getName()	Returns the abbreviated name of the type.
String[]	getRegistrationKeys()	Get the names under which this type should be registered in the type registry.
JavaType<Object>	getRelationalJavaType()	Descriptor for the Java type for the relational portion of this converter
Class<?>	getReturnedClass()	The class handled by this type.
int[]	getSqlTypeCodes(Mapping mapping)	Return the JDBC types codes (per Types) for the columns mapped by this type.
BasicType<?>	getUnderlyingType()
BasicValueConverter<T,?>	getValueConverter()	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.
boolean	isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session)	Should the parent be considered dirty, given both the old and current value?
boolean	isMutable()	Are objects of this type mutable.
void	nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.
void	nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement.
Object	replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map<Object,Object> copyCache)	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.
boolean[]	toColumnNullness(Object value, Mapping mapping)	Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
T	toDomainValue(Object discriminatorValue)	Convert the relational form just retrieved from JDBC ResultSet into the domain form.
String	toLoggableString(Object value, SessionFactoryImplementor factory)	Generate a representation of the value for logging purposes.
Object	toRelationalValue(T domainForm)	Convert the domain form into the relational form in preparation for storage into JDBC

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, compare, disassemble, disassemble, getHashCode, getHashCode, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isEqual, isModified, isSame, replace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

areEqual, getPersistenceType

Methods inherited from interface org.hibernate.type.BasicType

forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcType, getJdbcMapping, getJdbcMappings, getJdbcTypeCount, getMappedType

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

forEachDisassembledJdbcValue, forEachJdbcValue, forEachJdbcValue

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

getTypeName

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

getCastType

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

getBindableJavaType

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

isInstance, resolveExpressible

Methods inherited from interface org.hibernate.type.Type

assemble, beforeAssemble, compare, disassemble, disassemble, getHashCode, getHashCode, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isEqual, isModified, isSame, replace

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

treatAs

Constructor Detail

DiscriminatorType

public DiscriminatorType(BasicType<?> underlyingType,
                         Loadable persister)

Method Detail

getUnderlyingType

public BasicType<?> getUnderlyingType()

getValueConverter

public 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, or null if there is no conversion.

Specified by:

getValueConverter in interface BasicType<T>

Specified by:

getValueConverter in interface JdbcMapping

getJdbcJavaType

public JavaType<?> getJdbcJavaType()

Specified by:

getJdbcJavaType in interface JdbcMapping

toDomainValue

public T toDomainValue(Object discriminatorValue)

Description copied from interface: BasicValueConverter

Convert the relational form just retrieved from JDBC ResultSet into the domain form.

Specified by:

toDomainValue in interface BasicValueConverter<T,Object>

toRelationalValue

public Object toRelationalValue(T domainForm)

Description copied from interface: BasicValueConverter

Convert the domain form into the relational form in preparation for storage into JDBC

Specified by:

toRelationalValue in interface BasicValueConverter<T,Object>

getDomainJavaType

public JavaType<T> getDomainJavaType()

Description copied from interface: BasicValueConverter

Descriptor for the Java type for the domain portion of this converter

Specified by:

getDomainJavaType in interface BasicValueConverter<T,Object>

getRelationalJavaType

public JavaType<Object> getRelationalJavaType()

Description copied from interface: BasicValueConverter

Descriptor for the Java type for the relational portion of this converter

Specified by:

getRelationalJavaType in interface BasicValueConverter<T,Object>

getReturnedClass

public Class<?> getReturnedClass()

Description copied from interface: Type

The class handled by this type.

Specified by:

getReturnedClass in interface Type

Returns:

The java type class handled by this type.

getJavaType

public Class getJavaType()

Specified by:

getJavaType in interface Type<T>

getName

public String getName()

Description copied from interface: Type

Returns the abbreviated name of the type.

Specified by:

getName in interface Type

Returns:

String the Hibernate type name

isMutable

public boolean isMutable()

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

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

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

Description copied from interface: Type

Bind a value represented by an instance of the mapped class to the JDBC prepared statement, 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

Description copied from interface: Type

Bind a value represented by an instance of the mapped class to the JDBC prepared statement. Implementors should handle 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

Description copied from interface: Type

Generate a representation of the 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

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

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,
                                  Mapping mapping)

Description copied from interface: Type

Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.

Specified by:

toColumnNullness in interface Type

Parameters:

value - an instance of the type

mapping - The mapping abstraction

Returns:

array indicating column nullness for a value instance

isDirty

public boolean isDirty(Object old,
                       Object current,
                       boolean[] checkable,
                       SharedSessionContractImplementor session)
                throws HibernateException

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)

Specified by:

disassemble in interface BasicType<T>

Specified by:

disassemble in interface Bindable

See Also:

As an example, consider the following domain model: ````

getSqlTypeCodes

public int[] getSqlTypeCodes(Mapping mapping)
                      throws MappingException

Description copied from interface: Type

Return the JDBC types codes (per Types) for the columns mapped by this type.

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

Specified by:

getSqlTypeCodes in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The JDBC type codes.

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

getColumnSpan

public int getColumnSpan(Mapping mapping)
                  throws MappingException

Description copied from interface: Type

How many columns are used to persist this type. Always the same as sqlTypes(mapping).length

Specified by:

getColumnSpan in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The number of columns

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

canDoExtraction

public boolean canDoExtraction()

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()

Description copied from interface: DomainType

The descriptor for the Java type (i.e. Class) represented by this DomainType.

Specified by:

getExpressibleJavaType in interface BasicType<T>

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

See Also:

DomainType.getTypeName()

getJavaTypeDescriptor

public JavaType<T> getJavaTypeDescriptor()

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()

Specified by:

getMappedJavaType in interface BasicType<T>

Specified by:

getMappedJavaType in interface JdbcMapping

Specified by:

getMappedJavaType in interface MappingType

getJdbcType

public JdbcType getJdbcType()

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()

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()

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()

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()

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.