PageQuery (sql-core 3.12.2-RELEASE API)

java.lang.Object
- org.beetl.sql.core.engine.PageQuery<T>

所有已实现的接口:

Serializable, PageRequest, PageResult

已过时。
3.0中不推荐使用，因为此类职责不清，请使用PageRequest和PageResult代替
```
@Deprecated
public class PageQuery<T>
extends Object
implements PageRequest, PageResult
```
兼容BeetlSQL2的翻页，实现了PageRequest，和 PageResult 用于翻页，要求sqlid必须具有page使用了page函数和pageTag,或者sqlId还有一个以$count 结尾的sqlId 此类混合了查询翻页请求参数和查询结果
请求参数包括:
- orderBy：动态传入的排序，sql形式
- paras：查询参数，可以是map，或者Obj
- pageNumber：第几页，从1开始
查询结果包括
- list：查询结果
- totalRow：符合条件的总数
- firstPage：是否是首页
- lastPage：是否是尾页
- totalPage：符合条件的总页数
- totalPage：符合条件的总页数
可以通过控制pageSize来确定每页记录条数
也可以实现设置totalRow为一个不是-1的数字来禁止beetlsql每次重新查询总数以提高性能
作者:

suxj, xiandafu

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class PageQuery.ParasBuilder
已过时。

嵌套类
限定符和类型	类和说明
`static class`	`PageQuery.ParasBuilder` 已过时。

字段概要

字段
限定符和类型	字段和说明
`static long`	`DEFAULT_PAGE_SIZE` 已过时。默认的每页纪录总数，
`protected List<T>`	`list` 已过时。
`protected String`	`orderBy` 已过时。
`protected long`	`pageNumber` 已过时。
`protected long`	`pageSize` 已过时。
`protected Object`	`paras` 已过时。
`protected long`	`totalPage` 已过时。
`protected long`	`totalRow` 已过时。

构造器概要

构造器
构造器和说明
`PageQuery()` 已过时。
`PageQuery(long pageNumber)` 已过时。
`PageQuery(long pageNumber, long pageSize)` 已过时。
`PageQuery(long pageNumber, long pageSize, Object paras)` 已过时。
`PageQuery(long pageNumber, Object paras)` 已过时。
`PageQuery(long pageNumber, Object paras, long totalRow)` 已过时。
`PageQuery(long pageNumber, Object paras, long totalRow, long pageSize)` 已过时。
`PageQuery(long pageNumber, Object paras, String userDefinedOrderBy)` 已过时。 * @param pageNumber 页数
`PageQuery(long pageNumber, Object paras, String userDefinedOrderBy, long totalRow)` 已过时。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`equals(Object obj)` 已过时。
`List<T>`	`getList()` 已过时。
`String`	`getOrderBy()` 已过时。分页排序
`long`	`getPageNumber()` 已过时。当前页数，从1开始
`int`	`getPageSize()` 已过时。每页记录个数
`Object`	`getParas()` 已过时。
`long`	`getTotalPage()` 已过时。
`long`	`getTotalRow()` 已过时。
`int`	`hashCode()` 已过时。
`boolean`	`isFirstPage()` 已过时。
`boolean`	`isLastPage()` 已过时。
`boolean`	`isListRequired()` 已过时。不进行列表查询对于比较慢的分页查询场景，有时我们会将列表和总数统计分为两个请求分别获取，这样可以分别请求列表或总数
`boolean`	`isTotalRequired()` 已过时。有时候，分页请求不需要再次查询总数，这样可以节省一次sql查询，
`PageResult`	`of(List result)` 已过时。返回一个分页结果，用户可以实现自己的分页请求和分页结果
`PageResult`	`of(List result, Long total)` 已过时。
`void`	`setList(List list)` 已过时。
`void`	`setOrderBy(String orderBy)` 已过时。如 name desc,create_date asc , 是数据库sql语句一部分
`void`	`setPageNumber(long pageNumber)` 已过时。
`void`	`setPageSize(long pageSize)` 已过时。
`void`	`setPara(String key, Object value)` 已过时。添加额外参数，主参数变为有"_root"的Map
`void`	`setParas(Object paras)` 已过时。添加主参数，可以是map，pojo
`void`	`setTotalRow(long totalRow)` 已过时。

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.beetl.sql.core.page.PageRequest
getStart

从接口继承的方法 org.beetl.sql.core.page.PageResult
convert

- 字段详细资料
  - DEFAULT_PAGE_SIZE
```
public static long DEFAULT_PAGE_SIZE
```
    已过时。
    
    默认的每页纪录总数，
  - list
```
protected List<T> list
```
    已过时。
  - paras
```
protected Object paras
```
    已过时。
  - orderBy
```
protected String orderBy
```
    已过时。
  - pageNumber
```
protected long pageNumber
```
    已过时。
  - pageSize
```
protected long pageSize
```
    已过时。
  - totalPage
```
protected long totalPage
```
    已过时。
  - totalRow
```
protected long totalRow
```
    已过时。
- 构造器详细资料
  - PageQuery
```
public PageQuery()
```
    已过时。
  - PageQuery
```
public PageQuery(long pageNumber)
```
    已过时。
  - PageQuery
```
public PageQuery(long pageNumber,
                 long pageSize)
```
    已过时。
  - PageQuery
