ZenMagick 0.9.6

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
org.zenmagick.database.ZMQueryPager

Class ZMQueryPager

ZMObject
  |
  +--ZMQueryPager

public class ZMQueryPager
extends ZMObject

Paginate a query.

Author:
DerManoMann
Version:
$Id: ZMQueryPager.php 2157 2009-04-14 23:31:34Z dermanomann $
Fields inherited from org.zenmagick.ZMObject
properties_
Constructor Summary

ZMQueryPager(ZMQueryDetails queryDetails)

Create new instance for the given query.

Method Summary
void

addFilter(string filter)

Add a filter clause.

protected string

getFilterSQL()

Get the filter conditions.

array

getResults(ZMResultList resultList)

Get results.

int

getTotalNumberOfResults()

Get total number of results.

void

setOrderBy(string orderBy)

Set order by clause(s).

Methods inherited from org.zenmagick.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

ZMQueryPager

public ZMQueryPager(ZMQueryDetails queryDetails)

Create new instance for the given query.

Parameters:
queryDetails - The query details.

Method Detail

addFilter

public void addFilter(string filter)

Add a filter clause.

Parameters:
filter - The filter condition.

getFilterSQL

protected string getFilterSQL()

Get the filter conditions.

Returns:
The sql.

getResults

public array getResults(ZMResultList resultList)

Get results.

Parameters:
resultList - The paging handler.
Returns:
A list of results.
Todo:
Utilizing a ZMResultList is a bit overkill as we need only page number and pagination; * this could be handled either by two separate parameters or a sub-interface implemented by ZMResultList

getTotalNumberOfResults

public int getTotalNumberOfResults()

Get total number of results.

Returns:
The total number of results available.

setOrderBy

public void setOrderBy(string orderBy)

Set order by clause(s).

Parameters:
orderBy - The order by condition(s).

ZenMagick 0.9.6

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr