Package org.hibernate.loader.internal

Class SimpleNaturalIdLoadAccessImpl<T>

java.lang.Object

org.hibernate.loader.internal.BaseNaturalIdLoadAccessImpl<T>

org.hibernate.loader.internal.SimpleNaturalIdLoadAccessImpl<T>

All Implemented Interfaces:

NaturalIdLoadOptions, SimpleNaturalIdLoadAccess<T>

public class SimpleNaturalIdLoadAccessImpl<T>
extends BaseNaturalIdLoadAccessImpl<T>
implements SimpleNaturalIdLoadAccess<T>

Implementation of SimpleNaturalIdLoadAccess.

Implementation Note:

We allow use of SimpleNaturalIdLoadAccess for composite natural ids with the assumption that we will be given a singular representation of the natural id (a map or array).

Field Summary

Fields inherited from interface org.hibernate.loader.ast.spi.NaturalIdLoadOptions

NONE

Constructor Summary

Constructors

Constructor	Description
SimpleNaturalIdLoadAccessImpl(LoadAccessContext context, EntityMappingType entityDescriptor)

Method Summary

Modifier and Type	Method	Description
SimpleNaturalIdLoadAccess<T>	disableFetchProfile(String profileName)	Customize the associations fetched by specifying a fetch profile that should be disabled during this operation.
SimpleNaturalIdLoadAccess<T>	enableFetchProfile(String profileName)	Customize the associations fetched by specifying a fetch profile that should be enabled during this operation.
LockOptions	getLockOptions()	The locking options for the loaded entity
T	getReference(Object naturalIdValue)	Return the persistent instance with the given natural id value, assuming that the instance exists.
boolean	isSynchronizationEnabled()	Whether Hibernate should perform "synchronization" prior to performing look-ups?
T	load(Object naturalIdValue)	Return the persistent instance with the given natural id value, or null if there is no such persistent instance.
Optional<T>	loadOptional(Object naturalIdValue)	Just like SimpleNaturalIdLoadAccess.load(java.lang.Object), except that here an Optional is returned.
SimpleNaturalIdLoadAccessImpl<T>	setSynchronizationEnabled(boolean synchronizationEnabled)	For entities with mutable natural ids, should Hibernate perform "synchronization" prior to performing lookups? The default is to perform "synchronization" (for correctness).
SimpleNaturalIdLoadAccess<T>	with(EntityGraph<T> graph, GraphSemantic semantic)	Customize the associations fetched by specifying an entity graph, and how it should be interpreted.
SimpleNaturalIdLoadAccess<T>	with(Timeout timeout)	Specify the timeout to use when querying the database.
SimpleNaturalIdLoadAccess<T>	with(LockMode lockMode, PessimisticLockScope lockScope)	Specify the lock mode to use when querying the database.
final SimpleNaturalIdLoadAccessImpl<T>	with(LockOptions lockOptions)	Specify the lock options to use when querying the database.
SimpleNaturalIdLoadAccess<T>	withLoadGraph(EntityGraph<T> graph)	Augment the associations fetched by default by specifying a list of additional associations to be fetched as an entity graph.

Methods inherited from class org.hibernate.loader.internal.BaseNaturalIdLoadAccessImpl

doGetReference, doLoad, entityPersister, getContext, getEntityDescriptor, identifierLoadAccess, synchronizationEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.SimpleNaturalIdLoadAccess

with, withFetchGraph

Constructor Details

SimpleNaturalIdLoadAccessImpl

public SimpleNaturalIdLoadAccessImpl(LoadAccessContext context,
 EntityMappingType entityDescriptor)

Method Details

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: NaturalIdLoadOptions

The locking options for the loaded entity

Specified by:

getLockOptions in interface NaturalIdLoadOptions

Overrides:

getLockOptions in class BaseNaturalIdLoadAccessImpl<T>

isSynchronizationEnabled

public boolean isSynchronizationEnabled()

Description copied from interface: NaturalIdLoadOptions

Whether Hibernate should perform "synchronization" prior to performing look-ups?

Specified by:

isSynchronizationEnabled in interface NaturalIdLoadOptions

Overrides:

isSynchronizationEnabled in class BaseNaturalIdLoadAccessImpl<T>

with

public SimpleNaturalIdLoadAccess<T> with(LockMode lockMode,
 PessimisticLockScope lockScope)

Description copied from interface: SimpleNaturalIdLoadAccess

Specify the lock mode to use when querying the database.

Specified by:

with in interface SimpleNaturalIdLoadAccess<T>

Overrides:

with in class BaseNaturalIdLoadAccessImpl<T>

Parameters:

lockMode - The lock mode to apply

Returns:

this, for method chaining

with

public SimpleNaturalIdLoadAccess<T> with(Timeout timeout)

