org.hibernate.loader.plan.exec.internal

Class AbstractLoadPlanBasedLoader

java.lang.Object

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

Direct Known Subclasses:

AbstractLoadPlanBasedCollectionInitializer, AbstractLoadPlanBasedEntityLoader

public abstract class AbstractLoadPlanBasedLoader
extends Object

A superclass for loader implementations based on using LoadPlans.

Author:

Gail Badner

See Also:

EntityLoader, CollectionLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractLoadPlanBasedLoader.SqlStatementWrapper Wrapper class for Statement and associated ResultSet.

Constructor Summary

Constructors

Constructor and Description
AbstractLoadPlanBasedLoader(SessionFactoryImplementor factory) Constructs a AbstractLoadPlanBasedLoader.

Method Summary

Modifier and Type	Method and Description
protected void	advance(ResultSet rs, RowSelection selection) Advance the cursor to the first required row of the ResultSet
protected abstract void	autoDiscoverTypes(ResultSet rs)
protected int	bindNamedParameters(PreparedStatement statement, Map namedParams, int startIndex, SessionImplementor session) Bind named parameters to the JDBC prepared statement.
protected int	bindParameterValues(PreparedStatement statement, QueryParameters queryParameters, int startIndex, SessionImplementor session) Bind all parameter values into the prepared statement in preparation for execution.
protected int	bindPositionalParameters(PreparedStatement statement, QueryParameters queryParameters, int startIndex, SessionImplementor session) Bind positional parameter values to the JDBC prepared statement.
protected List	executeLoad(SessionImplementor session, QueryParameters queryParameters, LoadQueryDetails loadQueryDetails, boolean returnProxies, ResultTransformer forcedResultTransformer)
protected List	executeLoad(SessionImplementor session, QueryParameters queryParameters, LoadQueryDetails loadQueryDetails, boolean returnProxies, ResultTransformer forcedResultTransformer, List<AfterLoadAction> afterLoadActions)
protected AbstractLoadPlanBasedLoader.SqlStatementWrapper	executeQueryStatement(QueryParameters queryParameters, boolean scroll, List<AfterLoadAction> afterLoadActions, SessionImplementor session)
protected AbstractLoadPlanBasedLoader.SqlStatementWrapper	executeQueryStatement(String sqlStatement, QueryParameters queryParameters, boolean scroll, List<AfterLoadAction> afterLoadActions, SessionImplementor session)
protected SessionFactoryImplementor	getFactory()
protected LimitHandler	getLimitHandler(RowSelection selection) Build LIMIT clause handler applicable for given selection criteria.
protected abstract int[]	getNamedParameterLocs(String name)
protected ResultSet	getResultSet(PreparedStatement st, RowSelection selection, LimitHandler limitHandler, boolean autodiscovertypes, SessionImplementor session) Execute given PreparedStatement, advance to the first result and return SQL ResultSet.
protected ScrollMode	getScrollMode(boolean scroll, boolean hasFirstRow, boolean useLimitOffSet, QueryParameters queryParameters)
protected abstract LoadQueryDetails	getStaticLoadQuery()
protected PreparedStatement	prepareQueryStatement(String sql, QueryParameters queryParameters, LimitHandler limitHandler, boolean scroll, SessionImplementor session) Obtain a PreparedStatement with all parameters pre-bound.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLoadPlanBasedLoader

public AbstractLoadPlanBasedLoader(SessionFactoryImplementor factory)

Constructs a AbstractLoadPlanBasedLoader.

Parameters:

factory - The session factory

See Also:

SessionFactoryImplementor

Method Detail

getFactory

protected SessionFactoryImplementor getFactory()

getStaticLoadQuery

protected abstract LoadQueryDetails getStaticLoadQuery()

getNamedParameterLocs

protected abstract int[] getNamedParameterLocs(String name)

autoDiscoverTypes

protected abstract void autoDiscoverTypes(ResultSet rs)

executeLoad

protected List executeLoad(SessionImplementor session,
                           QueryParameters queryParameters,
                           LoadQueryDetails loadQueryDetails,
                           boolean returnProxies,
                           ResultTransformer forcedResultTransformer)
                    throws SQLException

Throws:

SQLException

executeLoad

protected List executeLoad(SessionImplementor session,
                           QueryParameters queryParameters,
                           LoadQueryDetails loadQueryDetails,
                           boolean returnProxies,
                           ResultTransformer forcedResultTransformer,
                           List<AfterLoadAction> afterLoadActions)
                    throws SQLException

