/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.loader.entity;

import org.hibernate.LockMode;
import org.hibernate.LockOptions;
import org.hibernate.engine.spi.LoadQueryInfluencers;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.persister.entity.OuterJoinLoadable;

The contract for building UniqueEntityLoader capable of performing batch-fetch loading. Intention is to build these instances, by first calling the static getBuilder, and then calling the appropriate buildLoader method.
Author:Steve Ebersole
See Also:
/** * The contract for building {@link UniqueEntityLoader} capable of performing batch-fetch loading. Intention * is to build these instances, by first calling the static {@link #getBuilder}, and then calling the appropriate * {@link #buildLoader} method. * * @author Steve Ebersole * * @see org.hibernate.loader.BatchFetchStyle */
public abstract class BatchingEntityLoaderBuilder { public static BatchingEntityLoaderBuilder getBuilder(SessionFactoryImplementor factory) { switch ( factory.getSettings().getBatchFetchStyle() ) { case PADDED: { return PaddedBatchingEntityLoaderBuilder.INSTANCE; } case DYNAMIC: { return DynamicBatchingEntityLoaderBuilder.INSTANCE; } default: { return org.hibernate.loader.entity.plan.LegacyBatchingEntityLoaderBuilder.INSTANCE; // return LegacyBatchingEntityLoaderBuilder.INSTANCE; } } }
Builds a batch-fetch capable loader based on the given persister, lock-mode, etc.
Params:
  • persister – The entity persister
  • batchSize – The maximum number of ids to batch-fetch at once
  • lockMode – The lock mode
  • factory – The SessionFactory
  • influencers – Any influencers that should affect the built query
Returns:The loader.
/** * Builds a batch-fetch capable loader based on the given persister, lock-mode, etc. * * @param persister The entity persister * @param batchSize The maximum number of ids to batch-fetch at once * @param lockMode The lock mode * @param factory The SessionFactory * @param influencers Any influencers that should affect the built query * * @return The loader. */
public UniqueEntityLoader buildLoader( OuterJoinLoadable persister, int batchSize, LockMode lockMode, SessionFactoryImplementor factory, LoadQueryInfluencers influencers) { if ( batchSize <= 1 ) { // no batching return buildNonBatchingLoader( persister, lockMode, factory, influencers ); } return buildBatchingLoader( persister, batchSize, lockMode, factory, influencers ); } protected UniqueEntityLoader buildNonBatchingLoader( OuterJoinLoadable persister, LockMode lockMode, SessionFactoryImplementor factory, LoadQueryInfluencers influencers) { return new EntityLoader( persister, lockMode, factory, influencers ); } protected abstract UniqueEntityLoader buildBatchingLoader( OuterJoinLoadable persister, int batchSize, LockMode lockMode, SessionFactoryImplementor factory, LoadQueryInfluencers influencers);
Builds a batch-fetch capable loader based on the given persister, lock-options, etc.
Params:
  • persister – The entity persister
  • batchSize – The maximum number of ids to batch-fetch at once
  • lockOptions – The lock options
  • factory – The SessionFactory
  • influencers – Any influencers that should affect the built query
Returns:The loader.
/** * Builds a batch-fetch capable loader based on the given persister, lock-options, etc. * * @param persister The entity persister * @param batchSize The maximum number of ids to batch-fetch at once * @param lockOptions The lock options * @param factory The SessionFactory * @param influencers Any influencers that should affect the built query * * @return The loader. */
public UniqueEntityLoader buildLoader( OuterJoinLoadable persister, int batchSize, LockOptions lockOptions, SessionFactoryImplementor factory, LoadQueryInfluencers influencers) { if ( batchSize <= 1 ) { // no batching return buildNonBatchingLoader( persister, lockOptions, factory, influencers ); } return buildBatchingLoader( persister, batchSize, lockOptions, factory, influencers ); } protected UniqueEntityLoader buildNonBatchingLoader( OuterJoinLoadable persister, LockOptions lockOptions, SessionFactoryImplementor factory, LoadQueryInfluencers influencers) { return new EntityLoader( persister, lockOptions, factory, influencers ); } protected abstract UniqueEntityLoader buildBatchingLoader( OuterJoinLoadable persister, int batchSize, LockOptions lockOptions, SessionFactoryImplementor factory, LoadQueryInfluencers influencers); }