PagingResultBean (DBFlute Runtime 1.1.0-sp5-RC1 API)

java.lang.Object
- org.dbflute.cbean.result.ListResultBean<ENTITY>
- - org.dbflute.cbean.result.PagingResultBean<ENTITY>

型パラメータ:

ENTITY - The type of entity for the element of selected list.

すべての実装されたインタフェース:

Serializable, Iterable<ENTITY>, Collection<ENTITY>, List<ENTITY>
```
public class PagingResultBean<ENTITY>
extends ListResultBean<ENTITY>
```
The result bean of paging.

作成者:

jflute

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected int`	`_currentPageNumber` The value of current page number.
`protected int`	`_pageSize` The value of page size that means record count in one page.

クラスから継承されたフィールド org.dbflute.cbean.result.ListResultBean
_allRecordCount, _orderByClause, _selectedList, _tableDbName

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PagingResultBean()

コンストラクタ
コンストラクタと説明
`PagingResultBean()`

メソッドのサマリー

All Methods Instance Methods Concrete Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`protected void`	`assertPageGroupOptionCall(PageNumberLinkOptionCall<PageGroupOption> opLambda)`
`protected void`	`assertPageRangeOptionCall(PageNumberLinkOptionCall<PageRangeOption> opLambda)`
`protected int`	`calculateAllPageCount(int allRecordCount, int pageSize)` Calculate all page count.
`protected int`	`calculateCurrentEndRecordNumber(int currentPageNumber, int pageSize)`
`protected int`	`calculateCurrentStartRecordNumber(int currentPageNumber, int pageSize)`
`protected PageGroupBean`	`createPageGroupBean(PageGroupOption op)`
`protected PageGroupOption`	`createPageGroupOption(PageNumberLinkOptionCall<PageGroupOption> opLambda)`
`protected PageRangeBean`	`createPageRangeBean(PageRangeOption op)`
`protected PageRangeOption`	`createPageRangeOption(PageNumberLinkOptionCall<PageRangeOption> opLambda)`
`boolean`	`equals(Object other)`
`boolean`	`existsNextPage()` Does the next page exist?
`boolean`	`existsPreviousPage()` Does the previous page exist?
`int`	`getAllPageCount()` Get the value of allPageCount that is calculated.
`int`	`getAllRecordCount()` Get the value of allRecordCount when no paging.
`int`	`getCurrentEndRecordNumber()` Get the value of currentEndRecordNumber that is calculated.
`int`	`getCurrentPageNumber()` Get the value of currentPageNumber.
`int`	`getCurrentStartRecordNumber()` Get the value of currentStartRecordNumber that is calculated.
`int`	`getNextPageNumber()` Get the value of nextPageNumber that is calculated.
`int`	`getPageSize()` Get the value of pageSize that means record size in a page.
`int`	`getPrePageNumber()` 非推奨です。 use getPreviousPageNumber()
`int`	`getPreviousPageNumber()` Get the value of previousPageNumber that is calculated.
`int`	`hashCode()`
`boolean`	`isExistNextPage()` 非推奨です。 use existsNextPage()
`boolean`	`isExistPrePage()` 非推奨です。 use existsPreviousPage()
`<DTO> PagingResultBean<DTO>`	`mappingList(EntityDtoMapper<ENTITY,DTO> entityDtoMapper)` Map the entity list to the list of other object.
`protected PageGroupBean`	`newPageGroupBean()`
`protected PageGroupOption`	`newPageGroupOption()`
`protected PageRangeBean`	`newPageRangeBean()`
`protected PageRangeOption`	`newPageRangeOption()`
`PageGroupBean`	`pageGroup(PageNumberLinkOptionCall<PageGroupOption> opLambda)` Get the value of pageGroupBean.
`PageRangeBean`	`pageRange(PageNumberLinkOptionCall<PageRangeOption> opLambda)` Get the value of pageRangeBean.
`void`	`setAllRecordCount(int allRecordCount)` Set the value of allRecordCount when no paging with initializing cached beans.
`void`	`setCurrentPageNumber(int currentPageNumber)` Set the value of currentPageNumber with initializing cached beans.
`void`	`setPageSize(int pageSize)` Set the value of pageSize with initializing cached beans.
`String`	`toString()`

クラスから継承されたメソッド org.dbflute.cbean.result.ListResultBean
add, add, addAll, addAll, clear, contains, containsAll, createEmptyIterator, createInheritedResultBean, extractColumnList, extractColumnSet, get, getOrderByClause, getSelectedList, getTableDbName, groupingList, groupingMap, hasWrappedListInstance, indexOf, isEmpty, isSelectedResult, iterator, lastIndexOf, listIterator, listIterator, newResultBeanBuilder, remove, remove, removeAll, retainAll, set, setOrderByClause, setSelectedList, setTableDbName, size, subList, toArray, toArray

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.util.List
replaceAll, sort, spliterator

インタフェースから継承されたメソッド java.util.Collection
parallelStream, removeIf, stream

インタフェースから継承されたメソッド java.lang.Iterable
forEach

- フィールドの詳細
  - _pageSize
```
protected int _pageSize
```
    The value of page size that means record count in one page.
  - _currentPageNumber
```
protected int _currentPageNumber
```
    The value of current page number.
- コンストラクタの詳細
  - PagingResultBean
```
public PagingResultBean()
```
- メソッドの詳細
  - existsPreviousPage
```
public boolean existsPreviousPage()
```
    Does the previous page exist?
    Using values are currentPageNumber.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The determination, true or false.
  - existsNextPage
```
public boolean existsNextPage()
```
    Does the next page exist?
    Using values are currentPageNumber and allPageCount.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The determination, true or false.
  - isExistPrePage
```
public boolean isExistPrePage()
```
    非推奨です。 use existsPreviousPage()
    Is existing previous page? Using values are currentPageNumber.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The determination, true or false.
  - isExistNextPage
```
public boolean isExistNextPage()
```
    非推奨です。 use existsNextPage()
    Is existing next page? Using values are currentPageNumber and allPageCount.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The determination, true or false.
  - pageGroup
```
public PageGroupBean pageGroup(PageNumberLinkOptionCall<PageGroupOption> opLambda)
```
    Get the value of pageGroupBean.
```
 e.g. group-size=10, current-page=8
 PageGroupBean pageGroup = page.pageGroup(op -> op.groupSize(3));
 List<Integer> numberList = pageGroup.createPageNumberList();

 //  8 / 23 pages (453 records)
 // previous 1 2 3 4 5 6 7 8 9 10 next
 
