gov.va.vinci.leo.tools.db

Class SQLServerPagedQuery

java.lang.Object

gov.va.vinci.leo.tools.db.SQLServerPagedQuery

public class SQLServerPagedQuery
extends Object

Helper class for paging through SQL Server records. This uses the built-in offset/fetch next functionality that is available in SQL Server 2008+ Note: This closes the connection after getting a page, and re-opens it before getting the next page.

Constructor Summary

Constructors

Constructor and Description
SQLServerPagedQuery(String query, Integer pageSize) Constructor
SQLServerPagedQuery(String query, Integer pageSize, Integer firstOffset) Constructor
SQLServerPagedQuery(String query, Integer pageSize, Integer firstOffset, Integer maxOffset) Constructor

Method Summary

Modifier and Type	Method and Description
String	getPageQuery(Integer pageNumber) Get the query needed to get a specific page of records from the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLServerPagedQuery

public SQLServerPagedQuery(String query,
                           Integer pageSize)

Constructor

Parameters:

query - the query to be paged, must include an order by.

pageSize - the page size.

SQLServerPagedQuery

public SQLServerPagedQuery(String query,
                           Integer pageSize,
                           Integer firstOffset)

Constructor

Parameters:

query - the query to be paged, must include an order by.

pageSize - the page size.

firstOffset - the first row to start with. Generally this will be 0.

SQLServerPagedQuery

public SQLServerPagedQuery(String query,
                           Integer pageSize,
                           Integer firstOffset,
                           Integer maxOffset)

Constructor

Parameters:

query - the query to be paged, must include an order by.

pageSize - the page size.

firstOffset - the first row to start with. Generally this will be 0.

maxOffset - the last row to get.

Method Detail

getPageQuery

public String getPageQuery(Integer pageNumber)

Get the query needed to get a specific page of records from the database.

Parameters:

pageNumber - which page to get. Page index starts at 0.

Returns:

The SQL Server query to get the page of records. If no more records can be selected (maxOffset > offset), then null is returned.