org.dbflute.outsidesql.executor

クラス OutsideSqlEntityExecutor<BEHAVIOR>

java.lang.Object

org.dbflute.outsidesql.executor.OutsideSqlEntityExecutor<BEHAVIOR>

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlEntityExecutor<BEHAVIOR>
extends Object

The cursor executor of outside-SQL.

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected BehaviorCommandInvoker	_behaviorCommandInvoker The invoker of behavior command.
protected DBDef	_currentDBDef The current database definition.
protected OutsideSqlExecutorFactory	_outsideSqlExecutorFactory The factory of outside-SQL executor.
protected OutsideSqlOption	_outsideSqlOption The option of outside-SQL.
protected String	_tableDbName The DB name of table.

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

コンストラクタ

コンストラクタと説明
OutsideSqlEntityExecutor(BehaviorCommandInvoker behaviorCommandInvoker, String tableDbName, DBDef currentDBDef, OutsideSqlOption outsideSqlOption, OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected <ENTITY> String	buildSearchKey4Exception(String path, Object pmb, Class<ENTITY> entityType)
OutsideSqlEntityExecutor<BEHAVIOR>	configure(StatementConfig statementConfig) Configure statement JDBC options.
protected OutsideSqlBasicExecutor<BEHAVIOR>	createBasicExecutor()
protected BehaviorExceptionThrower	createBhvExThrower()
protected <ENTITY> ENTITY	doSelectEntity(String path, Object pmb, Class<ENTITY> entityType)
protected <ENTITY> ENTITY	doSelectEntityWithDeletedCheck(String path, Object pmb, Class<ENTITY> entityType)
protected <ENTITY> List<ENTITY>	doSelectList(String path, Object pmb, Class<ENTITY> entityType)
OutsideSqlEntityExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outside-SQL.
protected static String	ln() Get the value of line separator.
OutsideSqlEntityExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outside-SQL.
OutsideSqlEntityExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outside-SQL.
<ENTITY> ENTITY	selectEntity(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb) Select entity by the outside-SQL.
<ENTITY> ENTITY	selectEntity(String path, Object pmb, Class<ENTITY> entityType) Select entity by the outside-SQL.
<ENTITY> ENTITY	selectEntityWithDeletedCheck(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb) Select entity with deleted check by the outside-SQL.
<ENTITY> ENTITY	selectEntityWithDeletedCheck(String path, Object pmb, Class<ENTITY> entityType) Select entity with deleted check by the outside-SQL.
protected void	throwSelectEntityAlreadyDeletedException(Object searchKey)
protected void	throwSelectEntityDuplicatedException(String resultCountExp, Object searchKey, Throwable cause)
protected int	xcheckSafetyResultAsOneIfNeed(Object pmb)
protected void	xrestoreSafetyResultIfNeed(Object pmb, int preSafetyMaxResultSize)

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

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

フィールドの詳細

_behaviorCommandInvoker

protected final BehaviorCommandInvoker _behaviorCommandInvoker

The invoker of behavior command. (NotNull)

_tableDbName

protected final String _tableDbName

The DB name of table. (NotNull)

_currentDBDef

protected final DBDef _currentDBDef

The current database definition. (NotNull)

_outsideSqlOption

protected final OutsideSqlOption _outsideSqlOption

The option of outside-SQL. (NotNull)

_outsideSqlExecutorFactory

protected final OutsideSqlExecutorFactory _outsideSqlExecutorFactory

The factory of outside-SQL executor. (NotNull)

コンストラクタの詳細

OutsideSqlEntityExecutor

public OutsideSqlEntityExecutor(BehaviorCommandInvoker behaviorCommandInvoker,
                                String tableDbName,
                                DBDef currentDBDef,
                                OutsideSqlOption outsideSqlOption,
                                OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドの詳細

selectEntity

public <ENTITY> ENTITY selectEntity(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select entity by the outside-SQL. {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 SimpleMember member
     = memberBhv.outsideSql().entityHandling().selectEntity(pmb);
 if (member != null) {
     ... = member.get...();
 } else {
     ...
 }
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

pmb - The typed parameter-bean for entity handling. (NotNull)

戻り値:

The selected entity. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityDuplicatedException - When the entity is duplicated.

selectEntity

public <ENTITY> ENTITY selectEntity(String path,
                                    Object pmb,
                                    Class<ENTITY> entityType)

Select entity by the outside-SQL. {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type), entity-type.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 Class<SimpleMember> entityType = SimpleMember.class;
 SimpleMember member
     = memberBhv.outsideSql().entityHandling().selectEntity(path, pmb, entityType);
 if (member != null) {
     ... = member.get...();
 } else {
     ...
 }
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

path - The path of SQL file. (NotNull)

pmb - The object as parameter-bean. Allowed types are Bean object and Map object. (NullAllowed)

entityType - The type of entity. (NotNull)

戻り値:

The selected entity. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityDuplicatedException - When the entity is duplicated.

doSelectEntity

protected <ENTITY> ENTITY doSelectEntity(String path,
                                         Object pmb,
                                         Class<ENTITY> entityType)

xcheckSafetyResultAsOneIfNeed

protected int xcheckSafetyResultAsOneIfNeed(Object pmb)

xrestoreSafetyResultIfNeed

protected void xrestoreSafetyResultIfNeed(Object pmb,
                                          int preSafetyMaxResultSize)

buildSearchKey4Exception

protected <ENTITY> String buildSearchKey4Exception(String path,
                                                   Object pmb,
                                                   Class<ENTITY> entityType)

throwSelectEntityDuplicatedException

protected void throwSelectEntityDuplicatedException(String resultCountExp,
                                                    Object searchKey,
                                                    Throwable cause)

doSelectList

protected <ENTITY> List<ENTITY> doSelectList(String path,
                                             Object pmb,
                                             Class<ENTITY> entityType)

createBasicExecutor

protected OutsideSqlBasicExecutor<BEHAVIOR> createBasicExecutor()

selectEntityWithDeletedCheck

public <ENTITY> ENTITY selectEntityWithDeletedCheck(EntityHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select entity with deleted check by the outside-SQL. {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path and entity-type.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 SimpleMember member
     = memberBhv.outsideSql().entityHandling().selectEntityWithDeletedCheck(pmb);
 ... = member.get...(); // the entity always be not null
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

pmb - The typed parameter-bean for entity handling. (NotNull)

戻り値:

The selected entity. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityAlreadyDeletedException - When the entity has already been deleted(not found).

EntityDuplicatedException - When the entity is duplicated.

selectEntityWithDeletedCheck

public <ENTITY> ENTITY selectEntityWithDeletedCheck(String path,
                                                    Object pmb,
                                                    Class<ENTITY> entityType)

Select entity with deleted check by the outside-SQL. {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type), entity-type.

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 Class<SimpleMember> entityType = SimpleMember.class;
 SimpleMember member
     = memberBhv.outsideSql().entityHandling().selectEntityWithDeletedCheck(path, pmb, entityType);
 ... = member.get...(); // the entity always be not null
 

型パラメータ:

ENTITY - The type of entity.

パラメータ:

path - The path of SQL file. (NotNull)

pmb - The parameter-bean. Allowed types are Bean object and Map object. (NullAllowed)

entityType - The type of entity. (NotNull)

戻り値:

The selected entity. (NullAllowed)

例外:

OutsideSqlNotFoundException - When the outside-SQL is not found.

EntityAlreadyDeletedException - When the entity has already been deleted(not found).

EntityDuplicatedException - When the entity is duplicated.

doSelectEntityWithDeletedCheck

protected <ENTITY> ENTITY doSelectEntityWithDeletedCheck(String path,
                                                         Object pmb,
                                                         Class<ENTITY> entityType)

throwSelectEntityAlreadyDeletedException

protected void throwSelectEntityAlreadyDeletedException(Object searchKey)

removeBlockComment

public OutsideSqlEntityExecutor<BEHAVIOR> removeBlockComment()

Set up remove-block-comment for this outside-SQL.

戻り値:

this. (NotNull)

removeLineComment

public OutsideSqlEntityExecutor<BEHAVIOR> removeLineComment()

Set up remove-line-comment for this outside-SQL.

戻り値:

this. (NotNull)

formatSql

public OutsideSqlEntityExecutor<BEHAVIOR> formatSql()

Set up format-SQL for this outside-SQL.
(For example, empty lines removed)

戻り値:

this. (NotNull)

configure

public OutsideSqlEntityExecutor<BEHAVIOR> configure(StatementConfig statementConfig)

Configure statement JDBC options. (For example, queryTimeout, fetchSize, ...)

パラメータ:

statementConfig - The configuration of statement. (NullAllowed)

戻り値:

this. (NotNull)

createBhvExThrower

protected BehaviorExceptionThrower createBhvExThrower()

ln

protected static String ln()

Get the value of line separator.

戻り値:

The value of line separator. (NotNull)