Modifier and Type	Class and Description
public static class	Dom4jEntityTuplizer.BasicEntityNameResolver

Modifier and Type	Field and Description
private Map<K, V>	inheritenceNodeNameMap
pack-priv static final Logger	log Hides org.hibernate.tuple.entity.AbstractEntityTuplizer.log.

Access	Constructor and Description
pack-priv	Dom4jEntityTuplizer(EntityMetamodel entityMetamodel, PersistentClass mappedEntity)

Method Summary

Modifier and Type	Method and Description
protected Instantiator	buildInstantiator(PersistentClass The mapping information regarding the mapped entity. persistentClass) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildInstantiator. Build an appropriate Instantiator for the given mapped entity.
private PropertyAccessor	buildPropertyAccessor(Property mappedProperty)
protected Getter	buildPropertyGetter(Property The property to be accessed via the built Getter. mappedProperty, PersistentClass The entity information regarding the mapped entity owning this property. mappedEntity) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertyGetter. Build an appropriate Getter for the given property.
protected Setter	buildPropertySetter(Property The property to be accessed via the built Setter. mappedProperty, PersistentClass The entity information regarding the mapped entity owning this property. mappedEntity) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertySetter. Build an appropriate Setter for the given property.
protected ProxyFactory	buildProxyFactory(PersistentClass The mapping information regarding the mapped entity. mappingInfo, Getter The constructed Getter relating to the entity's id property. idGetter, Setter The constructed Setter relating to the entity's id property. idSetter) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildProxyFactory. Build an appropriate ProxyFactory for the given mapped entity.
public String	determineConcreteSubclassEntityName(Object The entity instance. entityInstance, SessionFactoryImplementor Reference to the SessionFactory. factory) Implements org.hibernate.tuple.entity.EntityTuplizer.determineConcreteSubclassEntityName. Given an entity instance, determine the most appropriate (most targeted) entity-name which represents it.
public static String	extractNodeName(Element element)
public Class<T>	getConcreteProxyClass() Implements org.hibernate.tuple.entity.EntityTuplizer.getConcreteProxyClass. Returns the java class to which generated proxies will be typed.
public EntityMode	getEntityMode() Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityMode. Return the entity-mode handled by this tuplizer instance.
public EntityNameResolver[]	getEntityNameResolvers() Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityNameResolvers. Get any `EntityNameResolvers` associated with this `Tuplizer`.
public Serializable	getIdentifier(Object The entity from which to extract the identifier value. entityOrId) Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier. Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Extract the identifier value from the given entity.
public Serializable	getIdentifier(Object The entity from which to extract the identifier value. entityOrId, SessionImplementor The session from which is requests originates session) Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier. Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Extract the identifier value from the given entity.
public Class<T>	getMappedClass() Implements org.hibernate.tuple.Tuplizer.getMappedClass. Return the pojo class managed by this tuplizer.
public boolean	isInstrumented() Implements org.hibernate.tuple.entity.EntityTuplizer.isInstrumented. Is it an instrumented POJO?

Field Detail

inheritenceNodeNameMap	back to summary
private Map<K, V> inheritenceNodeNameMap

log	back to summary
pack-priv static final Logger log Hides org.hibernate.tuple.entity.AbstractEntityTuplizer.log.

Constructor Detail

Dom4jEntityTuplizer	back to summary
pack-priv Dom4jEntityTuplizer(EntityMetamodel entityMetamodel, PersistentClass mappedEntity)

Method Detail

buildInstantiator	back to summary
protected Instantiator buildInstantiator(PersistentClass persistentClass) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildInstantiator. Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildInstantiator. Build an appropriate Instantiator for the given mapped entity. Parameters persistentClass:PersistentClass The mapping information regarding the mapped entity. Returns:Instantiator An appropriate Instantiator instance.

buildInstantiator

back to summary

protected Instantiator buildInstantiator(PersistentClass persistentClass)

Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildInstantiator.

Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildInstantiator.

Build an appropriate Instantiator for the given mapped entity.

Parameters

persistentClass:PersistentClass: The mapping information regarding the mapped entity.

Returns:Instantiator

An appropriate Instantiator instance.

buildPropertyAccessor	back to summary
private PropertyAccessor buildPropertyAccessor(Property mappedProperty)