```
    パラメータ:
    
    opLambda - The callback for setting of page-group option. (NotNull)
    
    戻り値:
    
    The bean of page group. (NotNull)
  - assertPageGroupOptionCall
```
protected void assertPageGroupOptionCall(PageNumberLinkOptionCall<PageGroupOption> opLambda)
```
  - createPageGroupOption
```
protected PageGroupOption createPageGroupOption(PageNumberLinkOptionCall<PageGroupOption> opLambda)
```
  - newPageGroupOption
```
protected PageGroupOption newPageGroupOption()
```
  - createPageGroupBean
```
protected PageGroupBean createPageGroupBean(PageGroupOption op)
```
  - newPageGroupBean
```
protected PageGroupBean newPageGroupBean()
```
  - pageRange
```
public PageRangeBean pageRange(PageNumberLinkOptionCall<PageRangeOption> opLambda)
```
    Get the value of pageRangeBean.
```
 e.g. group-size=10, current-page=8
 PageRangeBean pageRange = page.pageRange(op -> op.rangeSize(3));
 List<Integer> numberList = pageRange.createPageNumberList();

 //  8 / 23 pages (453 records)
 // previous 1 2 3 4 5 6 7 8 9 10 next
 
```
    パラメータ:
    
    opLambda - The callback for setting of page-range option. (NotNull)
    
    戻り値:
    
    The bean of page range. (NotNull)
  - assertPageRangeOptionCall
```
protected void assertPageRangeOptionCall(PageNumberLinkOptionCall<PageRangeOption> opLambda)
```
  - createPageRangeOption
```
protected PageRangeOption createPageRangeOption(PageNumberLinkOptionCall<PageRangeOption> opLambda)
```
  - newPageRangeOption
```
protected PageRangeOption newPageRangeOption()
```
  - createPageRangeBean
```
protected PageRangeBean createPageRangeBean(PageRangeOption op)
```
  - newPageRangeBean
```
protected PageRangeBean newPageRangeBean()
```
  - calculateAllPageCount
```
protected int calculateAllPageCount(int allRecordCount,
                                    int pageSize)
```
    Calculate all page count.
    
    パラメータ:
    
    allRecordCount - The record count of all records (without paging).
    
    pageSize - The record count of one page.
    
    戻り値:
    
    The count of all pages.
  - calculateCurrentStartRecordNumber
```
protected int calculateCurrentStartRecordNumber(int currentPageNumber,
                                                int pageSize)
```
  - calculateCurrentEndRecordNumber
```
protected int calculateCurrentEndRecordNumber(int currentPageNumber,
                                              int pageSize)
```
  - mappingList
```
public <DTO> PagingResultBean<DTO> mappingList(EntityDtoMapper<ENTITY,DTO> entityDtoMapper)
```
    クラスからコピーされた説明: ListResultBean
    Map the entity list to the list of other object.
```
 ListResultBean<MemberWebBean> beanList = memberList.mappingList(member -> {
     MemberWebBean bean = new MemberWebBean();
     bean.setMemberId(member.getMemberId());
     bean.setMemberName(member.getMemberName());
     ...
     return bean;
 });
 
