PageInfoSessionMakerByIds (hynnet-util API Documentation

java.lang.Object
- com.hynnet.util.PageInfoSessionMaker
- - com.hynnet.util.PageInfoSessionMakerByIds

public abstract class PageInfoSessionMakerByIds
extends PageInfoSessionMaker

自动处理从Session获取分页对象PageInf及缓存分页对象到Session并且通过数据ID生成分页对象的处理类。
使用时只需要实现子类，子类中实现获取数据ID列表的方法即可。

 使用范例：
     // 继承分页处理类
     protected class MyPageInfo extends PageInfoSessionMakerByIDs
     {
         // 获取数据程序使用，不需要可以删除
         private String m_strCondition1;
         // 获取数据程序使用，不需要可以删除
         private String[] m_arrayConString2;
 
         public MyPageInfo(HttpSession objSession,
                 String strSessionName,
                 int nPageSize,
                 int nCurrentPage,
                 MyHelper objHelper,
                 String strCondition1,
                 String[] arrayCondition2)
         {
             super(objSession,
                   strSessionName,
                   nPageSize,
                   nCurrentPage,
                   new PageInfoCondition().add("key1", m_strCondition1).add("key2",
                                                           m_arrayConString2)
                   objHelper,
                   "get",
                   MyData.class);
             m_strCondition1 = strCondition1;
             m_arrayConString2 = arrayCondition2;
         }
 
         // 实现的函数，执行查询数据代码
         protected StringList getDataIds(Object objMgr)
         {
             MyHelper m_objHelper = (MyHelper)objMgr; // 获取数据的管理类。
             String strSQL = "SELECT .... WHERE COL1=" + getPageInfoCondition().getOneCondition("key1");
 
             return objHelper.getQueryDataIds(strSQL);
         }
     }
 
     public String myCommand()
     {
         final String SESSION_NAME_DATA_PAGEINFO = "pageInfoSession";
         MyPageInfo objMyPageInfo;
         PageInfo objPageInfo;
         
         objMyPageInfo = new MyPageInfo(session, SESSION_NAME_DATA_PAGEINFO,
                 20, ParamUtils.getIntParameter(request, "page", 1),
                 new MyHelper(),
                 ParamUtils.getParameter(request, "par1", true),
                 ParamUtils.getParameters(request, "par2", true));
         objPageInfo = objMyPageInfo.getPageInfo();
     
         request.setAttribute("pageInfo", );
     }

作者:: hyn
另请参阅:: PageInfoSessionMakerByMgr, PageInfoSessionMaker, PageInfoSessionMakerByIds, PageInfoSessionMakerByAllData

构造器概要

构造器
构造器和说明
`PageInfoSessionMakerByIds(javax.servlet.http.HttpSession session, java.lang.String sessionName, int pageSize, int currentPage, PageInfoCondition condition, java.lang.Object managerClass, java.lang.String getterFunctionName, java.lang.Class dataCls)` 构造函数。

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addCondition(PageInfoCondition objCondition)` 添加当前分页对象的查询条件标识。
`protected PageInfo`	`createPageInfo(PageInfoCondition objCondition)` 创建新的分页对象。
`protected abstract StringList`	`getDataIds(java.lang.Object objMgr)` 获取初始化数据的ID列表。
`protected int`	`getDataIndexFrom()` 获取初始化数据的开始位置。
`protected int`	`getDataIndexTo()` 获取初始化数据的结束位置。
`protected long`	`getDataTotal()` 获取数据总数。
`java.lang.Object`	`getManagerClass()` 获取数据管理对象。

从类继承的方法 com.hynnet.util.PageInfoSessionMaker
getCurrentPage, getPageInfo, getPageInfoCondition, getPageSize

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

- 构造器详细资料
  - PageInfoSessionMakerByIds
```
public PageInfoSessionMakerByIds(javax.servlet.http.HttpSession session,
                         java.lang.String sessionName,
                         int pageSize,
                         int currentPage,
                         PageInfoCondition condition,
                         java.lang.Object managerClass,
                         java.lang.String getterFunctionName,
                         java.lang.Class dataCls)
```
    构造函数。
    
    参数:
    session - 请求的Session对象。
    sessionName - 缓存分页对象的Session属性名称。
    pageSize - 每页最大记录数。
    currentPage - 显示的当前页号。
    condition - 查询条件标识。
    managerClass - 获取每个数据项的类对象。
    getterFunctionName - 获取每个数据项的方法名称。
    dataCls - 每个数据的类。
- 方法详细资料
  - getDataIds
```
protected abstract StringList getDataIds(java.lang.Object objMgr)
                                  throws java.lang.Exception
```
    获取初始化数据的ID列表。
    当只返回结果中的部分数据时，需要覆盖getDataTotal()，getDataIndexFrom()，getDataIndexTo()方法。
    
    返回:
    
    抛出:
    
    java.lang.Exception
    另请参阅:
    getDataTotal(), getDataIndexFrom(), getDataIndexTo()
  - getDataTotal
```
protected long getDataTotal()
```
    获取数据总数。 getDataIds()返回所有有效数据的ID列表时，可以返回-1。
    
    返回:
    另请参阅:
    #getDataIds(), getDataIndexFrom(), getDataIndexTo()
  - getDataIndexFrom
```
protected int getDataIndexFrom()
```
    获取初始化数据的开始位置。从0开始计算。 getDataIds()返回所有有效数据的ID列表时，可以返回-1。
    
    返回:
    另请参阅:
    #getDataIds(), getDataTotal(), getDataIndexTo()
  - getDataIndexTo
```
protected int getDataIndexTo()
```
    获取初始化数据的结束位置。从0开始计算。 getDataIds()返回所有有效数据的ID列表时，可以返回-1。
    
    返回:
    另请参阅:
    #getDataIds(), getDataTotal(), getDataIndexFrom()
  - getManagerClass
```
public java.lang.Object getManagerClass()
```
    获取数据管理对象。
    
    返回:
  - addCondition
```
protected void addCondition(PageInfoCondition objCondition)
```
    添加当前分页对象的查询条件标识。
```
 实现样例：
 protected void addCondition(PageInfoCondition objCondition)
 {
     objCondition.add("key1", m_strVal1).add("key2", m_arrayVal2);
 }
 
 
```
    指定者:
    
    addCondition 在类中 PageInfoSessionMaker
    
    参数:
    objCondition - 需要向里面添加条件的查询条件标识对象。
  - createPageInfo
```
protected final PageInfo createPageInfo(PageInfoCondition objCondition)
                                 throws java.lang.Exception
```
    创建新的分页对象。注意创建对象时要设置好当前的每页记录数和当前页号。
    
    指定者:
    
    createPageInfo 在类中 PageInfoSessionMaker
    
    参数:
    objCondition - 已包含条件的查询条件标识对象。
    
    返回:
    
    抛出:
    
    java.lang.Exception

类 PageInfoSessionMakerByIds

构造器概要

方法概要

从类继承的方法 com.hynnet.util.PageInfoSessionMaker

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

构造器详细资料

PageInfoSessionMakerByIds

方法详细资料

getDataIds

getDataTotal

getDataIndexFrom

getDataIndexTo

getManagerClass

addCondition

createPageInfo