SimplePagingBean (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.outsidesql.paging.SimplePagingBean

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

OrderByBean, FetchNarrowingBean, PagingBean, FetchBean, MapParameterBean<Object>, ParameterBean
```
public class SimplePagingBean
extends Object
implements PagingBean, MapParameterBean<Object>
```
The simple implementation of paging-bean.

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_fetchNarrowing` Is fetch narrowing valid?
`protected boolean`	`_paging` Is the execution for paging(NOT count)?
`protected boolean`	`_pagingCountLater` Is the count executed later?
`protected boolean`	`_pagingReSelect` Can the paging re-select?
`protected Map<String,Object>`	`_parameterMap` The map of parameter.
`protected int`	`_safetyMaxResultSize` The max size of safety result.
`protected SqlClause`	`_sqlClause` SQL clause instance.

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

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

SimplePagingBean()

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

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`addParameter(String key, Object value)` Add the parameter to the map.
`boolean`	`canPagingCountLater()` Can the paging execute count later?
`boolean`	`canPagingReSelect()` Can the paging re-select?
`void`	`checkSafetyResult(int safetyMaxResultSize)` Check whether the result size is safety or not.
`OrderByBean`	`clearOrderBy()` Clear order-by.
`<ENTITY> PagingInvoker<ENTITY>`	`createPagingInvoker(String tableDbName)` Create the invoker of paging.
`void`	`disablePagingCountLater()` Disable paging count-later that means counting after selecting.
`void`	`disablePagingReSelect()` Disable paging re-select that is executed when the page number is over page count.
`void`	`enablePagingCountLater()` Enable paging count-later that means counting after selecting.
`void`	`enablePagingReSelect()` Enable paging re-select that is executed when the page number is over page count.
`PagingBean`	`fetchFirst(int fetchSize)` Fetch first records only.
`int`	`getFetchNarrowingLoopCount()` Get fetch size.
`int`	`getFetchNarrowingSkipStartIndex()` Get fetch start index.
`int`	`getFetchPageNumber()` Get fetch page number.
`int`	`getFetchSize()` Get fetch size of paging, also called page size.
`int`	`getFetchStartIndex()` Get fetch start index.
`String`	`getOrderByClause()` Get order-by clause.
`OrderByClause`	`getOrderByComponent()` Get the component of order-by clause.
`int`	`getPageEndIndex()` Get page end index.
`int`	`getPageStartIndex()` Get page start index.
`Map<String,Object>`	`getParameterMap()` Get the map of parameter.
`int`	`getSafetyMaxResultSize()` Get the max size of safety result.
`SqlClause`	`getSqlClause()` Get SQL clause instance.
`protected void`	`initializeParameterMapIfNeeds()`
`boolean`	`isFetchNarrowingEffective()` Is fetch-narrowing effective?
`boolean`	`isFetchNarrowingLoopCountEffective()` Is fetch size supported?
`boolean`	`isFetchNarrowingSkipStartIndexEffective()` Is fetch start index supported?
`boolean`	`isFetchScopeEffective()` Is fetch scope effective?
`boolean`	`isPaging()` Is the execution for paging(NOT count)?
`protected String`	`ln()`
`void`	`paging(int pageSize, int pageNumber)` Set up paging resources.
`protected void`	`throwPagingPageSizeNotPlusException(int pageSize, int pageNumber)`
`void`	`xdisableFetchNarrowing()` Disable fetch narrowing.
`void`	`xenableIgnoredFetchNarrowing()` Enable ignored fetch narrowing.
`PagingBean`	`xfetchPage(int fetchPageNumber)` Fetch page.
`PagingBean`	`xfetchScope(int fetchStartIndex, int fetchSize)` Fetch records in the scope only.
`void`	`xsetPaging(boolean paging)` Set whether the execution for paging(NOT count).

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

- フィールドの詳細
  - _sqlClause
```
protected final SqlClause _sqlClause
```
    SQL clause instance.
  - _parameterMap
```
protected Map<String,Object> _parameterMap
```
    The map of parameter. (NullAllowed)
  - _safetyMaxResultSize
```
protected int _safetyMaxResultSize
```
    The max size of safety result.
  - _paging
```
protected boolean _paging
```
    Is the execution for paging(NOT count)?
  - _pagingCountLater
```
protected boolean _pagingCountLater
```
    Is the count executed later?
  - _pagingReSelect
```
protected boolean _pagingReSelect
```
    Can the paging re-select?
  - _fetchNarrowing
```
protected boolean _fetchNarrowing
```
    Is fetch narrowing valid?
- コンストラクタの詳細
  - SimplePagingBean
```
public SimplePagingBean()
```
- メソッドの詳細
  - isPaging
```
public boolean isPaging()
```
    Is the execution for paging(NOT count)? {for parameter comment}
    
    定義:
    
    isPaging インタフェース内 PagingBean
    
    戻り値:
    
    The determination, true or false.
  - canPagingCountLater
```
public boolean canPagingCountLater()
```
    Can the paging execute count later? {for framework}
    
    定義:
    
    canPagingCountLater インタフェース内 PagingBean
    
    戻り値:
    
    The determination, true or false.
  - canPagingReSelect
```
public boolean canPagingReSelect()
```
    Can the paging re-select? {for framework}
    
    定義:
    
    canPagingReSelect インタフェース内 PagingBean
    
    戻り値:
    
    The determination, true or false.
  - paging
```
public void paging(int pageSize,
                   int pageNumber)
```
    Set up paging resources.
```
 e.g. ConditionBean
 MemberCB cb = new MemberCB();
 cb.query().setMemberName_PrefixSearch("S");
 cb.query().addOrderBy_Birthdate_Desc();
 cb.paging(20, 3); // 20 records per a page and current page number is 3
 PagingResultBean<Member> page = memberBhv.selectPage(cb);
 
```
    定義:
    
    paging インタフェース内 PagingBean
    
    パラメータ:
    
    pageSize - The page size per one page. (NotMinus, NotZero)
    
    pageNumber - The number of page. It's ONE origin. (NotMinus, NotZero: If it's minus or zero, it treats as one.)
  - throwPagingPageSizeNotPlusException
```
protected void throwPagingPageSizeNotPlusException(int pageSize,
                                                   int pageNumber)
```
  - xsetPaging
```
public void xsetPaging(boolean paging)
```
    Set whether the execution for paging(NOT count). {INTERNAL METHOD}
    
    定義:
    
    xsetPaging インタフェース内 PagingBean
    
    パラメータ:
    
    paging - Determination.
  - enablePagingCountLater
```
public void enablePagingCountLater()
```
    Enable paging count-later that means counting after selecting. (back to default)
    You can use it by default on DBFlute so you don't need to call this basically. If you've suppressed it by settings of DBFlute property, you can use it by calling.
    You should call this before execution of selectPage().
    
    定義:
    
    enablePagingCountLater インタフェース内 PagingBean
  - disablePagingCountLater
```
public void disablePagingCountLater()
```
    Disable paging count-later that means counting after selecting. (default is enabled)
    You should call this before execution of selectPage().
    
    定義:
    
    disablePagingCountLater インタフェース内 PagingBean
  - enablePagingReSelect
```
public void enablePagingReSelect()
```
    Enable paging re-select that is executed when the page number is over page count. (back to default)
    You can use it by default on DBFlute so you don't need to call this basically. If you've suppressed it by settings of DBFlute property, you can use it by calling.
    You should call this before execution of selectPage().
    
    定義:
    
    enablePagingReSelect インタフェース内 PagingBean
  - disablePagingReSelect
```
public void disablePagingReSelect()
```
    Disable paging re-select that is executed when the page number is over page count. (default is enabled)
    You should call this before execution of selectPage().
    
    定義:
    
    disablePagingReSelect インタフェース内 PagingBean
  - fetchFirst
```
public PagingBean fetchFirst(int fetchSize)
```
    Fetch first records only. e.g. ConditionBean MemberCB cb = new MemberCB(); cb.query().setMemberName_PrefixSearch("S"); cb.query().addOrderBy_Birthdate_Desc(); cb.fetchFirst(5); // top 5 ListResultBean<Member> memberList = memberBhv.selectList(cb);
    
    定義:
    
    fetchFirst インタフェース内 PagingBean
    
    パラメータ:
    
    fetchSize - The size of fetch. (NotMinus, NotZero)
    
    戻り値:
    
    this. (NotNull)
  - xfetchScope
```
public PagingBean xfetchScope(int fetchStartIndex,
                              int fetchSize)
```
    Fetch records in the scope only. {Internal}
    This method is an old style, so you should use paging() instead of this.
    
    定義:
    
    xfetchScope インタフェース内 PagingBean
    
    パラメータ:
    
    fetchStartIndex - The start index of fetch. 0 origin. (NotMinus)
    
    fetchSize - The size of fetch. (NotMinus, NotZero)
    
    戻り値:
    
    this. (NotNull)
  - xfetchPage
```
public PagingBean xfetchPage(int fetchPageNumber)
```
    Fetch page. {Internal}
    This method is an old style, so you should use paging() instead of this.
    When you call this, it is normally necessary to invoke 'fetchFirst()' or 'fetchScope()' ahead of that.
    But you also can use default-fetch-size without invoking 'fetchFirst()' or 'fetchScope()'.
    If you invoke this, your SQL returns [fetch-size] records from [fetch-start-index] calculated by [fetch-page-number].
    
    定義:
    
    xfetchPage インタフェース内 PagingBean
    
    パラメータ:
    
    fetchPageNumber - The page number of fetch. 1 origin. (NotMinus, NotZero: If minus or zero, set one.)
    
    戻り値:
    
    this. (NotNull)
  - createPagingInvoker
```
public <ENTITY> PagingInvoker<ENTITY> createPagingInvoker(String tableDbName)
```
    Create the invoker of paging.
    
    定義:
    
    createPagingInvoker インタフェース内 PagingBean
    
    型パラメータ:
    
    ENTITY - The type of entity.
    
    パラメータ:
    
    tableDbName - The DB name of table. (NotNull)
    
    戻り値:
    
    The instance of PagingInvoker for the table. (NotNull)
  - getFetchStartIndex
```
public int getFetchStartIndex()
```
    Get fetch start index.
    
    定義:
    
    getFetchStartIndex インタフェース内 PagingBean
    
    戻り値:
    
    The index of fetch-start.
  - getFetchSize
```
public int getFetchSize()
```
    Get fetch size of paging, also called page size.
    
    定義:
    
    getFetchSize インタフェース内 PagingBean
    
    戻り値:
    
    The size of fetching rows.
  - getFetchPageNumber
```
public int getFetchPageNumber()
```
    Get fetch page number.
    
    定義:
    
    getFetchPageNumber インタフェース内 PagingBean
    
    戻り値:
    
    The page number of fetch.
  - getPageStartIndex
```
public int getPageStartIndex()
```
    Get page start index.
    
    定義:
    
    getPageStartIndex インタフェース内 PagingBean
    
    戻り値:
    
    The index of page start, 0 origin. (NotMinus)
  - getPageEndIndex
```
public int getPageEndIndex()
```
    Get page end index.
    
    定義:
    
    getPageEndIndex インタフェース内 PagingBean
    
    戻り値:
    
    The index of page end, 0 origin. (NotMinus)
  - isFetchScopeEffective
```
public boolean isFetchScopeEffective()
```
    Is fetch scope effective?
    
    定義:
    
    isFetchScopeEffective インタフェース内 PagingBean
    
    戻り値:
    
    The determination, true or false.
  - getSafetyMaxResultSize
```
public int getSafetyMaxResultSize()
```
    Get the max size of safety result.
    
    定義:
    
    getSafetyMaxResultSize インタフェース内 FetchBean
    
    戻り値:
    
    The max size of safety result. (zero means no check)
  - getFetchNarrowingSkipStartIndex
```
public int getFetchNarrowingSkipStartIndex()
```
    Get fetch start index.
    
    定義:
    
    getFetchNarrowingSkipStartIndex インタフェース内 FetchNarrowingBean
    
    戻り値:
    
    Fetch start index.
  - getFetchNarrowingLoopCount
```
public int getFetchNarrowingLoopCount()
```
    Get fetch size.
    
    定義:
    
    getFetchNarrowingLoopCount インタフェース内 FetchNarrowingBean
    
    戻り値:
    
    Fetch size.
  - isFetchNarrowingSkipStartIndexEffective
```
public boolean isFetchNarrowingSkipStartIndexEffective()
```
    Is fetch start index supported?
    
    定義:
    
    isFetchNarrowingSkipStartIndexEffective インタフェース内 FetchNarrowingBean
    
    戻り値:
    
    The determination, true or false.
  - isFetchNarrowingLoopCountEffective
```
public boolean isFetchNarrowingLoopCountEffective()
```
    Is fetch size supported?
    
    定義:
    
    isFetchNarrowingLoopCountEffective インタフェース内 FetchNarrowingBean
    
    戻り値:
    
    The determination, true or false.
  - isFetchNarrowingEffective
```
public boolean isFetchNarrowingEffective()
```
    Is fetch-narrowing effective?
    
    定義:
    
    isFetchNarrowingEffective インタフェース内 FetchNarrowingBean
    
    戻り値:
    
    The determination, true or false.
  - xdisableFetchNarrowing
```
public void xdisableFetchNarrowing()
```
    Disable fetch narrowing. Only checking safety result size is valid. {INTERNAL METHOD}
    
    定義:
    
    xdisableFetchNarrowing インタフェース内 FetchNarrowingBean
  - xenableIgnoredFetchNarrowing
```
public void xenableIgnoredFetchNarrowing()
```
    Enable ignored fetch narrowing. {INTERNAL METHOD}
    
    定義:
    
    xenableIgnoredFetchNarrowing インタフェース内 FetchNarrowingBean
  - getOrderByClause
```
public String getOrderByClause()
```
    Get order-by clause.
    
    定義:
    
    getOrderByClause インタフェース内 OrderByBean
    
    戻り値:
    
    Order-by clause. (NotNull)
  - getOrderByComponent
```
public OrderByClause getOrderByComponent()
```
    Get the component of order-by clause.
    
    定義:
    
    getOrderByComponent インタフェース内 OrderByBean
    
    戻り値:
    
    The component of order-by clause. (NotNull)
  - clearOrderBy
```
public OrderByBean clearOrderBy()
```
    Clear order-by.
    
    定義:
    
    clearOrderBy インタフェース内 OrderByBean
    
    戻り値:
    
    this. (NotNull)
  - checkSafetyResult
```
public void checkSafetyResult(int safetyMaxResultSize)
```
    Check whether the result size is safety or not.
    If the result size is in Danger Zone, the select method throws DangerousResultSizeException.
    
    定義:
    
    checkSafetyResult インタフェース内 FetchBean
    
    パラメータ:
    
    safetyMaxResultSize - The max size of safety result. (if zero or minus, checking is invalid)
  - getParameterMap
```
public Map<String,Object> getParameterMap()
```
    Get the map of parameter.
    
    定義:
    
    getParameterMap インタフェース内 MapParameterBean<Object>
    
    戻り値:
    
    The map of parameter. (NotNull)
  - addParameter
```
public void addParameter(String key,
                         Object value)
```
    Add the parameter to the map.
    
    パラメータ:
    
    key - The key of parameter. (NotNull)
    
    value - The value of parameter. (NullAllowed)
  - initializeParameterMapIfNeeds
```
protected void initializeParameterMapIfNeeds()
```
  - ln
```
protected String ln()
```
  - getSqlClause
```
public SqlClause getSqlClause()
```
    Get SQL clause instance. {Internal}
    
    戻り値:
    
    SQL clause. (NotNull)

クラス SimplePagingBean

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_sqlClause

_parameterMap

_safetyMaxResultSize

_paging

_pagingCountLater

_pagingReSelect

_fetchNarrowing

コンストラクタの詳細

SimplePagingBean

メソッドの詳細

isPaging

canPagingCountLater

canPagingReSelect

paging

throwPagingPageSizeNotPlusException

xsetPaging

enablePagingCountLater

disablePagingCountLater

enablePagingReSelect

disablePagingReSelect

fetchFirst

xfetchScope

xfetchPage

createPagingInvoker

getFetchStartIndex

getFetchSize

getFetchPageNumber

getPageStartIndex

getPageEndIndex

isFetchScopeEffective

getSafetyMaxResultSize

getFetchNarrowingSkipStartIndex

getFetchNarrowingLoopCount

isFetchNarrowingSkipStartIndexEffective

isFetchNarrowingLoopCountEffective

isFetchNarrowingEffective

xdisableFetchNarrowing

xenableIgnoredFetchNarrowing

getOrderByClause

getOrderByComponent

clearOrderBy

checkSafetyResult

getParameterMap

addParameter

initializeParameterMapIfNeeds

ln

getSqlClause