org.hibernate.type

Class EntityType

Implemented Interfaces:
AssociationType, Serializable, Type
Known Direct Subclasses:
ManyToOneType, OneToOneType

public abstract class EntityType
extends AbstractType
implements AssociationType

Base for types which map associations to persistent entities.
Author:
Gavin King

Field Summary

protected boolean
isEmbeddedInXML
protected String
uniqueKeyPropertyName

Constructor Summary

EntityType(String entityName, String uniqueKeyPropertyName, boolean eager, boolean isEmbeddedInXML, boolean unwrapProxy)
Constructs the requested entity type mapping.

Method Summary

int
compare(Object x, Object y, EntityMode entityMode)
Object
deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory)
Object
fromXMLNode(Node xml, Mapping factory)
String
getAssociatedEntityName()
The name of the associated entity.
String
getAssociatedEntityName(SessionFactoryImplementor factory)
The name of the associated entity.
Joinable
getAssociatedJoinable(SessionFactoryImplementor factory)
Retrieves the Joinable defining the associated entity.
int
getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory)
protected Object
getIdentifier(Object value, SessionImplementor session)
String
getIdentifierOrUniqueKeyPropertyName(Mapping factory)
The name of the property on the associated entity to which our FK refers
Type
getIdentifierOrUniqueKeyType(Mapping factory)
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.
String
getLHSPropertyName()
String
getName()
For entity types, the name correlates to the associated entity name.
String
getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters)
String
getPropertyName()
String
getRHSUniqueKeyPropertyName()
Class
getReturnedClass()
This returns the wrong class for an entity with a proxy, or for a named entity.
Type
getSemiResolvedType(SessionFactoryImplementor factory)
Get the type of a semi-resolved value.
boolean
isAssociationType()
An entity type is a type of association type
boolean
isEmbeddedInXML()
boolean
isEntityType()
Explicitly, an entity type is an entity type ;)
boolean
isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory)
boolean
isMutable()
protected boolean
isNotEmbedded(SessionImplementor session)
protected boolean
isNull(Object owner, SessionImplementor session)
protected abstract boolean
isNullable()
abstract boolean
isOneToOne()
boolean
isReferenceToPrimaryKey()
Does this association foreign key reference the primary key of the other table? Otherwise, it references a property-ref.
boolean
isSame(Object x, Object y, EntityMode entityMode)
Two entities are considered the same when their instances are the same.
boolean
isXMLElement()
Object
loadByUniqueKey(String entityName, String uniqueKeyPropertyName, Object key, SessionImplementor session)
Load an instance by a unique key that is not the primary key.
Object
nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)
Object
nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Object
replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache)
Object
resolve(Object value, SessionImplementor session, Object owner)
Resolve an identifier or unique key value
protected Object
resolveIdentifier(Serializable id, SessionImplementor session)
Resolve an identifier via a load.
void
setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
String
toLoggableString(Object value, SessionFactoryImplementor factory)
Generate a loggable representation of an instance of the value mapped by this type.
String
toString()
Generates a string representation of this type.

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, compare, disassemble, getHashCode, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve

Field Details

isEmbeddedInXML

protected final boolean isEmbeddedInXML

uniqueKeyPropertyName

protected final String uniqueKeyPropertyName

Constructor Details

EntityType

protected EntityType(String entityName,
                     String uniqueKeyPropertyName,
                     boolean eager,
                     boolean isEmbeddedInXML,
                     boolean unwrapProxy)
Constructs the requested entity type mapping.
Parameters:
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.
isEmbeddedInXML - Should values of this mapping be embedded in XML modes?
unwrapProxy - Is unwrapping of proxies allowed for this association; unwrapping says to return the "implementation target" of lazy prooxies; typically only possible with lazy="no-proxy".

Method Details

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)
Specified by:
compare in interface Type
Overrides:
compare in interface AbstractType

deepCopy

public Object deepCopy(Object value,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
Specified by:
deepCopy in interface Type

fromXMLNode

public Object fromXMLNode(Node xml,
                          Mapping factory)
            throws HibernateException
Specified by:
fromXMLNode in interface Type

getAssociatedEntityName

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

getAssociatedEntityName

public String getAssociatedEntityName(SessionFactoryImplementor factory)
The name of the associated entity.
Specified by:
getAssociatedEntityName in interface AssociationType
Parameters:
factory - The session factory, for resolution.
Returns:
The associated entity name.

getAssociatedJoinable

public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)
            throws MappingException
