java.lang.Object
- org.hibernate.loader.Loader
- - org.hibernate.loader.custom.CustomLoader

```
public class CustomLoader
extends Loader
```
Extension point for loaders which use a SQL result set with "unexpected" column aliases.

Nested Class Summary
- Nested classes/interfaces inherited from class org.hibernate.loader.Loader
  Loader.SqlStatementWrapper

Field Summary
- Fields inherited from class org.hibernate.loader.Loader
  LOG, SELECT, SELECT_DISTINCT

Constructor Summary

Constructors
Constructor Description

CustomLoader(CustomQuery customQuery, SessionFactoryImplementor factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`applyLocks(String sql, QueryParameters parameters, Dialect dialect, List<AfterLoadAction> afterLoadActions)`	Append `FOR UPDATE OF` clause, if necessary.
`protected void`	`autoDiscoverTypes(ResultSet rs)`
`protected int`	`bindParameterValues(PreparedStatement statement, QueryParameters queryParameters, int startIndex, SharedSessionContractImplementor session)`	Bind all parameter values into the prepared statement in preparation for execution.
`protected CollectionAliases[]`	`getCollectionAliases()`
`protected int[]`	`getCollectionOwners()`	Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie.
`protected CollectionPersister[]`	`getCollectionPersisters()`	An (optional) persister for a collection to be initialized; only collection loaders return a non-null value
`protected EntityAliases[]`	`getEntityAliases()`	Get the result set descriptor
`protected Loadable[]`	`getEntityPersisters()`	An array of persisters of entity classes contained in each row of results; implemented by all subclasses
`protected LockMode[]`	`getLockModes(LockOptions lockOptions)`	What lock options does this load entities with?
`protected int[]`	`getOwners()`	An array of indexes of the entity that owns a one-to-one association to the entity at the given index (-1 if there is no "owner").
`protected String`	`getQueryIdentifier()`	Identifies the query for statistics reporting, if null, no statistics will be reported
`Set`	`getQuerySpaces()`
`protected Object`	`getResultColumnOrRow(Object[] row, ResultTransformer transformer, ResultSet rs, SharedSessionContractImplementor session)`	Get the actual object that is returned in the user-visible result list.
`protected List`	`getResultList(List results, ResultTransformer resultTransformer)`
`protected Object[]`	`getResultRow(Object[] row, ResultSet rs, SharedSessionContractImplementor session)`
`protected String[]`	`getResultRowAliases()`	Returns the aliases that corresponding to a result row.
`String`	`getSQLString()`	The SQL query string to be called; implemented by all subclasses
`protected boolean[]`	`includeInResultRow()`
`List`	`list(SharedSessionContractImplementor session, QueryParameters queryParameters)`
`protected void`	`putResultInQueryCache(SharedSessionContractImplementor session, QueryParameters queryParameters, Type[] resultTypes, QueryResultsCache queryCache, QueryKey key, List result)`	`resultTypes` can be overridden by `autoDiscoverTypes(ResultSet)`, after `list(SharedSessionContractImplementor, QueryParameters)` has already been called.
`protected ResultTransformer`	`resolveResultTransformer(ResultTransformer resultTransformer)`	Determine the actual ResultTransformer that will be used to transform query results.
`ScrollableResultsImplementor`	`scroll(QueryParameters queryParameters, SharedSessionContractImplementor session)`
`protected void`	`validateAlias(String alias)`

Methods inherited from class org.hibernate.loader.Loader
applyPostLoadLocks, areResultSetRowsTransformedImmediately, bindNamedParameters, bindPositionalParameters, bindPreparedStatement, checkScrollability, createCacheableResultTransformer, createSubselects, determineFollowOnLockMode, doList, doQueryAndInitializeNonLazyCollections, doQueryAndInitializeNonLazyCollections, endCollectionLoad, executeQueryStatement, executeQueryStatement, extractKeysFromResultSet, generateQueryKey, getAliases, getCompositeKeyManyToOneTargetIndices, getEntityEagerPerPropertyFetches, getEntityEagerPropertyFetches, getEntityPersister, getFactory, getLimitHandler, getNamedParameterLocs, getOptionalObjectKey, getOwnerAssociationTypes, getResultFromQueryCache, getResultSet, getResultSet, getRowsFromResultSet, handleEmptyCollections, hasSubselectLoadableCollections, instanceAlreadyLoaded, instanceNotYetLoaded, isSingleRowLoader, isSubselectLoadingEnabled, list, loadCollection, loadCollectionBatch, loadCollectionSubselect, loadEntity, loadEntity, loadEntityBatch, loadEntityBatch, loadSequentialRowsForward, loadSequentialRowsReverse, loadSingleRow, needsFetchingScroll, postInstantiate, prepareQueryStatement, preprocessResultSet, preprocessSQL, processDistinctKeyword, processResultSet, registerNonExists, scroll, shouldUseFollowOnLocking, toString, upgradeLocks

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomLoader
```
public CustomLoader(CustomQuery customQuery,
                    SessionFactoryImplementor factory)
```
- Method Detail
  - getQueryIdentifier
```
protected String getQueryIdentifier()
```
    Description copied from class: Loader
    
    Identifies the query for statistics reporting, if null, no statistics will be reported
    
    Overrides:
    
    getQueryIdentifier in class Loader
  - getSQLString
```
public String getSQLString()
```
    Description copied from class: Loader
    
    The SQL query string to be called; implemented by all subclasses
    
    Specified by:
    
    getSQLString in class Loader
    
    Returns:
    
    The sql command this loader should use to get its ResultSet.
  - getQuerySpaces
```
public Set getQuerySpaces()
```
  - getLockModes
```
protected LockMode[] getLockModes(LockOptions lockOptions)
```
    Description copied from class: Loader
    
    What lock options does this load entities with?
    
    Specified by:
    
    getLockModes in class Loader
    
    Parameters:
    
    lockOptions - a collection of lock options specified dynamically via the Query interface
  - getEntityPersisters
```
protected Loadable[] getEntityPersisters()
```
    Description copied from class: Loader
    
    An array of persisters of entity classes contained in each row of results; implemented by all subclasses
    
    Specified by:
    
    getEntityPersisters in class Loader
    
    Returns:
    
    The entity persisters.
  - getCollectionPersisters
```
protected CollectionPersister[] getCollectionPersisters()
```
    Description copied from class: Loader
    
    An (optional) persister for a collection to be initialized; only collection loaders return a non-null value
    
    Overrides:
    
    getCollectionPersisters in class Loader
  - getCollectionOwners
```
protected int[] getCollectionOwners()
```
    Description copied from class: Loader
    
    Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie. in the case of a collection initializer) or no collection.
    
    Overrides:
    
    getCollectionOwners in class Loader
  - getOwners