```
public PageQuery(long pageNumber,
                 long pageSize,
                 Object paras)
```
    已过时。
  - PageQuery
```
public PageQuery(long pageNumber,
                 Object paras)
```
    已过时。
    
    参数:
    
    pageNumber - 页数
    
    paras - 参数，pojo或者map
  - PageQuery
```
public PageQuery(long pageNumber,
                 Object paras,
                 String userDefinedOrderBy)
```
    已过时。
    
    * @param pageNumber 页数
    
    参数:
    
    paras - 参数，pojo或者map
    
    userDefinedOrderBy - 翻页字符串，如 create_date desc; 将自动增加到翻页语句里，这要求sqlId没有order by
  - PageQuery
```
public PageQuery(long pageNumber,
                 Object paras,
                 long totalRow)
```
    已过时。
    
    参数:
    
    pageNumber - 页数，从1开始
    
    paras - 参数
    
    totalRow - 总行数，如果不为－1，则不需要beetlsq查询总行数
  - PageQuery
```
public PageQuery(long pageNumber,
                 Object paras,
                 String userDefinedOrderBy,
                 long totalRow)
```
    已过时。
  - PageQuery
```
public PageQuery(long pageNumber,
                 Object paras,
                 long totalRow,
                 long pageSize)
```
    已过时。
    
    参数:
    
    pageNumber - 页数
    
    paras - 参数
    
    totalRow - 总行数，如果不为－1，则不需要beetlsq查询总行数
    
    pageSize - 每页行数
- 方法详细资料
  - getList
```
public List<T> getList()
```
    已过时。
    
    指定者:
    
    getList 在接口中 PageResult
  - setList
```
public void setList(List list)
```
    已过时。
    
    指定者:
    
    setList 在接口中 PageResult
  - getPageNumber
```
public long getPageNumber()
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    当前页数，从1开始
    
    指定者:
    
    getPageNumber 在接口中 PageRequest
    
    返回:
  - setPageNumber
```
public void setPageNumber(long pageNumber)
```
    已过时。
  - getPageSize
```
public int getPageSize()
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    每页记录个数
    
    指定者:
    
    getPageSize 在接口中 PageRequest
    
    返回:
  - setPageSize
```
public void setPageSize(long pageSize)
```
    已过时。
  - getTotalPage
```
public long getTotalPage()
```
    已过时。
    
    指定者:
    
    getTotalPage 在接口中 PageResult
  - getTotalRow
```
public long getTotalRow()
```
    已过时。
    
    指定者:
    
    getTotalRow 在接口中 PageResult
  - setTotalRow
```
public void setTotalRow(long totalRow)
```
    已过时。
  - isFirstPage
```
public boolean isFirstPage()
```
    已过时。
  - isLastPage
```
public boolean isLastPage()
```
    已过时。
  - getParas
```
public Object getParas()
```
    已过时。
    
    指定者:
    
    getParas 在接口中 PageRequest
  - setParas
```
public void setParas(Object paras)
```
    已过时。
    
    添加主参数，可以是map，pojo
    
    参数:
    
    paras -
  - setPara
```
public void setPara(String key,
                    Object value)
```
    已过时。
    
    添加额外参数，主参数变为有"_root"的Map
    
    参数:
    
    key -
    
    value -
  - getOrderBy
```
public String getOrderBy()
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    分页排序
    
    指定者:
    
    getOrderBy 在接口中 PageRequest
    
    返回:
  - isTotalRequired
```
public boolean isTotalRequired()
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    有时候，分页请求不需要再次查询总数，这样可以节省一次sql查询，
    
    指定者:
    
    isTotalRequired 在接口中 PageRequest
    
    返回:
  - isListRequired
```
public boolean isListRequired()
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    不进行列表查询
    对于比较慢的分页查询场景，有时我们会将列表和总数统计分为两个请求分别获取，这样可以分别请求列表或总数
    
    指定者:
    
    isListRequired 在接口中 PageRequest
    
    返回:
  - of
```
public PageResult of(List result)
```
    已过时。
    
    从接口复制的说明: PageRequest
    
    返回一个分页结果，用户可以实现自己的分页请求和分页结果
    
    指定者:
    
    of 在接口中 PageRequest
    
    返回:
    
    另请参阅:
    
    DefaultPageResult
  - of
```
public PageResult of(List result,
                     Long total)
```
    已过时。
    
    指定者:
    
    of 在接口中 PageRequest
  - setOrderBy
```
public void setOrderBy(String orderBy)
```
    已过时。
    
    如 name desc,create_date asc , 是数据库sql语句一部分
    
    参数:
    
    orderBy -
  - hashCode
```
public int hashCode()
```
    已过时。
    
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    已过时。
    
    覆盖:
    
    equals 在类中 Object

类 PageQuery<T>

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.beetl.sql.core.page.PageRequest

从接口继承的方法 org.beetl.sql.core.page.PageResult

字段详细资料

DEFAULT_PAGE_SIZE

list

paras

orderBy

pageNumber

pageSize

totalPage

totalRow

构造器详细资料

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

方法详细资料

getList

setList

getPageNumber

setPageNumber

getPageSize

setPageSize

getTotalPage

getTotalRow

setTotalRow

isFirstPage

isLastPage

getParas

setParas

setPara

getOrderBy

isTotalRequired

isListRequired

of

of

setOrderBy

hashCode

equals