{@code
+ *
+ * // We want to find the first 100 new orders
+ * // ... 0 means first page
+ * // ... page size is 100
+ *
+ * PagedList pagedList
+ * = ebeanServer.find(Order.class)
+ * .where().eq("status", Order.Status.NEW)
+ * .order().asc("id")
+ * .findPagedList(0, 100);
+ *
+ * // Optional: initiate the loading of the total
+ * // row count in a background thread
+ * pagedList.loadRowCount();
+ *
+ * // fetch and return the list in the foreground thread
+ * List orders = pagedList.getList();
+ *
+ * // get the total row count (from the future)
+ * int totalRowCount = pagedList.getTotalRowCount();
+ *
+ * }
+ *
+ * {@code
+ *
+ * // If you are not getting the 'first page' often
+ * // you do not bother getting the total row count again
+ * // so instead just get the page list of data
+ *
+ * // fetch and return the list in the foreground thread
+ * List orders = pagedList.getList();
+ *
+ * }
+ *
* @param {@code
+ *
+ * // initiate the loading of the total row count
+ * // in a background thread
+ * pagedList.loadRowCount();
+ *
+ * // fetch and return the list in the foreground thread
+ * List orders = pagedList.getList();
+ *
+ * // get the total row count (from the future)
+ * int totalRowCount = pagedList.getTotalRowCount();
+ *
+ * }
+ *
+ * + * Also note that using loadRowCount() and getTotalRowCount() rather than getFutureRowCount() + * means that exceptions ExecutionException, InterruptedException, TimeoutException are instead + * wrapped in the unchecked PersistenceException (which might be preferrable). + *
*/ public void loadRowCount(); /** * Return the Future row count. You might get this if you wish to cancel the total row count query - * or specify a timeout for that query. + * or specify a timeout for the row count query. + *+ * The loadRowCount() & getTotalRowCount() methods internally make use of this getFutureRowCount() method. + * Generally I expect people to prefer loadRowCount() & getTotalRowCount() over getFutureRowCount(). + *
+ *{@code
+ *
+ * // initiate the row count query in the background thread
+ * Future rowCount = pagedList.getFutureRowCount();
+ *
+ * // fetch and return the list in the foreground thread
+ * List orders = pagedList.getList();
+ *
+ * // now get the total count with a timeout
+ * Integer totalRowCount = rowCount.get(30, TimeUnit.SECONDS);
+ *
+ * // or ge the total count without a timeout
+ * Integer totalRowCountViaFuture = rowCount.get();
+ *
+ * // which is actually the same as ...
+ * int totalRowCount = pagedList.getTotalRowCount();
+ *
+ * }
*/
public Future+ * If loadRowCount() has already been called then the row count query is already executing in a background thread + * and this gets the associated Future and gets the value waiting for the future to finish. + *
+ *+ * If loadRowCount() has not been called then this executes the find row count query and returns the result and this + * will just occur in the current thread and not use a background thread. + *
+ *{@code
+ *
+ * // Optional: initiate the loading of the total
+ * // row count in a background thread
+ * pagedList.loadRowCount();
+ *
+ * // fetch and return the list in the foreground thread
+ * List orders = pagedList.getList();
+ *
+ * // get the total row count (which was being executed
+ * // in a background thread if loadRowCount() was used)
+ * int totalRowCount = pagedList.getTotalRowCount();
+ *
+ * }
*/
public int getTotalRowCount();
/**
* Return the total number of pages based on the page size and total row count.
+ * + * This method requires that the total row count has been fetched and will invoke + * the total row count query if it has not already been invoked. + *
*/ public int getTotalPageCount(); @@ -57,6 +161,10 @@ public interface PagedList+ * This method requires that the total row count has been fetched and will invoke + * the total row count query if it has not already been invoked. + *
*/ public boolean hasNext(); @@ -68,7 +176,11 @@ public interface PagedList+ * This method requires that the total row count has been fetched and will invoke + * the total row count query if it has not already been invoked. + *
+ * * @param to * String to put between the first and last row * @param of diff --git a/src/main/java/com/avaje/ebeaninternal/server/query/LimitOffsetPagedList.java b/src/main/java/com/avaje/ebeaninternal/server/query/LimitOffsetPagedList.java index 994f4d84b..12e9dddce 100644 --- a/src/main/java/com/avaje/ebeaninternal/server/query/LimitOffsetPagedList.java +++ b/src/main/java/com/avaje/ebeaninternal/server/query/LimitOffsetPagedList.java @@ -28,6 +28,8 @@ public class LimitOffsetPagedList