PageQuery (com.ibeetl:beetlsql 2.10.18 API)

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

所有已实现的接口:

Serializable
```
public class PageQuery<T>
extends Object
implements Serializable
```
用于翻页，要求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 long`	`DEFAULT_PAGE_SIZE` 默认的每页纪录总数，
`protected List<T>`	`list`
`protected String`	`orderBy`
`static String`	`pageFlag`
`protected long`	`pageNumber`
`static Object`	`pageObj`
`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)`
`PageQuery(long pageNumber, Object paras, String userDefinedOrderBy, long totalRow)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(Object obj)`
`List<T>`	`getList()`
`String`	`getOrderBy()`
`long`	`getPageNumber()`
`long`	`getPageSize()`
`Object`	`getParas()`
`long`	`getTotalPage()`
`long`	`getTotalRow()`
`int`	`hashCode()`
`boolean`	`isFirstPage()`
`boolean`	`isLastPage()`
`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

字段详细资料

pageFlag
```
public static String pageFlag
```

pageObj
```
public static Object pageObj
```

list
```
protected List<T> list
```

paras
```
protected Object paras
```

orderBy
```
protected String orderBy
```

pageNumber
```
protected long pageNumber
```

DEFAULT_PAGE_SIZE
```
public static long DEFAULT_PAGE_SIZE
```
默认的每页纪录总数，

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)
```
参数:

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 - 每页行数

方法详细资料

setPageSize

public void setPageSize(long pageSize)

getList
```
public List<T> getList()
```

getPageNumber
```
public long getPageNumber()
```

getPageSize
```
public long getPageSize()
```

getTotalPage
```
public long getTotalPage()
```

getTotalRow
```
public long getTotalRow()
```

isFirstPage
```
public boolean isFirstPage()
```

isLastPage
```
public boolean isLastPage()
```

getParas
```
public Object getParas()
```

setParas
```
public void setParas(Object paras)
```
添加主参数，可以是map，pojo

参数:

paras -

setPara

public void setPara(String key,
                    Object value)

添加额外参数，主参数变为有"_root"的Map

参数:: key -; value -

setPageNumber

public void setPageNumber(long pageNumber)

setTotalRow

public void setTotalRow(long totalRow)

setList
```
public void setList(List list)
```

getOrderBy
```
public String getOrderBy()
```

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

字段详细资料

pageFlag

pageObj

list

paras

orderBy

pageNumber

DEFAULT_PAGE_SIZE

pageSize

totalPage

totalRow

构造器详细资料

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

PageQuery

方法详细资料

setPageSize

getList

getPageNumber

getPageSize

getTotalPage

getTotalRow

isFirstPage

isLastPage

getParas

setParas

setPara

setPageNumber

setTotalRow

setList

getOrderBy

setOrderBy

hashCode

equals