HHH-7841 - Redesign Loader
This commit is contained in:
Steve Ebersole
parent
a102bf2c31
commit
c75dafbedd
|
|
@ -0,0 +1,65 @@
|
|||
/*
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
* statements applied by the authors. All third-party contributions are
|
||||
* distributed under license by Red Hat Inc.
|
||||
*
|
||||
* This copyrighted material is made available to anyone wishing to use, modify,
|
||||
* copy, or redistribute it subject to the terms and conditions of the GNU
|
||||
* Lesser General Public License, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
|
||||
* for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this distribution; if not, write to:
|
||||
* Free Software Foundation, Inc.
|
||||
* 51 Franklin Street, Fifth Floor
|
||||
* Boston, MA 02110-1301 USA
|
||||
*/
|
||||
package org.hibernate.loader.spi;
|
||||
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.util.List;
|
||||
|
||||
import org.hibernate.engine.spi.QueryParameters;
|
||||
import org.hibernate.engine.spi.SessionImplementor;
|
||||
import org.hibernate.loader.plan.spi.LoadPlan;
|
||||
import org.hibernate.transform.ResultTransformer;
|
||||
|
||||
/**
|
||||
* Definition of the Loader contract.
|
||||
* <p/>
|
||||
* Capabilities I'd like to see added (todo):<ul>
|
||||
* <li>
|
||||
* expose the underlying "query" (although what I see here relies heavily on
|
||||
* https://github.com/hibernate/hibernate-orm/wiki/Proposal---SQL-generation)
|
||||
* </li>
|
||||
* </ul>
|
||||
*
|
||||
*
|
||||
* @author Gavin King
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
public interface Loader {
|
||||
public LoadPlan getLoadPlan();
|
||||
|
||||
/**
|
||||
* Obtain the on-demand form of this loader, if possible.
|
||||
*
|
||||
* @return The on-demand version of this loader
|
||||
*/
|
||||
public OnDemandLoader asOnDemandLoader();
|
||||
|
||||
public List extractResults(
|
||||
ResultSet resultSet,
|
||||
SessionImplementor session,
|
||||
QueryParameters queryParameters,
|
||||
boolean returnProxies,
|
||||
ResultTransformer forcedResultTransformer) throws SQLException;
|
||||
}
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
/*
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
* statements applied by the authors. All third-party contributions are
|
||||
* distributed under license by Red Hat Inc.
|
||||
*
|
||||
* This copyrighted material is made available to anyone wishing to use, modify,
|
||||
* copy, or redistribute it subject to the terms and conditions of the GNU
|
||||
* Lesser General Public License, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
|
||||
* for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this distribution; if not, write to:
|
||||
* Free Software Foundation, Inc.
|
||||
* 51 Franklin Street, Fifth Floor
|
||||
* Boston, MA 02110-1301 USA
|
||||
*/
|
||||
package org.hibernate.loader.spi;
|
||||
|
||||
import java.sql.ResultSet;
|
||||
|
||||
import org.hibernate.HibernateException;
|
||||
import org.hibernate.engine.spi.QueryParameters;
|
||||
import org.hibernate.engine.spi.SessionImplementor;
|
||||
|
||||
/**
|
||||
* Represents an on-demand loading strategy as need for processing single *logical* rows one at a time as required
|
||||
* for {@link org.hibernate.ScrollableResults} implementations.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
public interface OnDemandLoader {
|
||||
|
||||
/**
|
||||
* Given a ResultSet, extract just a single result row.
|
||||
*
|
||||
* Copy of {@link org.hibernate.loader.Loader#loadSingleRow(ResultSet, SessionImplementor, QueryParameters, boolean)}
|
||||
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
|
||||
* false...)
|
||||
*
|
||||
* @param resultSet The result set being processed.
|
||||
* @param session The originating session
|
||||
* @param queryParameters The "parameters" used to build the query
|
||||
*
|
||||
* @return The extracted result row
|
||||
*
|
||||
* @throws HibernateException Indicates a problem extracting values from the result set.
|
||||
*/
|
||||
public Object extractSingleRow(
|
||||
ResultSet resultSet,
|
||||
SessionImplementor session,
|
||||
QueryParameters queryParameters) throws HibernateException;
|
||||
|
||||
/**
|
||||
* Given a ResultSet extract "sequential rows". This is used in cases where we have multi-row fetches that
|
||||
* are sequential within the ResultSet due to ordering. Multiple ResultSet rows are read into a single query
|
||||
* result "row".
|
||||
*
|
||||
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsForward(ResultSet, SessionImplementor, QueryParameters, boolean)}
|
||||
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
|
||||
* false...)
|
||||
*
|
||||
* @param resultSet The result set being processed.
|
||||
* @param session The originating session
|
||||
* @param queryParameters The "parameters" used to build the query
|
||||
*
|
||||
* @return The extracted result row
|
||||
*
|
||||
* @throws org.hibernate.HibernateException Indicates a problem extracting values from the result set.
|
||||
*/
|
||||
public Object extractSequentialRowsForward(
|
||||
final ResultSet resultSet,
|
||||
final SessionImplementor session,
|
||||
final QueryParameters queryParameters) throws HibernateException;
|
||||
|
||||
/**
|
||||
* Like {@link #extractSequentialRowsForward} but here moving back through the ResultSet.
|
||||
*
|
||||
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsReverse(ResultSet, SessionImplementor, QueryParameters, boolean, boolean)}
|
||||
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
|
||||
* false...).
|
||||
*
|
||||
* todo : is 'logicallyAfterLastRow really needed? Can't that be deduced? In fact pretty positive it is not needed.
|
||||
*
|
||||
* @param resultSet The result set being processed.
|
||||
* @param session The originating session
|
||||
* @param queryParameters The "parameters" used to build the query
|
||||
* @param isLogicallyAfterLast Is the result set currently positioned after the last row; again, is this really needed? How is it any diff
|
||||
*
|
||||
* @return The extracted result row
|
||||
*
|
||||
* @throws org.hibernate.HibernateException Indicates a problem extracting values from the result set.
|
||||
*/
|
||||
public Object extractSequentialRowsReverse(
|
||||
ResultSet resultSet,
|
||||
SessionImplementor session,
|
||||
QueryParameters queryParameters,
|
||||
boolean isLogicallyAfterLast) throws HibernateException;
|
||||
}
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,3 +1,26 @@
|
|||
/*
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
* statements applied by the authors. All third-party contributions are
|
||||
* distributed under license by Red Hat Inc.
|
||||
*
|
||||
* This copyrighted material is made available to anyone wishing to use, modify,
|
||||
* copy, or redistribute it subject to the terms and conditions of the GNU
|
||||
* Lesser General Public License, as published by the Free Software Foundation.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
|
||||
* for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this distribution; if not, write to:
|
||||
* Free Software Foundation, Inc.
|
||||
* 51 Franklin Street, Fifth Floor
|
||||
* Boston, MA 02110-1301 USA
|
||||
*/
|
||||
package org.hibernate.tuple.entity;
|
||||
|
||||
import org.hibernate.engine.FetchStrategy;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* jDocBook, processing of DocBook sources
|
||||
* Hibernate, Relational Persistence for Idiomatic Java
|
||||
*
|
||||
* Copyright (c) 2013, Red Hat Inc. or third-party contributors as
|
||||
* indicated by the @author tags or express copyright attribution
|
||||
|
|
|
|||
Loading…
Reference in New Issue