站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Hibernate 3.2.4 正式版 API 英文文档

EntityType (Hibernate API Documentation) - Hibernate 3.2.4 正式版 API 英文文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.hibernate.type
Class EntityType

java.lang.Object
  extended byorg.hibernate.type.AbstractType
      extended byorg.hibernate.type.EntityType
All Implemented Interfaces:
AssociationType, Serializable, Type
Direct Known Subclasses:
ManyToOneType, OneToOneType
public abstract class EntityType
extends AbstractType
implements AssociationType

Base for types which map associations to persistent entities.

Author:
Gavin King
See Also:
Serialized Form

Field Summary
protected  boolean isEmbeddedInXML
           
protected  String uniqueKeyPropertyName
           
 
Constructor Summary
protected 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)
          Return a deep copy of the persistent state, stopping at entities and at collections.
 Object fromXMLNode(org.dom4j.Node xml, Mapping factory)
          Parse the XML representation of an instance.
 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()
          Get the name of a property in the owning entity that provides the join key (null if the identifier)
 String getName()
          For entity types, the name correlates to the associated entity name.
 String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters)
          Get the "filtering" SQL fragment that is applied in the SQL on clause, in addition to the usual join condition
 String getPropertyName()
           
 Class getReturnedClass()
          This returns the wrong class for an entity with a proxy, or for a named entity.
 String getRHSUniqueKeyPropertyName()
          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)
 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()
          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.)
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[] names, SessionImplementor session, Object owner)
          Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.
 Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)
          Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.
 Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache)
          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.
 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(org.dom4j.Node node, Object value, SessionFactoryImplementor factory)
          A representation of the value to be embedded in an XML element.
 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, disassemble, getHashCode, hydrate, isAnyType, isCollectionType, isComponentType, isDirty, isEqual, isModified, replace, replaceNode, semiResolve
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.hibernate.type.AssociationType
getForeignKeyDirection, isAlwaysDirtyChecked, useLHSPrimaryKey
 
Methods inherited from interface org.hibernate.type.Type
assemble, beforeAssemble, disassemble, getColumnSpan, getHashCode, hydrate, isAnyType, isCollectionType, isComponentType, isDirty, isDirty, isEqual, isModified, nullSafeSet, nullSafeSet, replace, semiResolve, sqlTypes, toColumnNullness
 

Field Detail

uniqueKeyPropertyName

protected final String uniqueKeyPropertyName

isEmbeddedInXML

protected final boolean isEmbeddedInXML
Constructor Detail

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 Detail

isAssociationType

public boolean isAssociationType()
An entity type is a type of association type

Specified by:
isAssociationType in interface Type
Overrides:
isAssociationType in class AbstractType
Returns:
True.

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()
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 String toString()
Generates a string representation of this type.

Returns:
string rep

getName

public 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 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 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 String getPropertyName()

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.

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.

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String name,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException
Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.

Specified by:
nullSafeGet in interface Type
Parameters:
rs -
name - the column name
session -
owner - the parent entity
Returns:
Object
Throws:
SQLException
HibernateException

nullSafeGet

public final Object nullSafeGet(ResultSet rs,
                                String[] names,
                                SessionImplementor session,
                                Object owner)
                         throws HibernateException,
                                SQLException
Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Specified by:
nullSafeGet in interface Type
Parameters:
rs -
names - the column names
session -
owner - the parent entity
Returns:
Object
Throws:
SQLException
HibernateException
See Also:
alternative, 2-phase property initialization

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 class AbstractType
Parameters:
x - One entity instance
y - Another entity instance
entityMode - The entity mode.
Returns:
True if x == y; false otherwise.

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)

Specified by:
compare in interface Type
Overrides:
compare in class AbstractType

deepCopy

public Object deepCopy(Object value,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.

Specified by:
deepCopy in interface Type
Parameters:
value - generally a collection element or entity field
entityMode -
factory -
Returns:
Object a copy

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache)
               throws HibernateException
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
Returns:
the value to be merged
Throws:
HibernateException

getHashCode

public int getHashCode(Object x,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)

Specified by:
getHashCode in interface Type
Overrides:
getHashCode in class AbstractType

isEqual

public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)

Specified by:
isEqual in interface Type
Overrides:
isEqual in class AbstractType

isEmbeddedInXML

public boolean isEmbeddedInXML()

Specified by:
isEmbeddedInXML in interface AssociationType

isXMLElement

public boolean isXMLElement()

Specified by:
isXMLElement in interface Type
Overrides:
isXMLElement in class AbstractType

fromXMLNode

public Object fromXMLNode(org.dom4j.Node xml,
                          Mapping factory)
                   throws HibernateException
Parse the XML representation of an instance.

Specified by:
fromXMLNode in interface Type
Parameters:
xml -
factory -
Returns:
an instance of the type
Throws:
HibernateException

setToXMLNode

public void setToXMLNode(org.dom4j.Node node,
                         Object value,
                         SessionFactoryImplementor factory)
                  throws HibernateException
A representation of the value to be embedded in an XML element.

Specified by:
setToXMLNode in interface Type
Parameters:
value -
factory -
Returns:
String
Throws:
HibernateException

getOnCondition

public String getOnCondition(String alias,
                             SessionFactoryImplementor factory,
                             Map enabledFilters)
                      throws MappingException
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
Throws:
MappingException

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 class AbstractType
Throws:
HibernateException

getSemiResolvedType

public Type getSemiResolvedType(SessionFactoryImplementor factory)
Description copied from interface: Type
Get the type of a semi-resolved value.

Specified by:
getSemiResolvedType in interface Type
Overrides:
getSemiResolvedType in class AbstractType

getIdentifier

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

isNotEmbedded

protected boolean isNotEmbedded(SessionImplementor session)

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.
Throws:
HibernateException - Generally some form of resolution problem.

isOneToOne

public abstract boolean isOneToOne()

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

isNullable

protected abstract boolean isNullable()

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.

isNull

protected boolean isNull(Object owner,
                         SessionImplementor session)

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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD