Package org.hibernate.type

Class EntityType

    • Field Detail

      • uniqueKeyPropertyName

        protected final java.lang.String uniqueKeyPropertyName

    • Constructor Detail

      • EntityType

        @Deprecated
protected EntityType​(TypeFactory.TypeScope scope,
                     java.lang.String entityName,
                     java.lang.String uniqueKeyPropertyName,
                     boolean eager,
                     boolean unwrapProxy)
        Deprecated.
        Use EntityType(org.hibernate.type.TypeFactory.TypeScope, String, boolean, String, boolean, boolean) instead.
        Constructs the requested entity type mapping.
        Parameters:
        scope - The type scope
        entityName - The name of the associated entity.
        uniqueKeyPropertyName - The property-ref name, or null if we reference the PK of the associated entity.
        eager - Is eager fetching enabled.
        unwrapProxy - Is unwrapping of proxies allowed for this association; unwrapping says to return the "implementation target" of lazy proxies; typically only possible with lazy="no-proxy".

      • EntityType

        protected EntityType​(TypeFactory.TypeScope scope,
                     java.lang.String entityName,
                     boolean referenceToPrimaryKey,
                     java.lang.String uniqueKeyPropertyName,
                     boolean eager,
                     boolean unwrapProxy)
        Constructs the requested entity type mapping.
        Parameters:
        scope - The type scope
        entityName - The name of the associated entity.
        referenceToPrimaryKey - True if association references a primary key.
        uniqueKeyPropertyName - The property-ref name, or null if we reference the PK of the associated entity.
        eager - Is eager fetching enabled.
        unwrapProxy - Is unwrapping of proxies allowed for this association; unwrapping says to return the "implementation target" of lazy proxies; typically only possible with lazy="no-proxy".

      • EntityType

        protected EntityType​(EntityType original,
                     java.lang.String superTypeEntityName)

    • Method Detail

      • isEntityType

        public final boolean isEntityType()
        Explicitly, an entity type is an entity type ;)
        Specified by:
        isEntityType in interface Type
        Overrides:
        isEntityType in class AbstractType
        Returns:
        True.

      • 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

      • toString

        public java.lang.String toString()
        Generates a string representation of this type.
        Overrides:
        toString in class java.lang.Object
        Returns:
        string rep

      • getName

        public java.lang.String getName()
        For entity types, the name correlates to the associated entity name.
        Specified by:
        getName in interface Type
        Returns:
        String the Hibernate type name

      • isReferenceToPrimaryKey

        public boolean isReferenceToPrimaryKey()
        Does this association foreign key reference the primary key of the other table? Otherwise, it references a property-ref.
        Returns:
        True if this association reference the PK of the associated entity.

      • getRHSUniqueKeyPropertyName

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

      • getLHSPropertyName

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

      • getPropertyName

        public java.lang.String getPropertyName()

      • getAssociatedEntityName

        public final java.lang.String getAssociatedEntityName()
        The name of the associated entity.
        Returns:
        The associated entity name.

      • getReturnedClass

        public final java.lang.Class getReturnedClass()
        This returns the wrong class for an entity with a proxy, or for a named entity. Theoretically it should return the proxy class, but it doesn't.

        The problem here is that we do not necessarily have a ref to the associated entity persister (nor to the session factory, to look it up) which is really needed to "do the right thing" here...

        Specified by:
        getReturnedClass in interface Type
        Returns:
        The entity class.

      • nullSafeGet

        public java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                    java.lang.String name,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
                             throws HibernateException,
                                    java.sql.SQLException
        Description copied from interface: Type
        Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values. This form might be called if the type is known to be a single-column type.
        Specified by:
        nullSafeGet in interface Type
        Parameters:
        rs - The result set from which to extract value.
        name - the column name making up this type value (use to read from result set)
        session - The originating session
        owner - the parent entity
        Returns:
        The extracted value
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeGet

        public final java.lang.Object nullSafeGet​(java.sql.ResultSet rs,
                                          java.lang.String[] names,
                                          SharedSessionContractImplementor session,
                                          java.lang.Object owner)
                                   throws HibernateException,
                                          java.sql.SQLException
        Description copied from interface: Type
        Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values.
        Specified by:
        nullSafeGet in interface Type
        Parameters:
        rs - The result set from which to extract value.
        names - the column names making up this type value (use to read from result set)
        session - The originating session
        owner - the parent entity
        Returns:
        The extracted value
        Throws:
        HibernateException - An error from Hibernate
        java.sql.SQLException - An error from the JDBC driver
        See Also:
        alternative, 2-phase property initialization

      • nullSafeSet

        public void nullSafeSet​(java.sql.PreparedStatement st,
                        java.lang.Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws java.sql.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:
        java.sql.SQLException - An error from the JDBC driver

      • nullSafeSet

        public void nullSafeSet​(java.sql.PreparedStatement st,
                        java.lang.Object value,
                        int index,
                        SharedSessionContractImplementor session)
                 throws java.sql.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:
        java.sql.SQLException - An error from the JDBC driver

      • isSame

        public final boolean isSame​(java.lang.Object x,
                            java.lang.Object y)
        Two entities are considered the same when their instances are the same.
        Specified by:
        isSame in interface Type
        Overrides:
        isSame in class AbstractType
        Parameters:
        x - One entity instance
        y - Another entity instance
        Returns:
        True if x == y; false otherwise.

      • compare

        public int compare​(java.lang.Object x,
                   java.lang.Object y)
        Description copied from interface: Type
        Perform a Comparator style comparison between 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 Comparator.compare(T, T) for a discussion.

      • deepCopy

        public java.lang.Object deepCopy​(java.lang.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

      • replace

        public java.lang.Object replace​(java.lang.Object original,
                                java.lang.Object target,
                                SharedSessionContractImplementor session,
                                java.lang.Object owner,
                                java.util.Map 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

      • getHashCode

        public int getHashCode​(java.lang.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

      • isEqual

        public boolean isEqual​(java.lang.Object x,
                       java.lang.Object y,
                       SessionFactoryImplementor factory)
        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).

      • getOnCondition

        public java.lang.String getOnCondition​(java.lang.String alias,
                                       SessionFactoryImplementor factory,
                                       java.util.Map enabledFilters)
        Description copied from interface: AssociationType
        Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
        Specified by:
        getOnCondition in interface AssociationType

      • getOnCondition

        public java.lang.String getOnCondition​(java.lang.String alias,
                                       SessionFactoryImplementor factory,
                                       java.util.Map enabledFilters,
                                       java.util.Set<java.lang.String> treatAsDeclarations)
        Description copied from interface: AssociationType
        Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
        Specified by:
        getOnCondition in interface AssociationType

      • isEager

        public boolean isEager​(java.lang.Boolean overridingEager)
        Would an entity be eagerly loaded given the value provided for overridingEager?
        Parameters:
        overridingEager - can override eager from the mapping.
        Returns:
        If overridingEager is null, then it does not override. If true or false then it overrides the mapping value.

      • getSemiResolvedType

        public Type getSemiResolvedType​(SessionFactoryImplementor factory)
        Description copied from interface: Type
        As part of 2-phase loading, when we perform resolving what is the resolved type for this type? Generally speaking the type and its semi-resolved type will be the same. The main deviation from this is in the case of an entity where the type would be the entity type and semi-resolved type would be its identifier type
        Specified by:
        getSemiResolvedType in interface Type
        Overrides:
        getSemiResolvedType in class AbstractType
        Parameters:
        factory - The session factory
        Returns:
        The semi-resolved type

      • toLoggableString

        public java.lang.String toLoggableString​(java.lang.Object value,
                                         SessionFactoryImplementor factory)
        Generate a loggable representation of an instance of the value mapped by this type.
        Specified by:
        toLoggableString in interface Type
        Parameters:
        value - The instance to be logged.
        factory - The session factory.
        Returns:
        The loggable string.
        Throws:
        HibernateException - Generally some form of resolution problem.

      • isOneToOne

        public abstract boolean isOneToOne()
        Is the association modeled here defined as a 1-1 in the database (physical model)?
        Returns:
        True if a 1-1 in the database; false otherwise.

      • isLogicalOneToOne

        public boolean isLogicalOneToOne()
        Is the association modeled here a 1-1 according to the logical model?
        Returns:
        True if a 1-1 in the logical model; false otherwise.

      • getIdentifierOrUniqueKeyType

        public final Type getIdentifierOrUniqueKeyType​(Mapping factory)
                                        throws MappingException
        Determine the type of either (1) the identifier if we reference the associated entity's PK or (2) the unique key to which we refer (i.e. the property-ref).
        Parameters:
        factory - The mappings...
        Returns:
        The appropriate type.
        Throws:
        MappingException - Generally, if unable to resolve the associated entity name or unique key property name.

      • getIdentifierOrUniqueKeyPropertyName

        public final java.lang.String getIdentifierOrUniqueKeyPropertyName​(Mapping factory)
                                                            throws MappingException
        The name of the property on the associated entity to which our FK refers
        Parameters:
        factory - The mappings...
        Returns:
        The appropriate property name.
        Throws:
        MappingException - Generally, if unable to resolve the associated entity name

      • isReferenceToIdentifierProperty

        public boolean isReferenceToIdentifierProperty()

      • isNullable

        public abstract boolean isNullable()
        The nullability of the property.
        Returns:
        The nullability of the property.

      • getNotFoundAction

        public abstract NotFoundAction getNotFoundAction()

      • hasNotFoundAction

        public boolean hasNotFoundAction()

      • resolveIdentifier

        protected final java.lang.Object resolveIdentifier​(java.io.Serializable id,
                                                   SharedSessionContractImplementor session,
                                                   java.lang.Boolean overridingEager)
                                            throws HibernateException
        Resolve an identifier via a load.
        Parameters:
        id - The entity id to resolve
        session - The originating session.
        Returns:
        The resolved identifier (i.e., loaded entity).
        Throws:
        HibernateException - Indicates problems performing the load.

      • loadByUniqueKey

        public java.lang.Object loadByUniqueKey​(java.lang.String entityName,
                                        java.lang.String uniqueKeyPropertyName,
                                        java.lang.Object key,
                                        SharedSessionContractImplementor session)
                                 throws HibernateException
        Load an instance by a unique key that is not the primary key.
        Parameters:
        entityName - The name of the entity to load
        uniqueKeyPropertyName - The name of the property defining the unique key.
        key - The unique key property value.
        session - The originating session.
        Returns:
        The loaded entity
        Throws:
        HibernateException - generally indicates problems performing the load.

      • requireIdentifierOrUniqueKeyType

        protected Type requireIdentifierOrUniqueKeyType​(Mapping mapping)