Retrieves the Joinable defining the associated entity.
Specified by:
getAssociatedJoinable in interface AssociationType
Parameters:
factory - The session factory.
Returns:
The associated joinable
Throws:
MappingException - Generally indicates an invalid entity name.

getHashCode

public int getHashCode(Object x,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
Specified by:
getHashCode in interface Type
Overrides:
getHashCode in interface AbstractType

getIdentifier

protected final Object getIdentifier(Object value,
                                     SessionImplementor session)
            throws HibernateException

getIdentifierOrUniqueKeyPropertyName

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

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.

getLHSPropertyName

public String getLHSPropertyName()
Specified by:
getLHSPropertyName in interface AssociationType

getName

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

getOnCondition

public String getOnCondition(String alias,
                             SessionFactoryImplementor factory,
                             Map enabledFilters)
            throws MappingException
Specified by:
getOnCondition in interface AssociationType

getPropertyName

public String getPropertyName()

getRHSUniqueKeyPropertyName

public String getRHSUniqueKeyPropertyName()
Specified by:
getRHSUniqueKeyPropertyName in interface AssociationType

getReturnedClass

public final 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 entiyt class.

getSemiResolvedType

public Type getSemiResolvedType(SessionFactoryImplementor factory)
Get the type of a semi-resolved value.
Specified by:
getSemiResolvedType in interface Type
Overrides:
getSemiResolvedType in interface AbstractType

isAssociationType

public boolean isAssociationType()
An entity type is a type of association type
Specified by:
isAssociationType in interface Type
Overrides:
isAssociationType in interface AbstractType
Returns:
True.

isEmbeddedInXML

public boolean isEmbeddedInXML()
Specified by:
isEmbeddedInXML in interface AssociationType

isEntityType

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

isEqual

public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
Specified by:
isEqual in interface Type
Overrides:
isEqual in interface AbstractType

isMutable

public boolean isMutable()
Specified by:
isMutable in interface Type

isNotEmbedded

protected boolean isNotEmbedded(SessionImplementor session)

isNull

protected boolean isNull(Object owner,
                         SessionImplementor session)

isNullable

protected abstract boolean isNullable()

isOneToOne

public abstract boolean isOneToOne()

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.

isSame

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

isXMLElement

public boolean isXMLElement()
Specified by:
isXMLElement in interface Type
Overrides:
isXMLElement in interface AbstractType

loadByUniqueKey

public Object loadByUniqueKey(String entityName,
                              String uniqueKeyPropertyName,
                              Object key,
                              SessionImplementor 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 uniqie key.
key - The unique key property value.
session - The originating session.
Returns:
The loaded entity
Throws:
HibernateException - generally indicates problems performing the load.

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String name,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException,
                   SQLException
Specified by:
nullSafeGet in interface Type

nullSafeGet

public final Object nullSafeGet(ResultSet rs,
                                String[] names,
                                SessionImplementor session,
                                Object owner)
            throws HibernateException,
                   SQLException
Specified by:
nullSafeGet in interface Type

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache)
            throws HibernateException
Specified by:
replace in interface Type

resolve

public Object resolve(Object value,
                      SessionImplementor session,
                      Object owner)
            throws HibernateException
Resolve an identifier or unique key value
Specified by:
resolve in interface Type
Overrides:
resolve in interface AbstractType

resolveIdentifier

protected final Object resolveIdentifier(Serializable id,
                                         SessionImplementor session)
            throws HibernateException
Resolve an identifier via a load.
Parameters:
id - The entity id to resolve
session - The orginating session.
Returns:
The resolved identifier (i.e., loaded entity).
Throws:
HibernateException - Indicates problems performing the load.

setToXMLNode

public void setToXMLNode(Node node,
                         Object value,
                         SessionFactoryImplementor factory)
            throws HibernateException
Specified by:
setToXMLNode in interface Type

toLoggableString

public String toLoggableString(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.

toString

public String toString()
Generates a string representation of this type.
Returns:
string rep