```
    This method needs the property 'selectedList' only.
    オーバーライド:
    
    mappingList クラス内 ListResultBean<ENTITY>
    
    型パラメータ:
    
    DTO - The type of DTO.
    
    パラメータ:
    
    entityDtoMapper - The callback for mapping of entity and DTO. (NotNull)
    
    戻り値:
    
    The new mapped list as result bean. (NotNull)
  - hashCode
```
public int hashCode()
```
    定義:
    
    hashCode インタフェース内 Collection<ENTITY>
    
    定義:
    
    hashCode インタフェース内 List<ENTITY>
    
    オーバーライド:
    
    hashCode クラス内 ListResultBean<ENTITY>
    
    戻り値:
    
    Hash-code from primary-keys.
  - equals
```
public boolean equals(Object other)
```
    定義:
    
    equals インタフェース内 Collection<ENTITY>
    
    定義:
    
    equals インタフェース内 List<ENTITY>
    
    オーバーライド:
    
    equals クラス内 ListResultBean<ENTITY>
    
    パラメータ:
    
    other - Other entity. (NullAllowed)
    
    戻り値:
    
    Comparing result. If other is null, returns false.
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 ListResultBean<ENTITY>
    
    戻り値:
    
    The view string of all attribute values. (NotNull)
  - getAllRecordCount
```
public int getAllRecordCount()
```
    Get the value of allRecordCount when no paging.
    This is not same as size() basically.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    オーバーライド:
    
    getAllRecordCount クラス内 ListResultBean<ENTITY>
    
    戻り値:
    
    The count of all records without paging.
  - setAllRecordCount
```
public void setAllRecordCount(int allRecordCount)
```
    Set the value of allRecordCount when no paging with initializing cached beans.
    
    オーバーライド:
    
    setAllRecordCount クラス内 ListResultBean<ENTITY>
    
    パラメータ:
    
    allRecordCount - The count of all records without paging.
  - getPageSize
```
public int getPageSize()
```
    Get the value of pageSize that means record size in a page.
    
    戻り値:
    
    The size of one page.
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Set the value of pageSize with initializing cached beans.
    
    パラメータ:
    
    pageSize - The size of one page.
  - getCurrentPageNumber
```
public int getCurrentPageNumber()
```
    Get the value of currentPageNumber.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The number of current page.
  - setCurrentPageNumber
```
public void setCurrentPageNumber(int currentPageNumber)
```
    Set the value of currentPageNumber with initializing cached beans.
    
    パラメータ:
    
    currentPageNumber - The number of current page.
  - getAllPageCount
```
public int getAllPageCount()
```
    Get the value of allPageCount that is calculated.
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The count of all pages.
  - getPreviousPageNumber
```
public int getPreviousPageNumber()
```
    Get the value of previousPageNumber that is calculated.
    You should use this.existsPreviousPage() before calling this. (call only when true)
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The number of previous page.
  - getNextPageNumber
```
public int getNextPageNumber()
```
    Get the value of nextPageNumber that is calculated.
    You should use this.isExistNextPage() before calling this. (call only when true)
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The number of next page.
  - getPrePageNumber
```
public int getPrePageNumber()
```
    非推奨です。 use getPreviousPageNumber()
    Get the value of prePageNumber that is calculated.
    You should use this.isExistPrePage() before calling this. (call only when true)
```
 e.g. range-size=5, current-page=8 
  8 / 23 pages (453 records)
 previous 3 4 5 6 7 8 9 10 11 12 13 next
 
```
    戻り値:
    
    The value of prePageNumber.
  - getCurrentStartRecordNumber
```
public int getCurrentStartRecordNumber()
```
    Get the value of currentStartRecordNumber that is calculated.
    
    戻り値:
    
    The value of currentStartRecordNumber.
  - getCurrentEndRecordNumber
```
public int getCurrentEndRecordNumber()
```
    Get the value of currentEndRecordNumber that is calculated.
    
    戻り値:
    
    The value of currentEndRecordNumber.

クラス PagingResultBean<ENTITY>

フィールドのサマリー

クラスから継承されたフィールド org.dbflute.cbean.result.ListResultBean

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.dbflute.cbean.result.ListResultBean

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド java.util.List

インタフェースから継承されたメソッド java.util.Collection

インタフェースから継承されたメソッド java.lang.Iterable

フィールドの詳細

_pageSize

_currentPageNumber

コンストラクタの詳細

PagingResultBean

メソッドの詳細

existsPreviousPage

existsNextPage

isExistPrePage

isExistNextPage

pageGroup

assertPageGroupOptionCall

createPageGroupOption

newPageGroupOption

createPageGroupBean

newPageGroupBean

pageRange

assertPageRangeOptionCall

createPageRangeOption

newPageRangeOption

createPageRangeBean

newPageRangeBean

calculateAllPageCount

calculateCurrentStartRecordNumber

calculateCurrentEndRecordNumber

mappingList

hashCode

equals

toString

getAllRecordCount

setAllRecordCount

getPageSize

setPageSize

getCurrentPageNumber

setCurrentPageNumber

getAllPageCount

getPreviousPageNumber

getNextPageNumber

getPrePageNumber

getCurrentStartRecordNumber

getCurrentEndRecordNumber