org.alfresco.query
Class CannedQueryPageDetails

java.lang.Object
  org.alfresco.query.CannedQueryPageDetails

public class CannedQueryPageDetails
extends java.lang.Object

Details for canned queries supporting paged results.

Results are skipped, chopped into pages of appropriate size before the start page and number are returned.

Since:

4.0

Field Summary

static int	DEFAULT_PAGE_COUNT
static int	DEFAULT_PAGE_NUMBER
static int	DEFAULT_PAGE_SIZE
static int	DEFAULT_SKIP_RESULTS

Constructor Summary

CannedQueryPageDetails()
Construct with defaults skipResults: CannedQueryPageDetails.DEFAULT_SKIP_RESULTS pageSize: CannedQueryPageDetails.DEFAULT_PAGE_SIZE pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT

CannedQueryPageDetails(int skipResults, int pageSize)
Construct with defaults pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT

CannedQueryPageDetails(int skipResults, int pageSize, int pageNumber, int pageCount)

CannedQueryPageDetails(PagingRequest pagingRequest)
Helper constructor to transform a paging request into the Canned Query form.

Method Summary

int	getPageCount() Get the total number of pages to return
int	getPageNumber() Get the first page number to return
int	getPageSize() Get the size of each page
int	getResultsRequiredForPaging() Calculate the number of results that would be required to satisy this paging request.
int	getSkipResults() Get the number of query results to skip before applying further page parameters
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SKIP_RESULTS

public static final int DEFAULT_SKIP_RESULTS

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_PAGE_NUMBER

public static final int DEFAULT_PAGE_NUMBER

See Also:

Constant Field Values

DEFAULT_PAGE_COUNT

public static final int DEFAULT_PAGE_COUNT

See Also:

Constant Field Values

Constructor Detail

CannedQueryPageDetails

public CannedQueryPageDetails()

Construct with defaults

• skipResults: CannedQueryPageDetails.DEFAULT_SKIP_RESULTS
• pageSize: CannedQueryPageDetails.DEFAULT_PAGE_SIZE
• pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
• pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT

CannedQueryPageDetails

public CannedQueryPageDetails(int skipResults,
                              int pageSize)

Construct with defaults

• pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
• pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT

Parameters:

skipResults - results to skip before page one (default CannedQueryPageDetails.DEFAULT_SKIP_RESULTS)

pageSize - the size of each page (default CannedQueryPageDetails.DEFAULT_PAGE_SIZE)

CannedQueryPageDetails

public CannedQueryPageDetails(int skipResults,
                              int pageSize,
                              int pageNumber,
                              int pageCount)

Parameters:

skipResults - results to skip before page one (default CannedQueryPageDetails.DEFAULT_SKIP_RESULTS)

pageSize - the size of each page (default CannedQueryPageDetails.DEFAULT_PAGE_SIZE)

pageNumber - the first page number to return (default CannedQueryPageDetails.DEFAULT_PAGE_NUMBER)

pageCount - the number of pages to return (default CannedQueryPageDetails.DEFAULT_PAGE_COUNT)

CannedQueryPageDetails

public CannedQueryPageDetails(PagingRequest pagingRequest)

Helper constructor to transform a paging request into the Canned Query form.

Parameters:

pagingRequest - the paging details

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSkipResults

public int getSkipResults()

Get the number of query results to skip before applying further page parameters

Returns:

results to skip before page one

getPageSize

public int getPageSize()

Get the size of each page

Returns:

the size of each page

getPageNumber

public int getPageNumber()

Get the first page number to return

Returns:

the first page number to return

getPageCount

public int getPageCount()

Get the total number of pages to return

Returns:

the number of pages to return

getResultsRequiredForPaging

public int getResultsRequiredForPaging()

Calculate the number of results that would be required to satisy this paging request. Note that the skip size can significantly increase this number even if the page sizes are small.

Returns:

the number of results required for proper paging