Package org.hibernate.type

Class AnyType

java.lang.Object
org.hibernate.type.AbstractType
org.hibernate.type.AnyType
All Implemented Interfaces:
Serializable, AssociationType, CompositeType, Type
public class AnyType extends AbstractType implements CompositeType, AssociationType
Handles "any" mappings
See Also:

  • Constructor Details

  • Method Details

    • getIdentifierType

      public Type getIdentifierType()

    • getDiscriminatorType

      public Type getDiscriminatorType()

    • 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

    • 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.

    • 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.type.MappingContext).

      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.

    • 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

    • isAnyType

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

      An AnyType is additionally an AssociationType; so if this method returns true, then Type.isAssociationType() should also return true.

      Specified by:
      isAnyType in interface Type
      Overrides:
      isAnyType in class AbstractType
      Returns:
      True if this type is also an AnyType implementor; false otherwise.

    • isAssociationType

      public boolean isAssociationType()
      Description copied from interface: Type
      Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association. Shortcut for type instanceof AssociationType.
      Specified by:
      isAssociationType in interface Type
      Overrides:
      isAssociationType in class AbstractType
      Returns:
      True if this type is also an AssociationType implementor; false otherwise.

    • isComponentType

      public 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.

    • 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.

    • 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

    • deepCopy

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

    • 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 factory)
      Specified by:
      compare in interface 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

    • 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

    • 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

    • 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

    • getColumnSpan

      public int getColumnSpan(MappingContext session)
      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:
      session - The mapping Context object MappingContext
      Returns:
      The number of columns

    • 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 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

    • 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 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

    • 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

    • assemble

      public Object assemble(Serializable cached, 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:
      cached - 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

    • 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

    • 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

    • 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.

    • 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

    • 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.

    • 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.

    • getPropertyValues

      public Object[] getPropertyValues(Object component, SharedSessionContractImplementor session) throws HibernateException
      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
      Throws:
      HibernateException - Indicates a problem access 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

    • 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

    • 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.

    • 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.

    • 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.

    • getOnDeleteAction

      public OnDeleteAction getOnDeleteAction(int index)
      Description copied from interface: CompositeType
      Retrieve the on delete action of the indicated component property.
      Specified by:
      getOnDeleteAction in interface CompositeType
      Parameters:
      index - The property index,
      Returns:
      The cascade style.

    • 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

    • getForeignKeyDirection

      public ForeignKeyDirection getForeignKeyDirection()
      Description copied from interface: AssociationType
      Get the foreign key directionality of this association
      Specified by:
      getForeignKeyDirection in interface AssociationType

    • useLHSPrimaryKey

      public boolean useLHSPrimaryKey()
      Description copied from interface: AssociationType
      Is the primary key of the owning entity table to be used in the join?
      Specified by:
      useLHSPrimaryKey in interface AssociationType

    • getLHSPropertyName

      public String getLHSPropertyName()
      Description copied from interface: AssociationType
      Get the name of a property in the owning entity that provides the join key (null if the identifier)
      Specified by:
      getLHSPropertyName in interface AssociationType

    • isReferenceToPrimaryKey

      public boolean isReferenceToPrimaryKey()

    • getRHSUniqueKeyPropertyName

      public String getRHSUniqueKeyPropertyName()
      Description copied from interface: AssociationType
      The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)
      Specified by:
      getRHSUniqueKeyPropertyName in interface AssociationType

    • isAlwaysDirtyChecked

      public boolean isAlwaysDirtyChecked()
      Description copied from interface: AssociationType
      Do we dirty check this association, even when there are no columns to be updated?
      Specified by:
      isAlwaysDirtyChecked in interface AssociationType

    • getAssociatedJoinable

      public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)
      Description copied from interface: AssociationType
      Get the "persister" for this association - a class or collection persister
      Specified by:
      getAssociatedJoinable in interface AssociationType

    • getAssociatedEntityName

      public String getAssociatedEntityName(SessionFactoryImplementor factory)
      Description copied from interface: AssociationType
      Get the entity name of the associated entity
      Specified by:
      getAssociatedEntityName in interface AssociationType