Package org.hibernate.type

Class ComponentType

java.lang.Object
org.hibernate.type.AbstractType
org.hibernate.type.ComponentType
All Implemented Interfaces:
Serializable, BindableType, OutputableType, CompositeType, ProcedureParameterExtractionAware, CompositeTypeImplementor, Type
Direct Known Subclasses:
EmbeddedComponentType, UserComponentType
public class ComponentType extends AbstractType implements CompositeTypeImplementor, ProcedureParameterExtractionAware
Handles embedded mappings.
See Also:

  • Field Details

    • propertySpan

      protected final int propertySpan

  • Constructor Details

    • ComponentType

      public ComponentType(Component component, int[] originalPropertyOrder)

    • ComponentType

      public ComponentType(Component component, int[] originalPropertyOrder, boolean mutable)

  • Method Details

    • isKey

      public boolean isKey()

    • getColumnSpan

      public int getColumnSpan(MappingContext mapping) throws MappingException
      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.

    • getSqlTypeCodes

      public int[] getSqlTypeCodes(MappingContext mappingContext) throws MappingException
      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.

    • isComponentType

      public final boolean isComponentType()
      Description copied from interface: Type
      Return true if the implementation is castable to CompositeType. Shortcut for type instanceof CompositeType.

      A component type may own collections or associations and hence must provide certain extra functionality.

      Specified by:
      isComponentType in interface Type
      Overrides:
      isComponentType in class AbstractType
      Returns:
      True if this type is also a CompositeType implementor; false otherwise.

    • getReturnedClass

      public Class<?> getReturnedClass()
      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.

    • isSame

      public boolean isSame(Object x, Object y) throws HibernateException
      Description copied from interface: Type
      Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state, taking a shortcut for entity references.

      For most types this should boil down to an equality comparison of the given values, and it's reasonable to simply delegate to Type.isEqual(Object, Object). But for associations the semantics are a bit different.

      Specified by:
      isSame in interface Type
      Overrides:
      isSame in class AbstractType
      Parameters:
      x - The first value
      y - The second value
      Returns:
      True if there are considered the same (see discussion above).
      Throws:
      HibernateException - A problem occurred performing the comparison

    • isEqual

      public boolean isEqual(Object x, Object y) throws HibernateException
      Description copied from interface: Type
      Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state. For most types this could simply delegate to equals().

      This should always equate to some form of comparison of the value's internal state. As an example, for Java's Date class, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).

      Specified by:
      isEqual in interface Type
      Overrides:
      isEqual in class AbstractType
      Parameters:
      x - The first value
      y - The second value
      Returns:
      True if there are considered equal (see discussion above).
      Throws:
      HibernateException - A problem occurred performing the comparison

    • isEqual

      public boolean isEqual(Object x, Object y, SessionFactoryImplementor factory) throws HibernateException
      Description copied from interface: Type
      Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state. For most types this could simply delegate to Type.isEqual(Object, Object).

      This should always equate to some form of comparison of the value's internal state. As an example, for Java's Date class, the comparison should be of its internal state, but based only on the specific part which is persistent (the timestamp, date, or time).

      Specified by:
      isEqual in interface Type
      Overrides:
      isEqual in class AbstractType
      Parameters:
      x - The first value
      y - The second value
      factory - The session factory
      Returns:
      True if there are considered equal (see discussion above).
      Throws:
      HibernateException - A problem occurred performing the comparison

    • compare

      public int compare(Object x, Object y)
      Description copied from interface: Type
      Perform a Comparator-style comparison of the given values.
      Specified by:
      compare in interface Type
      Overrides:
      compare in class AbstractType
      Parameters:
      x - The first value
      y - The second value
      Returns:
      The comparison result.
      See Also:

    • compare

      public int compare(Object x, Object y, SessionFactoryImplementor sessionFactory)
      Specified by:
      compare in interface Type

    • isMethodOf

      public boolean isMethodOf(Method method)
      Description copied from interface: CompositeType
      Is the given method a member of this component's class?
      Specified by:
      isMethodOf in interface CompositeType
      Parameters:
      method - The method to check
      Returns:
      True if the method is a member; false otherwise.

    • getHashCode

      public int getHashCode(Object x)
      Description copied from interface: Type
      Get a hash code, consistent with persistence "equality". For most types this could simply delegate to the given value's hashCode.
      Specified by:
      getHashCode in interface Type
      Overrides:
      getHashCode in class AbstractType
      Parameters:
      x - The value for which to retrieve a hash code
      Returns:
      The hash code

    • getHashCode

      public int getHashCode(Object x, SessionFactoryImplementor factory)
      Description copied from interface: Type
      Get a hash code, consistent with persistence "equality". For most types this could simply delegate to Type.getHashCode(Object).
      Specified by:
      getHashCode in interface Type
      Overrides:
      getHashCode in class AbstractType
      Parameters:
      x - The value for which to retrieve a hash code
      factory - The session factory
      Returns:
      The hash code

    • isDirty

      public boolean isDirty(Object x, Object y, 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
      Overrides:
      isDirty in class AbstractType
      Parameters:
      x - the old value
      y - the current value
      session - The session from which the request originated.
      Returns:
      true if the field is dirty
      Throws:
      HibernateException - A problem occurred performing the checking

    • isDirty

      public boolean isDirty(Object x, Object y, 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:
      x - the old value
      y - 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

    • isModified

      public boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: Type
      Has the value been modified compared to the current database state? The difference between this and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) methods is that here we need to account for "partially" built values. This is really only an issue with association types. For most type implementations it is enough to simply delegate to Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor).
      Specified by:
      isModified in interface Type
      Overrides:
      isModified in class AbstractType
      Parameters:
      old - the database state, in a "hydrated" form, with identifiers unresolved
      current - the current state of the object
      checkable - which columns are actually checkable
      session - The session from which the request originated.
      Returns:
      true if the field has been modified
      Throws:
      HibernateException - A problem occurred performing the checking

    • nullSafeSet

      public void nullSafeSet(PreparedStatement st, Object value, int begin, SharedSessionContractImplementor session) throws HibernateException, SQLException
      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
      begin - starting parameter bind index
      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 begin, 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 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
      begin - 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

    • getPropertyValue

      public Object getPropertyValue(Object component, int i, SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: CompositeType
      Extract a particular component property value indicated by index.
      Specified by:
      getPropertyValue in interface CompositeType
      Parameters:
      component - The component instance
      i - The index of the property whose value is to be extracted
      session - The session from which the request originates.
      Returns:
      The extracted component property value
      Throws:
      HibernateException - Indicates a problem access the property value.

    • getPropertyValue

      public Object getPropertyValue(Object component, int i)

    • getPropertyValues

      public Object[] getPropertyValues(Object component, SharedSessionContractImplementor session)
      Description copied from interface: CompositeType
      Extract the values of the component properties from the given component instance
      Specified by:
      getPropertyValues in interface CompositeType
      Parameters:
      component - The component instance
      session - The session from which the request originates
      Returns:
      The property values

    • getPropertyValues

      public Object[] getPropertyValues(Object component)
      Description copied from interface: CompositeType
      Extract the values of the component properties from the given component instance without access to the session.

      An optional operation

      Specified by:
      getPropertyValues in interface CompositeType
      Parameters:
      component - The component instance
      Returns:
      The property values

    • setPropertyValues

      public void setPropertyValues(Object component, Object[] values)
      Description copied from interface: CompositeType
      Inject property values onto the given component instance

      An optional operation

      Specified by:
      setPropertyValues in interface CompositeType
      Parameters:
      component - The component instance
      values - The values to inject

    • getSubtypes

      public Type[] getSubtypes()
      Description copied from interface: CompositeType
      Get the types of the component properties
      Specified by:
      getSubtypes in interface CompositeType
      Returns:
      The component property types.

    • getName

      public String getName()
      Description copied from interface: Type
      Returns the abbreviated name of the type.
      Specified by:
      getName in interface Type
      Returns:
      the Hibernate type name

    • toLoggableString

      public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
      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

    • getPropertyNames

      public String[] getPropertyNames()
      Description copied from interface: CompositeType
      Get the names of the component properties
      Specified by:
      getPropertyNames in interface CompositeType
      Returns:
      The component property names

    • deepCopy

      public Object deepCopy(Object component, SessionFactoryImplementor factory)
      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:
      component - The value to be copied
      factory - The session factory
      Returns:
      The deep copy

    • replace

      public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map<Object,Object> copyCache)
      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

    • replace

      public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map<Object,Object> copyCache, ForeignKeyDirection foreignKeyDirection)
      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
      Overrides:
      replace in class AbstractType
      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
      foreignKeyDirection - For associations, which direction does the foreign key point?
      Returns:
      the value to be merged

    • getCascadeStyle

      public CascadeStyle getCascadeStyle(int i)
      Description copied from interface: CompositeType
      Retrieve the cascade style of the indicated component property.
      Specified by:
      getCascadeStyle in interface CompositeType
      Parameters:
      i - The property index,
      Returns:
      The cascade style.

    • 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

    • disassemble

      public Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
      Description copied from interface: Type
      Return a disassembled representation of the object. This is the representation that is stored in the second-level cache.

      A reference to an associated entity should be disassembled to its primary key value.

      Specified by:
      disassemble in interface Type
      Overrides:
      disassemble in class AbstractType
      Parameters:
      value - the value to cache
      session - the originating session
      owner - optional parent entity object (needed for collections)
      Returns:
      the disassembled, deep cloned state
      Throws:
      HibernateException - An error from Hibernate

    • disassemble

      public Serializable disassemble(Object value, SessionFactoryImplementor sessionFactory) throws HibernateException
      Description copied from interface: Type
      Return a disassembled representation of the object. This is the representation that is stored in the second-level cache.

      A reference to an associated entity should be disassembled to its primary key value.

      A high-quality implementation of this method should ensure that: 

       Objects.equals(disassemble(x,s), disassemble(y,s)) == isEqual(x,y,sf)

      and that: 

       Objects.equals(x, assemble(disassemble(x,s),s,o))

      That is, the implementation must be consistent with Type.isEqual(Object, Object, SessionFactoryImplementor) and with Type.assemble(Serializable, SharedSessionContractImplementor, Object).

      Specified by:
      disassemble in interface Type
      Overrides:
      disassemble in class AbstractType
      Parameters:
      value - the value to cache
      sessionFactory - the session factory
      Returns:
      the disassembled, deep cloned state
      Throws:
      HibernateException - An error from Hibernate

    • assemble

      public Object assemble(Serializable object, SharedSessionContractImplementor session, Object owner) throws HibernateException
      Description copied from interface: Type
      Reconstruct the object from its disassembled state. This function is the inverse of Type.disassemble(Object, SharedSessionContractImplementor, Object).
      Specified by:
      assemble in interface Type
      Overrides:
      assemble in class AbstractType
      Parameters:
      object - the disassembled state from the cache
      session - the originating session
      owner - the parent entity object
      Returns:
      the (re)assembled object
      Throws:
      HibernateException - An error from Hibernate

    • getFetchMode

      public FetchMode getFetchMode(int i)
      Description copied from interface: CompositeType
      Retrieve the fetch mode of the indicated component property.
      Specified by:
      getFetchMode in interface CompositeType
      Parameters:
      i - The property index,
      Returns:
      The fetch mode

    • getPropertyNullability

      public boolean[] getPropertyNullability()
      Description copied from interface: CompositeType
      Retrieve the indicators regarding which component properties are nullable.

      An optional operation

      Specified by:
      getPropertyNullability in interface CompositeType
      Returns:
      nullability of component properties

    • toColumnNullness

      public boolean[] toColumnNullness(Object value, MappingContext mapping)
      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

    • isEmbedded

      public boolean isEmbedded()
      Description copied from interface: CompositeType
      Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner
      Specified by:
      isEmbedded in interface CompositeType
      Returns:
      True if this component is embedded; false otherwise.

    • getPropertyIndex

      public int getPropertyIndex(String name)
      Description copied from interface: CompositeType
      Convenience method for locating the property index for a given property name.
      Specified by:
      getPropertyIndex in interface CompositeType
      Parameters:
      name - The (sub-)property name to find.
      Returns:
      The (sub-)property index, relative to all the array-valued method returns defined on this contract.

    • getOriginalPropertyOrder

      public int[] getOriginalPropertyOrder()

    • 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
      Returns:
      true indicates that OutputableType.extract(java.sql.CallableStatement, int, org.hibernate.engine.spi.SharedSessionContractImplementor) calls will not fail due to IllegalStateException.

    • getJdbcType

      public JdbcType getJdbcType()
      Description copied from interface: OutputableType
      Descriptor for the SQL type mapped by this type.
      Specified by:
      getJdbcType in interface OutputableType

    • extract

      public Object extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session) throws SQLException
      Description copied from interface: OutputableType
      Perform the extraction
      Specified by:
      extract in interface OutputableType
      Parameters:
      statement - The CallableStatement from which to extract the parameter value(s).
      startIndex - 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 Object extract(CallableStatement statement, String paramName, SharedSessionContractImplementor session) throws SQLException
      Description copied from interface: OutputableType
      Perform the extraction
      Specified by:
      extract in interface OutputableType
      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

    • instantiator

      protected final EmbeddableInstantiator instantiator(Object compositeInstance)

    • hasNotNullProperty

      public boolean hasNotNullProperty()
      Description copied from interface: CompositeType
      Convenience method to quickly check CompositeType.getPropertyNullability() for any non-nullable sub-properties.
      Specified by:
      hasNotNullProperty in interface CompositeType
      Returns:
      true if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability(), false otherwise.

    • hasNullProperty

      public boolean hasNullProperty()
      Description copied from interface: CompositeType
      Convenience method to quickly check if CompositeType.getPropertyNullability() contains a nullable sub-properties.
      Specified by:
      hasNullProperty in interface CompositeType
      Returns:
      true if any of the properties are nullable as indicated by CompositeType.getPropertyNullability(), false otherwise.

    • getBindableJavaType

      public Class<?> getBindableJavaType()
      Description copied from interface: BindableType
      The expected Java type
      Specified by:
      getBindableJavaType in interface BindableType

    • resolveExpressible

      public SqmExpressible<?> resolveExpressible(BindingContext bindingContext)
      Description copied from interface: BindableType
      Resolve this parameter type to the corresponding SqmExpressible
      Specified by:
      resolveExpressible in interface BindableType

    • injectMappingModelPart

      public void injectMappingModelPart(EmbeddableValuedModelPart part, MappingModelCreationProcess process)
      Specified by:
      injectMappingModelPart in interface CompositeTypeImplementor

    • getMappingModelPart

      public EmbeddableValuedModelPart getMappingModelPart()
      Specified by:
      getMappingModelPart in interface CompositeTypeImplementor

    • mappingModelPart

      public EmbeddableValuedModelPart mappingModelPart()

    • replacePropertyValues

      public Object replacePropertyValues(Object component, Object[] values, SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: CompositeType
      Inject property values onto the given component instance, or return a new instance with the given property values.
      Specified by:
      replacePropertyValues in interface CompositeType
      Parameters:
      component - The component instance
      values - The values to inject
      Returns:
      A new instance as necessary
      Throws:
      HibernateException - Indicates an issue performing the injection