org.hibernate

Interface MultiIdentifierLoadAccess<T>

public interface MultiIdentifierLoadAccess<T>

Loads multiple entities at once by identifiers

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
MultiIdentifierLoadAccess<T>	enableSessionCheck(boolean enabled) Should we check the Session to see whether it already contains any of the entities to be loaded in a managed state for the purpose of not including those ids to the batch-load SQL
<K extends Serializable> List<T>	multiLoad(K... ids) Perform a load of multiple entities by identifiers
<K extends Serializable> List<T>	multiLoad(List<K> ids) Perform a load of multiple entities by identifiers
MultiIdentifierLoadAccess<T>	with(CacheMode cacheMode) Specify the CacheMode to use when retrieving the entity.
MultiIdentifierLoadAccess<T>	with(LockOptions lockOptions) Specify the LockOptions to use when retrieving the entity.
MultiIdentifierLoadAccess<T>	withBatchSize(int batchSize) Specify a batch size for loading the entities (how many at a time).

Method Detail

with

MultiIdentifierLoadAccess<T> with(LockOptions lockOptions)

Specify the LockOptions to use when retrieving the entity.

Parameters:

lockOptions - The lock options to use.

Returns:

this, for method chaining

with

MultiIdentifierLoadAccess<T> with(CacheMode cacheMode)

Specify the CacheMode to use when retrieving the entity.

Parameters:

cacheMode - The CacheMode to use.

Returns:

this, for method chaining

withBatchSize

MultiIdentifierLoadAccess<T> withBatchSize(int batchSize)

Specify a batch size for loading the entities (how many at a time). The default is to use a batch sizing strategy defined by the Dialect in use. Any greater-than-one value here will override that default behavior. If giving an explicit value here, care should be taken to not exceed the capabilities of of the underlying database.

Note that overall a batch-size is considered a hint. How the underlying loading mechanism interprets that is completely up to that underlying loading mechanism.

Parameters:

batchSize - The batch size

Returns:

this, for method chaining

enableSessionCheck

MultiIdentifierLoadAccess<T> enableSessionCheck(boolean enabled)

Should we check the Session to see whether it already contains any of the entities to be loaded in a managed state for the purpose of not including those ids to the batch-load SQL

Parameters:

enabled - true enables this checking; false disables it.

Returns:

this, for method chaining

multiLoad

<K extends Serializable> List<T> multiLoad(K... ids)

Perform a load of multiple entities by identifiers

Type Parameters:

K - The identifier type

Parameters:

ids - The ids to load

Returns:

The persistent entities.

multiLoad

<K extends Serializable> List<T> multiLoad(List<K> ids)

Perform a load of multiple entities by identifiers

Type Parameters:

K - The identifier type

Parameters:

ids - The ids to load

Returns:

The persistent entities.