EntityLoader

Class Overview

Loads an entity instance using outerjoin fetching to fetch associated entities.
The EntityPersister must implement Loadable. For other entities, create a customized subclass of Loader.

Summary

[Expand] Inherited Fields
From class org.hibernate.loader.entity.AbstractEntityLoader protected final String entityName protected static final Logger log protected final OuterJoinLoadable persister protected final Type uniqueKeyType
From class org.hibernate.loader.OuterJoinLoader protected String[] aliases protected int[] collectionOwners protected CollectionPersister[] collectionPersisters protected String[] collectionSuffixes protected LockMode[] lockModeArray protected EntityType[] ownerAssociationTypes protected int[] owners protected Loadable[] persisters protected String sql protected String[] suffixes
From class org.hibernate.loader.BasicLoader protected static final String[] NO_SUFFIX

[Expand] Inherited Methods
From class org.hibernate.loader.entity.AbstractEntityLoader Object getResultColumnOrRow(Object[] row, ResultTransformer transformer, ResultSet rs, SessionImplementor session) Get the actual object that is returned in the user-visible result list. boolean isSingleRowLoader() Return false is this loader is a batch entity loader Object load(Serializable id, Object optionalObject, SessionImplementor session, LockOptions lockOptions) Load an entity instance by id. Object load(Serializable id, Object optionalObject, SessionImplementor session) Load an entity instance. Object load(SessionImplementor session, Object id, Object optionalObject, Serializable optionalId, LockOptions lockOptions)
From class org.hibernate.loader.OuterJoinLoader final String[] getAliases() Get the SQL table aliases of entities whose associations are subselect-loadable, returning null if this loader does not support subselect loading final int[] getCollectionOwners() Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie. final CollectionPersister[] getCollectionPersisters() An (optional) persister for a collection to be initialized; only collection loaders return a non-null value String[] getCollectionSuffixes() final Dialect getDialect() final Loadable[] getEntityPersisters() An array of persisters of entity classes contained in each row of results; implemented by all subclasses LoadQueryInfluencers getLoadQueryInfluencers() LockMode[] getLockModes(LockOptions lockOptions) What lock options does this load entities with? LockOptions getLockOptions() EntityType[] getOwnerAssociationTypes() An array of the owner types corresponding to the getOwners() returns. 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"). final String getSQLString() The SQL query string to be called; implemented by all subclasses String[] getSuffixes() void initFromWalker(JoinWalker walker)
From class org.hibernate.loader.BasicLoader static String[] generateSuffixes(int seed, int length) static String[] generateSuffixes(int length) Utility method that generates 0_, 1_ suffixes. final CollectionAliases[] getCollectionAliases() abstract String[] getCollectionSuffixes() final EntityAliases[] getEntityAliases() Get the result set descriptor abstract String[] getSuffixes() void postInstantiate() Calculate and cache select-clause suffixes.
From class org.hibernate.loader.Loader String applyLocks(String sql, LockOptions lockOptions, Dialect dialect) Append FOR UPDATE OF clause, if necessary. void applyPostLoadLocks(Object[] row, LockMode[] lockModesArray, SessionImplementor session) boolean areResultSetRowsTransformedImmediately(ResultTransformer transformer) Are rows transformed immediately after being read from the ResultSet? void autoDiscoverTypes(ResultSet rs) int bindNamedParameters(PreparedStatement statement, Map namedParams, int startIndex, SessionImplementor session) Bind named parameters to the JDBC prepared statement. int bindParameterValues(PreparedStatement statement, QueryParameters queryParameters, int startIndex, SessionImplementor session) Bind all parameter values into the prepared statement in preparation for execution. int bindPositionalParameters(PreparedStatement statement, QueryParameters queryParameters, int startIndex, SessionImplementor session) Bind positional parameter values to the JDBC prepared statement. void checkScrollability() Check whether the current loader can support returning ScrollableResults. List doList(SessionImplementor session, QueryParameters queryParameters) Actually execute a query, ignoring the query cache void extractKeysFromResultSet(Loadable[] persisters, QueryParameters queryParameters, ResultSet resultSet, SessionImplementor session, EntityKey[] keys, LockMode[] lockModes, List hydratedObjects) String[] getAliases() Get the SQL table aliases of entities whose associations are subselect-loadable, returning null if this loader does not support subselect loading abstract CollectionAliases[] getCollectionAliases() int[] getCollectionOwners() Get the index of the entity that owns the collection, or -1 if there is no owner in the query results (ie. CollectionPersister[] getCollectionPersisters() An (optional) persister for a collection to be initialized; only collection loaders return a non-null value int[][] getCompositeKeyManyToOneTargetIndices() abstract EntityAliases[] getEntityAliases() Get the result set descriptor boolean[] getEntityEagerPropertyFetches() An array indicating whether the entities have eager property fetching enabled. abstract Loadable[] getEntityPersisters() An array of persisters of entity classes contained in each row of results; implemented by all subclasses final SessionFactoryImplementor getFactory() abstract LockMode[] getLockModes(LockOptions lockOptions) What lock options does this load entities with? int[] getNamedParameterLocs(String name) EntityType[] getOwnerAssociationTypes() An array of the owner types corresponding to the getOwners() returns. 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"). String getQueryIdentifier() Identifies the query for statistics reporting, if null, no statistics will be reported Object getResultColumnOrRow(Object[] row, ResultTransformer transformer, ResultSet rs, SessionImplementor session) Get the actual object that is returned in the user-visible result list. List getResultList(List results, ResultTransformer resultTransformer) final ResultSet getResultSet(PreparedStatement st, boolean autodiscovertypes, boolean callable, RowSelection selection, SessionImplementor session) Fetch a PreparedStatement, call setMaxRows and then execute it, advance to the first result and return an SQL ResultSet abstract String getSQLString() The SQL query string to be called; implemented by all subclasses boolean hasSubselectLoadableCollections() boolean isSingleRowLoader() Return false is this loader is a batch entity loader boolean isSubselectLoadingEnabled() List list(SessionImplementor session, QueryParameters queryParameters, Set querySpaces, Type[] resultTypes) Return the query results, using the query cache, called by subclasses that implement cacheable queries final void loadCollection(SessionImplementor session, Serializable id, Type type) Called by subclasses that initialize collections final void loadCollectionBatch(SessionImplementor session, Serializable[] ids, Type type) Called by wrappers that batch initialize collections final void loadCollectionSubselect(SessionImplementor session, Serializable[] ids, Object[] parameterValues, Type[] parameterTypes, Map namedParameters, Type type) Called by subclasses that batch initialize collections final List loadEntity(SessionImplementor session, Object id, Type identifierType, Object optionalObject, String optionalEntityName, Serializable optionalIdentifier, EntityPersister persister, LockOptions lockOptions) Called by subclasses that load entities final List loadEntity(SessionImplementor session, Object key, Object index, Type keyType, Type indexType, EntityPersister persister) Called by subclasses that load entities final List loadEntityBatch(SessionImplementor session, Serializable[] ids, Type idType, Object optionalObject, String optionalEntityName, Serializable optionalId, EntityPersister persister, LockOptions lockOptions) Called by wrappers that batch load entities Object loadSequentialRowsForward(ResultSet resultSet, SessionImplementor session, QueryParameters queryParameters, boolean returnProxies) Loads a single logical row from the result set moving forward. Object loadSequentialRowsReverse(ResultSet resultSet, SessionImplementor session, QueryParameters queryParameters, boolean returnProxies, boolean isLogicallyAfterLast) Loads a single logical row from the result set moving forward. Object loadSingleRow(ResultSet resultSet, SessionImplementor session, QueryParameters queryParameters, boolean returnProxies) Loads a single row from the result set. boolean needsFetchingScroll() Does the result set to be scrolled contain collection fetches? void postInstantiate() Calculate and cache select-clause suffixes. final PreparedStatement prepareQueryStatement(QueryParameters queryParameters, boolean scroll, SessionImplementor session) Obtain a PreparedStatement with all parameters pre-bound. String preprocessSQL(String sql, QueryParameters parameters, Dialect dialect) Modify the SQL, adding lock hints and comments, if necessary ResultTransformer resolveResultTransformer(ResultTransformer resultTransformer) Determine the actual ResultTransformer that will be used to transform query results. ScrollableResults scroll(QueryParameters queryParameters, Type[] returnTypes, HolderInstantiator holderInstantiator, SessionImplementor session) Return the query results, as an instance of ScrollableResults String toString() boolean upgradeLocks() Does this query return objects that might be already cached by the session, whose lock mode may need upgrading
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.hibernate.loader.entity.UniqueEntityLoader abstract Object load(Serializable id, Object optionalObject, SessionImplementor session, LockOptions lockOptions) Load an entity instance by id. abstract Object load(Serializable id, Object optionalObject, SessionImplementor session) This method is deprecated. use load(java.io.Serializable, Object, SessionImplementor, LockOptions) instead.