buildPropertyGetter	back to summary
protected Getter buildPropertyGetter(Property mappedProperty, PersistentClass mappedEntity) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertyGetter. Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertyGetter. Build an appropriate Getter for the given property. Parameters mappedProperty:Property The property to be accessed via the built Getter. mappedEntity:PersistentClass The entity information regarding the mapped entity owning this property. Returns:Getter An appropriate Getter instance.

buildPropertyGetter

back to summary

protected Getter buildPropertyGetter(Property mappedProperty, PersistentClass mappedEntity)

Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertyGetter.

Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertyGetter.

Build an appropriate Getter for the given property.

Parameters

mappedProperty:Property: The property to be accessed via the built Getter.
mappedEntity:PersistentClass: The entity information regarding the mapped entity owning this property.

Returns:Getter

An appropriate Getter instance.

buildPropertySetter	back to summary
protected Setter buildPropertySetter(Property mappedProperty, PersistentClass mappedEntity) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertySetter. Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertySetter. Build an appropriate Setter for the given property. Parameters mappedProperty:Property The property to be accessed via the built Setter. mappedEntity:PersistentClass The entity information regarding the mapped entity owning this property. Returns:Setter An appropriate Setter instance.

buildPropertySetter

back to summary

protected Setter buildPropertySetter(Property mappedProperty, PersistentClass mappedEntity)

Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertySetter.

Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildPropertySetter.

Build an appropriate Setter for the given property.

Parameters

mappedProperty:Property: The property to be accessed via the built Setter.
mappedEntity:PersistentClass: The entity information regarding the mapped entity owning this property.

Returns:Setter

An appropriate Setter instance.

buildProxyFactory	back to summary
protected ProxyFactory buildProxyFactory(PersistentClass mappingInfo, Getter idGetter, Setter idSetter) Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildProxyFactory. Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildProxyFactory. Build an appropriate ProxyFactory for the given mapped entity. Parameters mappingInfo:PersistentClass The mapping information regarding the mapped entity. idGetter:Getter The constructed Getter relating to the entity's id property. idSetter:Setter The constructed Setter relating to the entity's id property. Returns:ProxyFactory An appropriate ProxyFactory instance.

buildProxyFactory

back to summary

protected ProxyFactory buildProxyFactory(PersistentClass mappingInfo, Getter idGetter, Setter idSetter)

Implements abstract org.hibernate.tuple.entity.AbstractEntityTuplizer.buildProxyFactory.

Doc from org.hibernate.tuple.entity.AbstractEntityTuplizer.buildProxyFactory.

Build an appropriate ProxyFactory for the given mapped entity.

Parameters

mappingInfo:PersistentClass: The mapping information regarding the mapped entity.
idGetter:Getter: The constructed Getter relating to the entity's id property.
idSetter:Setter: The constructed Setter relating to the entity's id property.

Returns:ProxyFactory

An appropriate ProxyFactory instance.

determineConcreteSubclassEntityName back to summary

determineConcreteSubclassEntityName	back to summary
public String determineConcreteSubclassEntityName(Object entityInstance, SessionFactoryImplementor factory) Implements org.hibernate.tuple.entity.EntityTuplizer.determineConcreteSubclassEntityName. Doc from org.hibernate.tuple.entity.EntityTuplizer.determineConcreteSubclassEntityName. Given an entity instance, determine the most appropriate (most targeted) entity-name which represents it. This is called in situations where we already know an entity name for the given entityInstance; we are being asked to determine if there is a more appropriate entity-name to use, specifically within an inheritence hierarchy. For example, consider a case where a user calls `session.update( "Animal", cat );`. Here, the user has explicitly provided `Animal` as the entity-name. However, they have passed in an instance of `Cat` which is a subclass of `Animal`. In this case, we would return `Cat` as the entity-name. `null` may be returned from calls to this method. The meaining of `null` in that case is assumed to be that we should use whatever explicit entity-name the user provided (`Animal` rather than `Cat` in the example above). Parameters entityInstance:Object The entity instance. factory:SessionFactoryImplementor Reference to the SessionFactory. Returns:String The most appropriate entity name to use.

public String determineConcreteSubclassEntityName(Object entityInstance, SessionFactoryImplementor factory)

Implements org.hibernate.tuple.entity.EntityTuplizer.determineConcreteSubclassEntityName.

