org.hibernate.loader.entity.plan

Class AbstractLoadPlanBasedEntityLoader

java.lang.Object

org.hibernate.loader.plan.exec.internal.AbstractLoadPlanBasedLoader

org.hibernate.loader.entity.plan.AbstractLoadPlanBasedEntityLoader

All Implemented Interfaces:

UniqueEntityLoader

Direct Known Subclasses:

EntityLoader

public abstract class AbstractLoadPlanBasedEntityLoader
extends AbstractLoadPlanBasedLoader
implements UniqueEntityLoader

A UniqueEntityLoader implementation based on using LoadPlans

Author:

Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.loader.plan.exec.internal.AbstractLoadPlanBasedLoader

AbstractLoadPlanBasedLoader.SqlStatementWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLoadPlanBasedEntityLoader(OuterJoinLoadable entityPersister, SessionFactoryImplementor factory, EntityLoadQueryDetails entityLoaderQueryDetailsTemplate, Type uniqueKeyType, QueryBuildingParameters buildingParameters)
	AbstractLoadPlanBasedEntityLoader(OuterJoinLoadable entityPersister, SessionFactoryImplementor factory, String[] uniqueKeyColumnNames, Type uniqueKeyType, QueryBuildingParameters buildingParameters)

Method Summary

Modifier and Type	Method and Description
protected void	autoDiscoverTypes(ResultSet rs)
protected Object	extractEntityResult(List results) Deprecated. extractEntityResult(List, Serializable) should be used instead.
protected Object	extractEntityResult(List results, Serializable id)
protected String	getEntityName()
protected int[]	getNamedParameterLocs(String name)
protected LoadQueryDetails	getStaticLoadQuery()
Object	load(Serializable id, Object optionalObject, SharedSessionContractImplementor session) Load an entity instance.
Object	load(Serializable id, Object optionalObject, SharedSessionContractImplementor session, LockOptions lockOptions) Load an entity instance by id.
List	loadEntityBatch(SharedSessionContractImplementor session, Serializable[] ids, Type idType, Object optionalObject, String optionalEntityName, Serializable optionalId, EntityPersister persister, LockOptions lockOptions) Called by wrappers that batch load entities

Methods inherited from class org.hibernate.loader.plan.exec.internal.AbstractLoadPlanBasedLoader

advance, bindNamedParameters, bindParameterValues, bindPositionalParameters, executeLoad, executeQueryStatement, executeQueryStatement, getFactory, getLimitHandler, getResultSet, getScrollMode, prepareQueryStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLoadPlanBasedEntityLoader

public AbstractLoadPlanBasedEntityLoader(OuterJoinLoadable entityPersister,
                                         SessionFactoryImplementor factory,
                                         String[] uniqueKeyColumnNames,
                                         Type uniqueKeyType,
                                         QueryBuildingParameters buildingParameters)

AbstractLoadPlanBasedEntityLoader

protected AbstractLoadPlanBasedEntityLoader(OuterJoinLoadable entityPersister,
                                            SessionFactoryImplementor factory,
                                            EntityLoadQueryDetails entityLoaderQueryDetailsTemplate,
                                            Type uniqueKeyType,
                                            QueryBuildingParameters buildingParameters)

Method Detail

getStaticLoadQuery

protected LoadQueryDetails getStaticLoadQuery()

Specified by:

getStaticLoadQuery in class AbstractLoadPlanBasedLoader

getEntityName

protected String getEntityName()

loadEntityBatch

public final List loadEntityBatch(SharedSessionContractImplementor session,
                                  Serializable[] ids,
                                  Type idType,
                                  Object optionalObject,
                                  String optionalEntityName,
                                  Serializable optionalId,
                                  EntityPersister persister,
                                  LockOptions lockOptions)
                           throws HibernateException

Called by wrappers that batch load entities

Parameters:

persister - only needed for logging

lockOptions -

Throws:

HibernateException

load

public Object load(Serializable id,
                   Object optionalObject,
                   SharedSessionContractImplementor session)
            throws HibernateException

Description copied from interface: UniqueEntityLoader

Load an entity instance. If optionalObject is supplied, load the entity state into the given (uninitialized) object.

Specified by:

load in interface UniqueEntityLoader

Throws:

HibernateException

load

public Object load(Serializable id,
                   Object optionalObject,
                   SharedSessionContractImplementor session,
                   LockOptions lockOptions)

Description copied from interface: UniqueEntityLoader

Load an entity instance by id. If optionalObject is supplied (non-null, the entity state is loaded into that object instance instead of instantiating a new one.

Specified by:

load in interface UniqueEntityLoader

Parameters:

id - The id to be loaded

optionalObject - The (optional) entity instance in to which to load the state

session - The session from which the request originated

lockOptions - The lock options.

Returns:

The loaded entity

extractEntityResult

@Deprecated
protected Object extractEntityResult(List results)

Deprecated. extractEntityResult(List, Serializable) should be used instead.

extractEntityResult

protected Object extractEntityResult(List results,
                                     Serializable id)

getNamedParameterLocs

protected int[] getNamedParameterLocs(String name)

Specified by:

getNamedParameterLocs in class AbstractLoadPlanBasedLoader

autoDiscoverTypes

protected void autoDiscoverTypes(ResultSet rs)

Specified by:

autoDiscoverTypes in class AbstractLoadPlanBasedLoader