jodd.joy.page

Class DbPager

java.lang.Object

jodd.joy.page.DbPager

Direct Known Subclasses:

HsqlDbPager, MySqlPager

public abstract class DbPager
extends java.lang.Object

Database pager.

Constructor Summary

Constructors

Constructor and Description
DbPager()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	buildCountSql(java.lang.String sql) Builds SQL for retrieving total number of results.
protected abstract java.lang.String	buildOrderSql(java.lang.String sql, java.lang.String column, boolean ascending) Builds order SQL string.
protected abstract java.lang.String	buildPageSql(java.lang.String sql, int from, int pageSize) Builds page SQL string.
protected PageRequest	getDefaultPageRequest() Returns default page request when passed one is null.
<T> PageData<T>	page(PageRequest pageRequest, java.lang.String sql, java.util.Map params, java.lang.String[] sortColumns, java.lang.Class[] target) Performs the pagination with given PageRequest.
protected <T> PageData<T>	page(java.lang.String sql, java.util.Map params, int page, int pageSize, java.lang.String sortColumnName, boolean ascending, java.lang.Class[] target) Pages given page.
protected java.lang.String	removeLastOrderBy(java.lang.String sql) Removes everything from last "order by".
protected java.lang.String	removeSelect(java.lang.String sql) Removes the first 'select' from the sql query.
protected java.lang.String	removeToFrom(java.lang.String sql) Removes the first part of the sql up to the relevant 'from'.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbPager

public DbPager()

Method Detail

getDefaultPageRequest

protected PageRequest getDefaultPageRequest()

Returns default page request when passed one is null. This usually happens on initial page view, when no page request is created. Returned PageRequest defines global defaults.

page

public <T> PageData<T> page(PageRequest pageRequest,
                            java.lang.String sql,
                            java.util.Map params,
                            java.lang.String[] sortColumns,
                            java.lang.Class[] target)

Performs the pagination with given PageRequest.

Parameters:

pageRequest - page request, may be null, then the default page request will be used

sql - SQL query that lists all items

params - SQL query parameters or null

sortColumns - array of all column names

target - db entities for mapping (as usual in DbOom)

See Also:

page(String, java.util.Map, int, int, String, boolean, Class[])

page

protected <T> PageData<T> page(java.lang.String sql,
                               java.util.Map params,
                               int page,
                               int pageSize,
                               java.lang.String sortColumnName,
                               boolean ascending,
                               java.lang.Class[] target)

Pages given page.

Parameters:

sql - sql query that lists all items

params - map of SQL parameters

page - current page to show

pageSize - number of items to show

sortColumnName - name of sorting column, null for no sorting

ascending - true for ascending order

target - db entities for mapping (sa usual in DbOom)

buildOrderSql

protected abstract java.lang.String buildOrderSql(java.lang.String sql,
                                                  java.lang.String column,
                                                  boolean ascending)

Builds order SQL string. Invoked before all other SQL modification.

buildPageSql

protected abstract java.lang.String buildPageSql(java.lang.String sql,
                                                 int from,
                                                 int pageSize)

Builds page SQL string. Returned SQL string may return more than pageSize elements, but only pageSize will be consumed.

buildCountSql

protected abstract java.lang.String buildCountSql(java.lang.String sql)

Builds SQL for retrieving total number of results.

removeSelect

protected java.lang.String removeSelect(java.lang.String sql)

Removes the first 'select' from the sql query.

removeToFrom

protected java.lang.String removeToFrom(java.lang.String sql)

Removes the first part of the sql up to the relevant 'from'. Tries to detect sub-queries in the 'select' part.

removeLastOrderBy

protected java.lang.String removeLastOrderBy(java.lang.String sql)

Removes everything from last "order by".