Doc from org.hibernate.tuple.entity.EntityTuplizer.determineConcreteSubclassEntityName.

Given an entity instance, determine the most appropriate (most targeted) entity-name which represents it. This is called in situations where we already know an entity name for the given entityInstance; we are being asked to determine if there is a more appropriate entity-name to use, specifically within an inheritence hierarchy.

For example, consider a case where a user calls session.update( "Animal", cat );. Here, the user has explicitly provided Animal as the entity-name. However, they have passed in an instance of Cat which is a subclass of Animal. In this case, we would return Cat as the entity-name.

null may be returned from calls to this method. The meaining of null in that case is assumed to be that we should use whatever explicit entity-name the user provided (Animal rather than Cat in the example above).

Parameters

entityInstance:Object: The entity instance.
factory:SessionFactoryImplementor: Reference to the SessionFactory.

Returns:String

The most appropriate entity name to use.

extractNodeName	back to summary
public static String extractNodeName(Element element)

getConcreteProxyClass back to summary

getConcreteProxyClass	back to summary
public Class<T> getConcreteProxyClass() Implements org.hibernate.tuple.entity.EntityTuplizer.getConcreteProxyClass. Doc from org.hibernate.tuple.entity.EntityTuplizer.getConcreteProxyClass. Returns the java class to which generated proxies will be typed. todo : look at fully encapsulating `org.hibernate.engine.PersistenceContext#narrowProxy` here, since that is the only external use of this method Returns:Class<T> The java class to which generated proxies will be typed

public Class<T> getConcreteProxyClass()

Implements org.hibernate.tuple.entity.EntityTuplizer.getConcreteProxyClass.

Doc from org.hibernate.tuple.entity.EntityTuplizer.getConcreteProxyClass.

Returns the java class to which generated proxies will be typed.

todo : look at fully encapsulating org.hibernate.engine.PersistenceContext#narrowProxy here, since that is the only external use of this method

Returns:Class<T>: The java class to which generated proxies will be typed

getEntityMode	back to summary
public EntityMode getEntityMode() Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityMode. Doc from org.hibernate.tuple.entity.EntityTuplizer.getEntityMode. Return the entity-mode handled by this tuplizer instance. Returns:EntityMode The entity-mode

getEntityMode

back to summary

public EntityMode getEntityMode()

Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityMode.

Doc from org.hibernate.tuple.entity.EntityTuplizer.getEntityMode.

Return the entity-mode handled by this tuplizer instance.

Returns:EntityMode: The entity-mode

getEntityNameResolvers back to summary

getEntityNameResolvers	back to summary
public EntityNameResolver[] getEntityNameResolvers() Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityNameResolvers. Doc from org.hibernate.tuple.entity.EntityTuplizer.getEntityNameResolvers. Get any `EntityNameResolvers` associated with this `Tuplizer`. Returns:EntityNameResolver[] The associated resolvers. May be null or empty.

public EntityNameResolver[] getEntityNameResolvers()

Implements org.hibernate.tuple.entity.EntityTuplizer.getEntityNameResolvers.

Doc from org.hibernate.tuple.entity.EntityTuplizer.getEntityNameResolvers.

Get any EntityNameResolvers associated with this Tuplizer.

Returns:EntityNameResolver[]: The associated resolvers. May be null or empty.

getIdentifier	back to summary
public Serializable getIdentifier(Object entityOrId) throws HibernateException Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier. Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Doc from org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Extract the identifier value from the given entity. Parameters entityOrId:Object The entity from which to extract the identifier value. Returns:Serializable The identifier value. Exceptions HibernateException: If the entity does not define an identifier property, or an error occurs accessing its value.

getIdentifier

back to summary

public Serializable getIdentifier(Object entityOrId) throws HibernateException

Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier.

Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier.

Doc from org.hibernate.tuple.entity.EntityTuplizer.getIdentifier.

Extract the identifier value from the given entity.

Parameters

entityOrId:Object: The entity from which to extract the identifier value.

Returns:Serializable

The identifier value.

Exceptions

HibernateException:: If the entity does not define an identifier property, or an error occurs accessing its value.

