org.dbflute.cbean.paging

クラス PagingInvoker<ENTITY>

java.lang.Object

org.dbflute.cbean.paging.PagingInvoker<ENTITY>

型パラメータ:

ENTITY - The type of entity.

public class PagingInvoker<ENTITY>
extends Object

The invoker of paging.

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
protected static class	PagingInvoker.InvocationResultResource<ENTITY>

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	_tableDbName

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

コンストラクタ

コンストラクタと説明
PagingInvoker(String tableDbName)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertObjectNotNull(String variableName, Object value) Assert that the object is not null.
protected void	checkSafetyResultIfNeeds(int safetyMaxResultSize, int allRecordCount) Check whether the count of all records is safety or not if it needs.
protected ResultBeanBuilder<ENTITY>	createResultBeanBuilder() Create the builder of result bean.
protected int	deriveAllRecordCountByLastPage(List<ENTITY> selectedList, PagingBean pagingBean) Derive all record count by last page.
protected PagingInvoker.InvocationResultResource<ENTITY>	doPaging(PagingHandler<ENTITY> handler, PagingBean pagingBean, ResultBeanBuilder<ENTITY> builder)
protected int	executeCount(PagingHandler<ENTITY> handler)
protected List<ENTITY>	executePaging(PagingHandler<ENTITY> handler)
PagingResultBean<ENTITY>	invokePaging(PagingHandler<ENTITY> handler) Invoke select-page by handler.
protected boolean	isCurrentLastPage(List<ENTITY> selectedList, PagingBean pagingBean) Is the current page is last page?
protected boolean	isNecessaryToReadPageAgain(PagingResultBean<ENTITY> rb) Is it necessary to read page again?
protected boolean	isUseManualThreadDataSource()
protected String	ln()
protected PagingResultBean<ENTITY>	reselect(PagingHandler<ENTITY> handler, PagingBean pagingBean, ResultBeanBuilder<ENTITY> builder, PagingResultBean<ENTITY> rb)
protected void	throwPagingOverSafetySizeException(int safetyMaxResultSize, int allRecordCount)
protected void	throwPagingStatusInvalidException(PagingBean pagingBean)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

_tableDbName

protected final String _tableDbName

コンストラクタの詳細

PagingInvoker

public PagingInvoker(String tableDbName)

メソッドの詳細

invokePaging

public PagingResultBean<ENTITY> invokePaging(PagingHandler<ENTITY> handler)

Invoke select-page by handler.

パラメータ:

handler - The handler of paging. (NotNull)

戻り値:

The result bean of paging. (NotNull)

例外:

PagingStatusInvalidException - When the paging status is invalid.

PagingOverSafetySizeException - When the paging is over safety size.

doPaging

protected PagingInvoker.InvocationResultResource<ENTITY> doPaging(PagingHandler<ENTITY> handler,
                                                                  PagingBean pagingBean,
                                                                  ResultBeanBuilder<ENTITY> builder)

createResultBeanBuilder

protected ResultBeanBuilder<ENTITY> createResultBeanBuilder()

Create the builder of result bean.

戻り値:

The builder of result bean. (NotNull)

executeCount

protected int executeCount(PagingHandler<ENTITY> handler)

executePaging

protected List<ENTITY> executePaging(PagingHandler<ENTITY> handler)

reselect

protected PagingResultBean<ENTITY> reselect(PagingHandler<ENTITY> handler,
                                            PagingBean pagingBean,
                                            ResultBeanBuilder<ENTITY> builder,
                                            PagingResultBean<ENTITY> rb)

isCurrentLastPage

protected boolean isCurrentLastPage(List<ENTITY> selectedList,
                                    PagingBean pagingBean)

Is the current page is last page?

パラメータ:

selectedList - The selected list. (NotNull)

pagingBean - The bean of paging. (NotNull)

戻り値:

The determination, true or false.

deriveAllRecordCountByLastPage

protected int deriveAllRecordCountByLastPage(List<ENTITY> selectedList,
                                             PagingBean pagingBean)

Derive all record count by last page.

パラメータ:

selectedList - The selected list. (NotNull)

pagingBean - The bean of paging. (NotNull)

戻り値:

Derived all record count.

isNecessaryToReadPageAgain

protected boolean isNecessaryToReadPageAgain(PagingResultBean<ENTITY> rb)

Is it necessary to read page again?

パラメータ:

rb - The result bean of paging. (NotNull)

戻り値:

The determination, true or false.

checkSafetyResultIfNeeds

protected void checkSafetyResultIfNeeds(int safetyMaxResultSize,
                                        int allRecordCount)

Check whether the count of all records is safety or not if it needs.

パラメータ:

safetyMaxResultSize - The max size of safety result.

allRecordCount - The count of all records.

例外:

DangerousResultSizeException - When the count of all records is dangerous.

isUseManualThreadDataSource

protected boolean isUseManualThreadDataSource()

throwPagingStatusInvalidException

protected void throwPagingStatusInvalidException(PagingBean pagingBean)

throwPagingOverSafetySizeException

protected void throwPagingOverSafetySizeException(int safetyMaxResultSize,
                                                  int allRecordCount)

ln

protected String ln()

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

Assert that the object is not null.

パラメータ:

variableName - The check name of variable for message. (NotNull)

value - The checked value. (NotNull)

例外:

IllegalArgumentException - When the argument is null.