Package org.hibernate.internal

Class NaturalIdMultiLoadAccessStandard<T>

java.lang.Object

org.hibernate.internal.NaturalIdMultiLoadAccessStandard<T>

All Implemented Interfaces:

MultiLoadOptions, MultiNaturalIdLoadOptions, NaturalIdMultiLoadAccess<T>

public class NaturalIdMultiLoadAccessStandard<T>
extends Object
implements NaturalIdMultiLoadAccess<T>, MultiNaturalIdLoadOptions

Constructor Summary

Constructors

Constructor	Description
NaturalIdMultiLoadAccessStandard(EntityPersister entityDescriptor, SharedSessionContractImplementor session)

Method Summary

Modifier and Type	Method	Description
NaturalIdMultiLoadAccess<T>	enableOrderedReturn(boolean enabled)	Should the returned list of entity instances be ordered, with the position of an entity instance determined by the position of its identifier in the list if ids passed to NaturalIdMultiLoadAccess.multiLoad(java.lang.Object...)?
NaturalIdMultiLoadAccess<T>	enableReturnOfDeletedEntities(boolean enabled)	Should NaturalIdMultiLoadAccess.multiLoad(java.lang.Object...) return entity instances that have been marked for removal in the current session, but not yet deleted in the database?
Integer	getBatchSize()	Batch size to use when loading entities from the database.
LockOptions	getLockOptions()	Specify the lock options applied during loading.
boolean	isOrderReturnEnabled()	Should the entities be returned in the same order as their associated entity identifiers were provided.
boolean	isReturnOfDeletedEntitiesEnabled()	Should we returned entities that are scheduled for deletion.
List<T>	multiLoad(Object... ids)	Retrieve the entities with the given natural id values.
List<T>	multiLoad(List<?> ids)	Retrieve the entities with the given natural id values.
NaturalIdMultiLoadAccess<T>	with(EntityGraph<T> graph, GraphSemantic semantic)	Customize the associations fetched by specifying an entity graph, and how it should be interpreted.
NaturalIdMultiLoadAccess<T>	with(Timeout timeout)	Specify the timeout to use when querying the database.
NaturalIdMultiLoadAccess<T>	with(CacheMode cacheMode)	Specify the CacheMode to use when obtaining an entity.
NaturalIdMultiLoadAccess<T>	with(LockMode lockMode, PessimisticLockScope lockScope)	Specify the lock mode to use when querying the database.
NaturalIdMultiLoadAccess<T>	with(LockOptions lockOptions)	Specify the lock options to use when querying the database.
NaturalIdMultiLoadAccess<T>	withBatchSize(int batchSize)	Specify a batch size, that is, how many entities should be fetched in each request to the database.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.NaturalIdMultiLoadAccess

with, with, withFetchGraph, withLoadGraph

Constructor Details

NaturalIdMultiLoadAccessStandard

public NaturalIdMultiLoadAccessStandard(EntityPersister entityDescriptor,
 SharedSessionContractImplementor session)

Method Details

with

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

Description copied from interface: NaturalIdMultiLoadAccess

Specify the lock mode to use when querying the database.

Specified by:

with in interface NaturalIdMultiLoadAccess<T>

Parameters:

lockMode - The lock mode to apply

Returns:

this, for method chaining

with

public NaturalIdMultiLoadAccess<T> with(Timeout timeout)

Description copied from interface: NaturalIdMultiLoadAccess

Specify the timeout to use when querying the database.

Specified by:

with in interface NaturalIdMultiLoadAccess<T>

Parameters:

timeout - The timeout to apply to the database operation

Returns:

this, for method chaining

with

public NaturalIdMultiLoadAccess<T> with(LockOptions lockOptions)

Description copied from interface: NaturalIdMultiLoadAccess

Specify the lock options to use when querying the database.

Specified by:

with in interface NaturalIdMultiLoadAccess<T>

Parameters:

lockOptions - The lock options to use

Returns:

this, for method chaining

with

public NaturalIdMultiLoadAccess<T> with(CacheMode cacheMode)

Description copied from interface: NaturalIdMultiLoadAccess

Specify the CacheMode to use when obtaining an entity.

Specified by:

with in interface NaturalIdMultiLoadAccess<T>

Parameters:

cacheMode - The CacheMode to use

Returns:

this, for method chaining

with

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

Description copied from interface: NaturalIdMultiLoadAccess

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

Specified by:

with in interface NaturalIdMultiLoadAccess<T>

withBatchSize

public NaturalIdMultiLoadAccess<T> withBatchSize(int batchSize)

Description copied from interface: NaturalIdMultiLoadAccess

Specify a batch size, that is, how many entities should be fetched in each request to the database.

• By default, the batch sizing strategy is determined by the SQL dialect, but
• if some batchSize>1 is specified as an argument to this method, then that batch size will be used.

If an explicit batch size is set manually, care should be taken to not exceed the capabilities of the underlying database.

A batch size is considered a hint.

Specified by:

withBatchSize in interface NaturalIdMultiLoadAccess<T>

Parameters:

batchSize - The batch size

Returns:

this, for method chaining

enableReturnOfDeletedEntities

public NaturalIdMultiLoadAccess<T> enableReturnOfDeletedEntities(boolean enabled)

Description copied from interface: NaturalIdMultiLoadAccess

Should NaturalIdMultiLoadAccess.multiLoad(java.lang.Object...) return entity instances that have been marked for removal in the current session, but not yet deleted in the database?

By default, instances marked for removal are replaced by null in the returned list of entities when NaturalIdMultiLoadAccess.enableOrderedReturn(boolean) is used.

Specified by:

enableReturnOfDeletedEntities in interface NaturalIdMultiLoadAccess<T>

Parameters:

enabled - true if removed entities should be returned; false if they should be replaced by null values.

Returns:

this, for method chaining

enableOrderedReturn

public NaturalIdMultiLoadAccess<T> enableOrderedReturn(boolean enabled)

Description copied from interface: NaturalIdMultiLoadAccess

Should the returned list of entity instances be ordered, with the position of an entity instance determined by the position of its identifier in the list if ids passed to NaturalIdMultiLoadAccess.multiLoad(java.lang.Object...)?

By default, the returned list is ordered and the positions of the entities correspond to the positions of their ids. In this case, the handling of entities marked for removal becomes important.

Specified by:

enableOrderedReturn in interface NaturalIdMultiLoadAccess<T>

Parameters:

enabled - true if entity instances should be ordered; false if they may be returned in any order.

Returns:

this, for method chaining

multiLoad

public List<T> multiLoad(Object... ids)

Description copied from interface: NaturalIdMultiLoadAccess

Retrieve the entities with the given natural id values.

Note that the options NaturalIdMultiLoadAccess.enableReturnOfDeletedEntities(boolean) and NaturalIdMultiLoadAccess.enableOrderedReturn(boolean) affect the size and shape of the returned list of entity instances.

Specified by:

multiLoad in interface NaturalIdMultiLoadAccess<T>

Parameters:

ids - The natural id values to load

Returns:

The managed entities.

multiLoad

public List<T> multiLoad(List<?> ids)

Description copied from interface: NaturalIdMultiLoadAccess

Retrieve the entities with the given natural id values.

Note that the options NaturalIdMultiLoadAccess.enableReturnOfDeletedEntities(boolean) and NaturalIdMultiLoadAccess.enableOrderedReturn(boolean) affect the size and shape of the returned list of entity instances.

Specified by:

multiLoad in interface NaturalIdMultiLoadAccess<T>

Parameters:

ids - The natural id values to load

Returns:

The managed entities.

isReturnOfDeletedEntitiesEnabled

public boolean isReturnOfDeletedEntitiesEnabled()

Description copied from interface: MultiLoadOptions

Should we returned entities that are scheduled for deletion.

Specified by:

isReturnOfDeletedEntitiesEnabled in interface MultiLoadOptions

Returns:

entities that are scheduled for deletion are returned as well.

isOrderReturnEnabled

public boolean isOrderReturnEnabled()

Description copied from interface: MultiLoadOptions

Should the entities be returned in the same order as their associated entity identifiers were provided.

Specified by:

isOrderReturnEnabled in interface MultiLoadOptions

Returns:

entities follow the provided identifier order

getLockOptions

public LockOptions getLockOptions()

Description copied from interface: MultiLoadOptions

Specify the lock options applied during loading.

Specified by:

getLockOptions in interface MultiLoadOptions

Returns:

lock options applied during loading.

getBatchSize

public Integer getBatchSize()

Description copied from interface: MultiLoadOptions

Batch size to use when loading entities from the database.

Specified by:

getBatchSize in interface MultiLoadOptions

Returns:

JDBC batch size