getIdentifier	back to summary
public Serializable getIdentifier(Object entityOrId, SessionImplementor session) Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier. Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Doc from org.hibernate.tuple.entity.EntityTuplizer.getIdentifier. Extract the identifier value from the given entity. Parameters entityOrId:Object The entity from which to extract the identifier value. session:SessionImplementor The session from which is requests originates Returns:Serializable The identifier value.

getIdentifier

back to summary

public Serializable getIdentifier(Object entityOrId, SessionImplementor session)

Overrides org.hibernate.tuple.entity.AbstractEntityTuplizer.getIdentifier.

Implements org.hibernate.tuple.entity.EntityTuplizer.getIdentifier.

Doc from org.hibernate.tuple.entity.EntityTuplizer.getIdentifier.

Extract the identifier value from the given entity.

Parameters

entityOrId:Object: The entity from which to extract the identifier value.
session:SessionImplementor: The session from which is requests originates

Returns:Serializable

The identifier value.

getMappedClass	back to summary
public Class<T> getMappedClass() Implements org.hibernate.tuple.Tuplizer.getMappedClass. Doc from org.hibernate.tuple.Tuplizer.getMappedClass. Return the pojo class managed by this tuplizer. Need to determine how to best handle this for the Tuplizers for EntityModes other than POJO. todo : be really nice to not have this here since it is essentially pojo specific... Returns:Class<T> The persistent class.

getMappedClass

back to summary

public Class<T> getMappedClass()

Implements org.hibernate.tuple.Tuplizer.getMappedClass.

Doc from org.hibernate.tuple.Tuplizer.getMappedClass.

Return the pojo class managed by this tuplizer.

Need to determine how to best handle this for the Tuplizers for EntityModes other than POJO.

todo : be really nice to not have this here since it is essentially pojo specific...

Returns:Class<T>: The persistent class.

isInstrumented	back to summary
public boolean isInstrumented() Implements org.hibernate.tuple.entity.EntityTuplizer.isInstrumented. Doc from org.hibernate.tuple.entity.EntityTuplizer.isInstrumented. Is it an instrumented POJO?

isInstrumented

back to summary

public boolean isInstrumented()

Implements org.hibernate.tuple.entity.EntityTuplizer.isInstrumented.

Doc from org.hibernate.tuple.entity.EntityTuplizer.isInstrumented.

Is it an instrumented POJO?

org.hibernate.tuple.entity back to summary

public Class Dom4jEntityTuplizer.BasicEntityNameResolver

Class Inheritance

extends Object
implements EntityNameResolver

java.lang.Object
org.hibernate.tuple.entity.Dom4jEntityTuplizer.BasicEntityNameResolver

All Implemented Interfaces

org.hibernate.EntityNameResolver

Field Summary

Modifier and Type	Field and Description
private final Map<K, V>	nodeNameToEntityNameMap
private final String	rootEntityName

Constructor Summary

Access	Constructor and Description
public	BasicEntityNameResolver(String rootEntityName, Map<K, V> nodeNameToEntityNameMap)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	resolveEntityName(Object The entity instance. entity) Implements org.hibernate.EntityNameResolver.resolveEntityName. Given an entity instance, determine its entity-name.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

nodeNameToEntityNameMap	back to summary
private final Map<K, V> nodeNameToEntityNameMap

rootEntityName	back to summary
private final String rootEntityName

Constructor Detail

BasicEntityNameResolver	back to summary
public BasicEntityNameResolver(String rootEntityName, Map<K, V> nodeNameToEntityNameMap)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object.

resolveEntityName	back to summary
public String resolveEntityName(Object entity) Implements org.hibernate.EntityNameResolver.resolveEntityName. Doc from org.hibernate.EntityNameResolver.resolveEntityName. Given an entity instance, determine its entity-name. Parameters entity:Object The entity instance. Returns:String The corresponding entity-name, or null if this impl does not know how to perform resolution for the given entity instance.

resolveEntityName

back to summary

public String resolveEntityName(Object entity)

Implements org.hibernate.EntityNameResolver.resolveEntityName.

Doc from org.hibernate.EntityNameResolver.resolveEntityName.

Given an entity instance, determine its entity-name.

Parameters

entity:Object: The entity instance.

Returns:String

The corresponding entity-name, or null if this impl does not know how to perform resolution for the given entity instance.

public Class Dom4jEntityTuplizer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Dom4jEntityTuplizer.BasicEntityNameResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail