org.dbflute.bhv

インタフェース BehaviorReadable

既知のサブインタフェースのリスト:

BehaviorWritable

既知の実装クラスのリスト:

AbstractBehaviorReadable, AbstractBehaviorWritable

public interface BehaviorReadable

The interface of behavior-readable.

作成者:

jflute

メソッドのサマリー

修飾子とタイプ	メソッドと説明
DBMeta	asDBMeta() Handle the meta as DBMeta, that has all info of the table.
String	asTableDbName() Handle the meta as table DB name, that can be identity of table.
ConditionBean	newConditionBean() New condition-bean instance.
Entity	newEntity() New entity instance.
int	readCount(ConditionBean cb) Read count by condition-bean.
<RESULT extends Entity> void	readCursor(ConditionBean cb, EntityRowHandler<RESULT> entityLambda) Read the cursor by the row handler.
Entity	readEntity(ConditionBean cb) Read entity by condition-bean.
Entity	readEntityWithDeletedCheck(ConditionBean cb) Read simple entity by condition-bean with deleted check.
<RESULT extends Entity> ListResultBean<RESULT>	readList(ConditionBean cb) Read list as result-bean.
Number	readNextVal() Read next value of sequence.
<RESULT extends Entity> PagingResultBean<RESULT>	readPage(ConditionBean cb) Read page as result-bean.
<RESULT> HpSLSFunction<ConditionBean,RESULT>	readScalar(Class<RESULT> resultType) Read the scalar value derived by a function from uniquely-selected records.
<BEHAVIOR extends BehaviorReadable> OutsideSqlAllFacadeExecutor<BEHAVIOR>	readyOutsideSql() Prepare an outside-SQL execution by returning an instance of the executor for outside-SQL.
void	warmUpCommand() Warm up the command of behavior.

メソッドの詳細

asDBMeta

DBMeta asDBMeta()

Handle the meta as DBMeta, that has all info of the table.

戻り値:

The (singleton) instance of DB meta for the table. (NotNull)

asTableDbName

String asTableDbName()

Handle the meta as table DB name, that can be identity of table.

戻り値:

The (fixed) DB name of the table. (NotNull)

newEntity

Entity newEntity()

New entity instance.

戻り値:

Entity. (NotNull)

newConditionBean

ConditionBean newConditionBean()

New condition-bean instance.

戻り値:

Condition-bean. (NotNull)

readCount

int readCount(ConditionBean cb)

Read count by condition-bean.
An interface dispatch for selectCount().

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

戻り値:

Read count. (NotNull)

readEntity

Entity readEntity(ConditionBean cb)

Read entity by condition-bean.
An interface dispatch for selectEntity().

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

戻り値:

Read entity. (NullAllowed: when not found)

readEntityWithDeletedCheck

Entity readEntityWithDeletedCheck(ConditionBean cb)

Read simple entity by condition-bean with deleted check.
An interface dispatch for selectEntityWithDeletedCheck().

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

戻り値:

Read entity. (NotNull)

readList

<RESULT extends Entity> ListResultBean<RESULT> readList(ConditionBean cb)

Read list as result-bean.
An interface dispatch for selectList().

型パラメータ:

RESULT - The result type of entity.

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

戻り値:

The list of entity as result-bean. If the select result is zero, it returns empty list. (NotNull)

readPage

<RESULT extends Entity> PagingResultBean<RESULT> readPage(ConditionBean cb)

Read page as result-bean.
An interface dispatch for selectPage().

型パラメータ:

RESULT - The result type of entity.

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

戻り値:

The page of entity as result-bean. (NotNull)

readCursor

<RESULT extends Entity> void readCursor(ConditionBean cb,
                                        EntityRowHandler<RESULT> entityLambda)

Read the cursor by the row handler.
An interface dispatch for selecrCursor().

型パラメータ:

RESULT - The result type of entity.

パラメータ:

cb - The instance of corresponding condition-bean. (NotNull)

entityLambda - The handler of entity row. (NotNull)

readScalar

<RESULT> HpSLSFunction<ConditionBean,RESULT> readScalar(Class<RESULT> resultType)

Read the scalar value derived by a function from uniquely-selected records.
An interface dispatch for selectScalar().

型パラメータ:

RESULT - The type of scalar result.

パラメータ:

resultType - The type of result. (NotNull)

戻り値:

The scalar function object to specify function for scalar value. (NotNull)

readNextVal

Number readNextVal()

Read next value of sequence.
An interface dispatch for selectNextVal().

戻り値:

The next value of sequence. (NotNull)

readyOutsideSql

<BEHAVIOR extends BehaviorReadable> OutsideSqlAllFacadeExecutor<BEHAVIOR> readyOutsideSql()

Prepare an outside-SQL execution by returning an instance of the executor for outside-SQL.

型パラメータ:

BEHAVIOR - The type of behavior.

戻り値:

The facade for outside-SQL. (NotNull)

warmUpCommand

void warmUpCommand()

Warm up the command of behavior. {Internal}