org.alfresco.repo.web.util

Class PagingCursor.Rows

java.lang.Object

org.alfresco.repo.web.util.PagingCursor.Rows

Enclosing class:

PagingCursor

public static class PagingCursor.Rows
extends Object

Rows based Cursor

Constructor Summary

Constructors

Constructor and Description
PagingCursor.Rows(long totalRows, long maxRows, long skipRows, boolean zeroBasedRow) Create a Rows based Cursor

Method Summary

Methods

Modifier and Type	Method and Description
long	getEndRow() Gets the end row within collection for this page
long	getMaxRows() Gets the maximum number of rows to include in this page
long	getNextSkipRows() Gets the next skip count
long	getSkipRows() Gets the number rows skipped
long	getStartRow() Gets the start row within collection for this page
long	getTotalRows() Gets the total number of rows
boolean	isInRange() Is the cursor within range of the total number of rows

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingCursor.Rows

public PagingCursor.Rows(long totalRows,
                 long maxRows,
                 long skipRows,
                 boolean zeroBasedRow)

Create a Rows based Cursor

Parameters:

totalRows - total rows in collection

maxRows - maximum number of rows in page

skipRows - number of rows to skip (0 - none)

zeroBasedRow - true => 0 based, false => 1 based

Method Detail

getTotalRows

public long getTotalRows()

Gets the total number of rows

Returns:

total rows

getSkipRows

public long getSkipRows()

Gets the number rows skipped

Returns:

skipped row count

getMaxRows

public long getMaxRows()

Gets the maximum number of rows to include in this page

Returns:

maximum of numbers

isInRange

public boolean isInRange()

Is the cursor within range of the total number of rows

Returns:

true => within range of total rows

getStartRow

public long getStartRow()

Gets the start row within collection for this page

Returns:

start row index

getEndRow

public long getEndRow()

Gets the end row within collection for this page

Returns:

end row index

getNextSkipRows

public long getNextSkipRows()

Gets the next skip count

Returns:

next skip row