Package org.hibernate.jpa.internal.util

Class PersistenceUtilHelper

java.lang.Object

org.hibernate.jpa.internal.util.PersistenceUtilHelper

public final class PersistenceUtilHelper
extends Object

Central delegate for handling calls from:

• PersistenceUtil.isLoaded(Object)
• PersistenceUtil.isLoaded(Object, String)
• ProviderUtil.isLoaded(Object)
• ProviderUtil.isLoadedWithReference(Object, String)
• ProviderUtil.isLoadedWithoutReference(Object, String)li>

Author:

Emmanuel Bernard, Hardy Ferentschik, Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PersistenceUtilHelper.AttributeAccess
static class	PersistenceUtilHelper.AttributeExtractionException
static class	PersistenceUtilHelper.ClassMetadataCache
static class	PersistenceUtilHelper.FieldAttributeAccess
static final class	PersistenceUtilHelper.MetadataCache	Cache hierarchy and member resolution, taking care to not leak references to Class instances.
static class	PersistenceUtilHelper.MethodAttributeAccess

Method Summary

Modifier and Type	Method	Description
static LoadState	getLoadState(Object reference)	Determine if the given object reference represents loaded state.
static LoadState	isLoadedWithoutReference(Object entity, String attributeName, PersistenceUtilHelper.MetadataCache cache)	Is the given attribute (by name) loaded?
static LoadState	isLoadedWithReference(Object entity, String attributeName, PersistenceUtilHelper.MetadataCache cache)	Is the given attribute (by name) loaded?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getLoadState

public static LoadState getLoadState(Object reference)

Determine if the given object reference represents loaded state. The reference may be to an entity or a persistent collection.

Return is defined as follows:

1. If the reference is a HibernateProxy, we return LoadState.LOADED if LazyInitializer.isUninitialized() returns false; else we return LoadState.NOT_LOADED
2. If the reference is an enhanced (by Hibernate) entity, we return LoadState.LOADED if LazyAttributeLoadingInterceptor.hasAnyUninitializedAttributes() returns false; otherwise we return LoadState.NOT_LOADED
3. If the reference is a PersistentCollection, we return LoadState.LOADED if LazyInitializable.wasInitialized() returns true; else we return LoadState.NOT_LOADED
4. In all other cases we return LoadState.UNKNOWN

Parameters:

reference - The object reference to check.

Returns:

The appropriate LoadState (see above)

isLoadedWithoutReference

public static LoadState isLoadedWithoutReference(Object entity,
 String attributeName,
 PersistenceUtilHelper.MetadataCache cache)

Is the given attribute (by name) loaded? This form must take care to not access the attribute (trigger initialization).

Parameters:

entity - The entity

attributeName - The name of the attribute to check

cache - The cache we maintain of attribute resolutions

Returns:

The LoadState

isLoadedWithReference

public static LoadState isLoadedWithReference(Object entity,
 String attributeName,
 PersistenceUtilHelper.MetadataCache cache)

Is the given attribute (by name) loaded? This form must take care to not access the attribute (trigger initialization).

Parameters:

entity - The entity

attributeName - The name of the attribute to check

cache - The cache we maintain of attribute resolutions

Returns:

The LoadState