```
protected int[] getOwners()
```
    Description copied from class: Loader
    
    An array of indexes of the entity that owns a one-to-one association to the entity at the given index (-1 if there is no "owner"). The indexes contained here are relative to the result of Loader.getEntityPersisters().
    
    Overrides:
    
    getOwners in class Loader
    
    Returns:
    
    The owner indicators (see discussion above).
  - list
```
public List list(SharedSessionContractImplementor session,
                 QueryParameters queryParameters)
          throws HibernateException
```
    Throws:
    
    HibernateException
  - applyLocks
```
protected String applyLocks(String sql,
                            QueryParameters parameters,
                            Dialect dialect,
                            List<AfterLoadAction> afterLoadActions)
                     throws QueryException
```
    Description copied from class: Loader
    
    Append FOR UPDATE OF clause, if necessary. This empty superclass implementation merely returns its first argument.
    
    Overrides:
    
    applyLocks in class Loader
    
    Throws:
    
    QueryException
  - scroll
```
public ScrollableResultsImplementor scroll(QueryParameters queryParameters,
                                           SharedSessionContractImplementor session)
                                    throws HibernateException
```
    Throws:
    
    HibernateException
  - getResultRowAliases
```
protected String[] getResultRowAliases()
```
    Description copied from class: Loader
    
    Returns the aliases that corresponding to a result row.
    
    Overrides:
    
    getResultRowAliases in class Loader
    
    Returns:
    
    Returns the aliases that corresponding to a result row.
  - resolveResultTransformer
```
protected ResultTransformer resolveResultTransformer(ResultTransformer resultTransformer)
```
    Description copied from class: Loader
    
    Determine the actual ResultTransformer that will be used to transform query results.
    
    Overrides:
    
    resolveResultTransformer in class Loader
    
    Parameters:
    
    resultTransformer - the specified result transformer
    
    Returns:
    
    the actual result transformer
  - includeInResultRow
```
protected boolean[] includeInResultRow()
```
    Overrides:
    
    includeInResultRow in class Loader
  - getResultColumnOrRow
```
protected Object getResultColumnOrRow(Object[] row,
                                      ResultTransformer transformer,
                                      ResultSet rs,
                                      SharedSessionContractImplementor session)
                               throws SQLException,
                                      HibernateException
```
    Description copied from class: Loader
    
    Get the actual object that is returned in the user-visible result list. This empty implementation merely returns its first argument. This is overridden by some subclasses.
    
    Overrides:
    
    getResultColumnOrRow in class Loader
    
    Throws:
    
    SQLException
    
    HibernateException
  - getResultRow
```
protected Object[] getResultRow(Object[] row,
                                ResultSet rs,
                                SharedSessionContractImplementor session)
                         throws SQLException,
                                HibernateException
```
    Overrides:
    
    getResultRow in class Loader
    
    Throws:
    
    SQLException
    
    HibernateException
  - getResultList
```
protected List getResultList(List results,
                             ResultTransformer resultTransformer)
                      throws QueryException
```
    Overrides:
    
    getResultList in class Loader
    
    Throws:
    
    QueryException
  - getEntityAliases
```
protected EntityAliases[] getEntityAliases()
```
    Description copied from class: Loader
    
    Get the result set descriptor
    
    Specified by:
    
    getEntityAliases in class Loader
  - getCollectionAliases
```
protected CollectionAliases[] getCollectionAliases()
```
    Specified by:
    
    getCollectionAliases in class Loader
  - bindParameterValues
```
protected int bindParameterValues(PreparedStatement statement,
                                  QueryParameters queryParameters,
                                  int startIndex,
                                  SharedSessionContractImplementor session)
                           throws SQLException
```
    Description copied from class: Loader
    
    Bind all parameter values into the prepared statement in preparation for execution.
    
    Overrides:
    
    bindParameterValues in class Loader
    
    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.
  - autoDiscoverTypes
```
protected void autoDiscoverTypes(ResultSet rs)
```
    Overrides:
    
    autoDiscoverTypes in class Loader
  - validateAlias
```
protected void validateAlias(String alias)
```
  - putResultInQueryCache
```
protected void putResultInQueryCache(SharedSessionContractImplementor session,
                                     QueryParameters queryParameters,
                                     Type[] resultTypes,
                                     QueryResultsCache queryCache,
                                     QueryKey key,
                                     List result)
```
    resultTypes can be overridden by autoDiscoverTypes(ResultSet), *after* list(SharedSessionContractImplementor, QueryParameters) has already been called. It's a bit of a chicken-and-the-egg issue since autoDiscoverTypes(ResultSet) needs the ResultSet.
    As a hacky workaround, overridden here to provide the resultTypes. see HHH-3051
    
    Overrides:
    
    putResultInQueryCache in class Loader

Class CustomLoader

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.loader.Loader

Field Summary

Fields inherited from class org.hibernate.loader.Loader

Constructor Summary

Method Summary

Methods inherited from class org.hibernate.loader.Loader

Methods inherited from class java.lang.Object

Constructor Detail

CustomLoader

Method Detail

getQueryIdentifier

getSQLString

getQuerySpaces

getLockModes

getEntityPersisters

getCollectionPersisters

getCollectionOwners

getOwners

list

applyLocks

scroll

getResultRowAliases

resolveResultTransformer

includeInResultRow

getResultColumnOrRow

getResultRow

getResultList

getEntityAliases

getCollectionAliases

bindParameterValues

autoDiscoverTypes

validateAlias

putResultInQueryCache