Description copied from interface: SimpleNaturalIdLoadAccess

Specify the timeout to use when querying the database.

Specified by:

with in interface SimpleNaturalIdLoadAccess<T>

Overrides:

with in class BaseNaturalIdLoadAccessImpl<T>

Parameters:

timeout - The timeout to apply to the database operation

Returns:

this, for method chaining

with

public final SimpleNaturalIdLoadAccessImpl<T> with(LockOptions lockOptions)

Description copied from interface: SimpleNaturalIdLoadAccess

Specify the lock options to use when querying the database.

Specified by:

with in interface SimpleNaturalIdLoadAccess<T>

Overrides:

with in class BaseNaturalIdLoadAccessImpl<T>

Parameters:

lockOptions - The lock options to use

Returns:

this, for method chaining

setSynchronizationEnabled

public SimpleNaturalIdLoadAccessImpl<T> setSynchronizationEnabled(boolean synchronizationEnabled)

Description copied from interface: SimpleNaturalIdLoadAccess

For entities with mutable natural ids, should Hibernate perform "synchronization" prior to performing lookups? The default is to perform "synchronization" (for correctness).

See NaturalIdLoadAccess.setSynchronizationEnabled(boolean) for detailed discussion.

Specified by:

setSynchronizationEnabled in interface SimpleNaturalIdLoadAccess<T>

Parameters:

synchronizationEnabled - Should synchronization be performed? true indicates synchronization will be performed; false indicates it will be circumvented.

Returns:

this, for method chaining

getReference

public T getReference(Object naturalIdValue)

Description copied from interface: SimpleNaturalIdLoadAccess

Return the persistent instance with the given natural id value, assuming that the instance exists. This method might return a proxied instance that is initialized on-demand, when a non-identifier method is accessed.

You should not use this method to determine if an instance exists; to check for existence, use SimpleNaturalIdLoadAccess.load(java.lang.Object) instead. Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

Specified by:

getReference in interface SimpleNaturalIdLoadAccess<T>

Parameters:

naturalIdValue - The value of the natural id

Returns:

The persistent instance or proxy, if an instance exists. Otherwise, null.

load

public T load(Object naturalIdValue)

Description copied from interface: SimpleNaturalIdLoadAccess

Return the persistent instance with the given natural id value, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance, initializing it if needed. This method never returns an uninitialized instance.

Specified by:

load in interface SimpleNaturalIdLoadAccess<T>

Parameters:

naturalIdValue - The value of the natural-id

Returns:

The persistent instance or null

loadOptional

public Optional<T> loadOptional(Object naturalIdValue)

Description copied from interface: SimpleNaturalIdLoadAccess

Just like SimpleNaturalIdLoadAccess.load(java.lang.Object), except that here an Optional is returned.

Specified by:

loadOptional in interface SimpleNaturalIdLoadAccess<T>

Parameters:

naturalIdValue - The identifier

Returns:

The persistent instance, if any, as an Optional

with

public SimpleNaturalIdLoadAccess<T> with(EntityGraph<T> graph,
 GraphSemantic semantic)

Description copied from interface: SimpleNaturalIdLoadAccess

Customize the associations fetched by specifying an entity graph, and how it should be interpreted.

Specified by:

with in interface SimpleNaturalIdLoadAccess<T>

Overrides:

with in class BaseNaturalIdLoadAccessImpl<T>

withLoadGraph

public SimpleNaturalIdLoadAccess<T> withLoadGraph(EntityGraph<T> graph)

Description copied from interface: SimpleNaturalIdLoadAccess

Augment the associations fetched by default by specifying a list of additional associations to be fetched as an entity graph.

Specified by:

withLoadGraph in interface SimpleNaturalIdLoadAccess<T>

enableFetchProfile

public SimpleNaturalIdLoadAccess<T> enableFetchProfile(String profileName)

Description copied from interface: SimpleNaturalIdLoadAccess

Customize the associations fetched by specifying a fetch profile that should be enabled during this operation.

This allows the session-level fetch profiles to be temporarily overridden.

Specified by:

enableFetchProfile in interface SimpleNaturalIdLoadAccess<T>

Overrides:

enableFetchProfile in class BaseNaturalIdLoadAccessImpl<T>

disableFetchProfile

public SimpleNaturalIdLoadAccess<T> disableFetchProfile(String profileName)

Description copied from interface: SimpleNaturalIdLoadAccess

Customize the associations fetched by specifying a fetch profile that should be disabled during this operation.

This allows the session-level fetch profiles to be temporarily overridden.

Specified by:

disableFetchProfile in interface SimpleNaturalIdLoadAccess<T>

Overrides:

disableFetchProfile in class BaseNaturalIdLoadAccessImpl<T>