Class ComponentType

    • Field Detail

      • propertySpan

        protected final int propertySpan
    • Method Detail

      • isKey

        public boolean isKey()
      • 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.
      • dictatedSizes

        public Size[] dictatedSizes​(Mapping mapping)
                             throws MappingException
        Description copied from interface: Type
        Return the column sizes dictated by this type. For example, the mapping for a char/Character would have a dictated length limit of 1; for a string-based UUID would have a size limit of 36; etc.

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

        Specified by:
        dictatedSizes in interface Type
        Parameters:
        mapping - The mapping object :/
        Returns:
        The dictated sizes.
        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. Essentially a polymorphic version of (type instanceof CompositeType.class). 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 returned by #nullSafeGet methods. This is used to establish the class of an array of this type.
        Specified by:
        getReturnedClass in interface Type
        Returns:
        The java type 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" (equality of persistent state) taking a shortcut for entity references.

        For most types this should equate to an equals check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate to Type.isEqual(java.lang.Object, java.lang.Object)

        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" (equality of persistent state).

        This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, 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" (equality of persistent state).

        This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, 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
      • 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". Again for most types the normal usage is to delegate to the 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". Again for most types the normal usage is to delegate to the 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
        factory - The session factory
        Returns:
        The hash code
      • 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
      • 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 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
        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 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
        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.
      • getPropertyValueGenerationStrategies

        public ValueGeneration[] getPropertyValueGenerationStrategies()
      • 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
      • 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 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 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 value Hibernate will use in second level caching, so care should be taken to break values down to their simplest forms; for entities especially, this means breaking them down into their constituent parts.
        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
      • 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,
                                          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
      • 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()
      • getPersistenceType

        public jakarta.persistence.metamodel.Type.PersistenceType getPersistenceType()
        Specified by:
        getPersistenceType in interface jakarta.persistence.metamodel.Type
      • getJavaType

        public Class getJavaType()
        Specified by:
        getJavaType in interface jakarta.persistence.metamodel.Type