Throws:

SQLException

executeQueryStatement

protected AbstractLoadPlanBasedLoader.SqlStatementWrapper executeQueryStatement(QueryParameters queryParameters,
                                                                                boolean scroll,
                                                                                List<AfterLoadAction> afterLoadActions,
                                                                                SessionImplementor session)
                                                                         throws SQLException

Throws:

SQLException

executeQueryStatement

protected AbstractLoadPlanBasedLoader.SqlStatementWrapper executeQueryStatement(String sqlStatement,
                                                                                QueryParameters queryParameters,
                                                                                boolean scroll,
                                                                                List<AfterLoadAction> afterLoadActions,
                                                                                SessionImplementor session)
                                                                         throws SQLException

Throws:

SQLException

getLimitHandler

protected LimitHandler getLimitHandler(RowSelection selection)

Build LIMIT clause handler applicable for given selection criteria. Returns NoopLimitHandler delegate if dialect does not support LIMIT expression or processed query does not use pagination.

Parameters:

selection - Selection criteria.

Returns:

LIMIT clause delegate.

prepareQueryStatement

protected final PreparedStatement prepareQueryStatement(String sql,
                                                        QueryParameters queryParameters,
                                                        LimitHandler limitHandler,
                                                        boolean scroll,
                                                        SessionImplementor session)
                                                 throws SQLException,
                                                        HibernateException

Obtain a PreparedStatement with all parameters pre-bound. Bind JDBC-style ? parameters, named parameters, and limit parameters.

Throws:

SQLException

HibernateException

getScrollMode

protected ScrollMode getScrollMode(boolean scroll,
                                   boolean hasFirstRow,
                                   boolean useLimitOffSet,
                                   QueryParameters queryParameters)

bindParameterValues

protected int bindParameterValues(PreparedStatement statement,
                                  QueryParameters queryParameters,
                                  int startIndex,
                                  SessionImplementor session)
                           throws SQLException

Bind all parameter values into the prepared statement in preparation for execution.

Parameters:

statement - The JDBC prepared statement

queryParameters - The encapsulation of the parameter values to be bound.

startIndex - The position from which to start binding parameter values.

session - The originating session.

Returns:

The number of JDBC bind positions actually bound during this method execution.

Throws:

SQLException - Indicates problems performing the binding.

bindPositionalParameters

protected int bindPositionalParameters(PreparedStatement statement,
                                       QueryParameters queryParameters,
                                       int startIndex,
                                       SessionImplementor session)
                                throws SQLException,
                                       HibernateException

Bind positional parameter values to the JDBC prepared statement.

Positional parameters are those specified by JDBC-style ? parameters in the source query. It is (currently) expected that these come before any named parameters in the source query.

Parameters:

statement - The JDBC prepared statement

queryParameters - The encapsulation of the parameter values to be bound.

startIndex - The position from which to start binding parameter values.

session - The originating session.

Returns:

The number of JDBC bind positions actually bound during this method execution.

Throws:

SQLException - Indicates problems performing the binding.

HibernateException - Indicates problems delegating binding to the types.

bindNamedParameters

protected int bindNamedParameters(PreparedStatement statement,
                                  Map namedParams,
                                  int startIndex,
                                  SessionImplementor session)
                           throws SQLException,
                                  HibernateException

Bind named parameters to the JDBC prepared statement.

This is a generic implementation, the problem being that in the general case we do not know enough information about the named parameters to perform this in a complete manner here. Thus this is generally overridden on subclasses allowing named parameters to apply the specific behavior. The most usual limitation here is that we need to assume the type span is always one...

Parameters:

statement - The JDBC prepared statement

namedParams - A map of parameter names to values

startIndex - The position from which to start binding parameter values.

session - The originating session.

Returns:

The number of JDBC bind positions actually bound during this method execution.

Throws:

SQLException - Indicates problems performing the binding.

HibernateException - Indicates problems delegating binding to the types.

getResultSet

protected final ResultSet getResultSet(PreparedStatement st,
                                       RowSelection selection,
                                       LimitHandler limitHandler,
                                       boolean autodiscovertypes,
                                       SessionImplementor session)
                                throws SQLException,
                                       HibernateException

Execute given PreparedStatement, advance to the first result and return SQL ResultSet.

Throws:

SQLException

HibernateException

advance

protected void advance(ResultSet rs,
                       RowSelection selection)
                throws SQLException

Advance the cursor to the first required row of the ResultSet

Throws:

SQLException