org.dbflute.outsidesql.executor

クラス OutsideSqlBasicExecutor<BEHAVIOR>

java.lang.Object

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

型パラメータ:

BEHAVIOR - The type of behavior.

public class OutsideSqlBasicExecutor<BEHAVIOR>
extends Object

The basic executor of outside-SQL.

作成者:

jflute

フィールドのサマリー

フィールド

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

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

コンストラクタ

コンストラクタと説明
OutsideSqlBasicExecutor(BehaviorCommandInvoker behaviorCommandInvoker, String tableDbName, DBDef currentDBDef, OutsideSqlOption outsideSqlOption, OutsideSqlContextFactory outsideSqlContextFactory, OutsideSqlFilter outsideSqlFilter, OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected <ENTITY> void	assertTypedPmbNotNull(TypedParameterBean<BEHAVIOR> pmb)
OutsideSqlAutoPagingExecutor<BEHAVIOR>	autoPaging() Prepare the paging as auto-paging.
void	call(ProcedurePmb pmb) Call the procedure.
OutsideSqlBasicExecutor<BEHAVIOR>	configure(StatementConfig statementConfig) Configure statement JDBC options.
BehaviorExceptionThrower	createBhvExThrower()
protected BehaviorCommand<Void>	createCallCommand(String path, Object pmb)
protected BehaviorCommand<Integer>	createExecuteCommand(String path, Object pmb)
protected <ENTITY> ListResultBean<ENTITY>	createListResultBean(List<ENTITY> selectedList)
protected OutsideSqlAutoPagingExecutor<BEHAVIOR>	createOutsideSqlAutoPagingExecutor()
protected OutsideSqlCursorExecutor<BEHAVIOR>	createOutsideSqlCursorExecutor()
protected OutsideSqlEntityExecutor<BEHAVIOR>	createOutsideSqlEntityExecutor()
protected OutsideSqlManualPagingExecutor<BEHAVIOR>	createOutsideSqlManualPagingExecutor()
protected <ENTITY> BehaviorCommand<List<ENTITY>>	createSelectListCommand(String path, Object pmb, Class<ENTITY> entityType)
OutsideSqlCursorExecutor<BEHAVIOR>	cursorHandling() Prepare cursor handling.
protected int	doExecute(String path, Object pmb)
protected <ENTITY> ListResultBean<ENTITY>	doSelectList(String path, Object pmb, Class<ENTITY> entityType)
OutsideSqlEntityExecutor<BEHAVIOR>	entityHandling() Prepare entity handling.
int	execute(ExecuteHandlingPmb<BEHAVIOR> pmb) Execute the outsideSql.
int	execute(String path, Object pmb) Execute the outsideSql.
OutsideSqlBasicExecutor<BEHAVIOR>	formatSql() Set up format-SQL for this outsideSql.
OutsideSqlOption	getOutsideSqlOption()
protected <RESULT> RESULT	invoke(BehaviorCommand<RESULT> behaviorCommand) Invoke the command of behavior.
OutsideSqlManualPagingExecutor<BEHAVIOR>	manualPaging() Prepare the paging as manual-paging.
protected OutsideSqlCallCommand	newOutsideSqlCallCommand()
protected OutsideSqlExecuteCommand	newOutsideSqlExecuteCommand()
protected <ENTITY> OutsideSqlSelectListCommand<ENTITY>	newOutsideSqlSelectListCommand()
OutsideSqlBasicExecutor<BEHAVIOR>	removeBlockComment() Set up remove-block-comment for this outsideSql.
OutsideSqlBasicExecutor<BEHAVIOR>	removeLineComment() Set up remove-line-comment for this outsideSql.
<ENTITY> ListResultBean<ENTITY>	selectList(ListHandlingPmb<BEHAVIOR,ENTITY> pmb) Select the list of the entity by the outsideSql.
<ENTITY> ListResultBean<ENTITY>	selectList(String path, Object pmb, Class<ENTITY> entityType) Select the list of the entity by the outsideSql.
protected void	throwDangerousResultSizeException(Object pmb, FetchingOverSafetySizeException e)
protected <COMMAND extends AbstractOutsideSqlCommand<?>> COMMAND	xsetupCommand(COMMAND cmd, String path, Object pmb)

クラスから継承されたメソッド 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

Table DB name. (NotNull)

_currentDBDef

protected final DBDef _currentDBDef

The current database definition. (NotNull)

_outsideSqlOption

protected final OutsideSqlOption _outsideSqlOption

The option of outside-SQL. (NotNull)

_outsideSqlContextFactory

protected final OutsideSqlContextFactory _outsideSqlContextFactory

The factory of outside-SQL context. (NotNull)

_outsideSqlFilter

protected final OutsideSqlFilter _outsideSqlFilter

The filter of outside-SQL. (NullAllowed)

_outsideSqlExecutorFactory

protected final OutsideSqlExecutorFactory _outsideSqlExecutorFactory

The factory of outside-SQL executor. (NotNull)

コンストラクタの詳細

OutsideSqlBasicExecutor

public OutsideSqlBasicExecutor(BehaviorCommandInvoker behaviorCommandInvoker,
                               String tableDbName,
                               DBDef currentDBDef,
                               OutsideSqlOption outsideSqlOption,
                               OutsideSqlContextFactory outsideSqlContextFactory,
                               OutsideSqlFilter outsideSqlFilter,
                               OutsideSqlExecutorFactory outsideSqlExecutorFactory)

メソッドの詳細

selectList

public <ENTITY> ListResultBean<ENTITY> selectList(ListHandlingPmb<BEHAVIOR,ENTITY> pmb)

Select the list of the entity by the outsideSql. {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.setMemberName_PrefixSearch("S");
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().selectList(pmb);
 for (SimpleMember member : memberList) {
     ... = member.get...();
 }
 

It needs to use customize-entity and parameter-bean. The way to generate them is following:

 -- #df:entity#
 -- !df:pmb!
 -- !!Integer memberId!!
 -- !!String memberName!!
 -- !!...!!
 

型パラメータ:

ENTITY - The type of entity for element.

パラメータ:

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

戻り値:

The result bean of selected list. (NotNull)

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

DangerousResultSizeException - When the result size is over the specified safety size.

selectList

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

Select the list of the entity by the outsideSql. {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.setMemberName_PrefixSearch("S");
 Class<SimpleMember> entityType = SimpleMember.class;
 ListResultBean<SimpleMember> memberList
     = memberBhv.outsideSql().selectList(path, pmb, entityType);
 for (SimpleMember member : memberList) {
     ... = member.get...();
 }
 

It needs to use customize-entity and parameter-bean. The way to generate them is following:

 -- #df:entity#
 -- !df:pmb!
 -- !!Integer memberId!!
 -- !!String memberName!!
 -- !!...!!
 

型パラメータ:

ENTITY - The type of entity for element.

パラメータ:

path - The path of SQL file. (NotNull)

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

entityType - The element type of entity. (NotNull)

戻り値:

The result bean of selected list. (NotNull)

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

DangerousResultSizeException - When the result size is over the specified safety size.

doSelectList

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

createListResultBean

protected <ENTITY> ListResultBean<ENTITY> createListResultBean(List<ENTITY> selectedList)

throwDangerousResultSizeException

protected void throwDangerousResultSizeException(Object pmb,
                                                 FetchingOverSafetySizeException e)

execute

public int execute(ExecuteHandlingPmb<BEHAVIOR> pmb)

Execute the outsideSql. (insert, update, delete, etc...) {Typed Interface}
You can call this method by only a typed parameter-bean which is related to its own (outside-SQL) path.

 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 int count = memberBhv.outsideSql().execute(pmb);
 

パラメータ:

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

戻り値:

The count of execution.

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

execute

public int execute(String path,
                   Object pmb)

Execute the outsideSql. (insert, update, delete, etc...) {FreeStyle Interface}
This method can accept each element: path, parameter-bean(Object type).

 String path = MemberBhv.PATH_selectSimpleMember;
 SimpleMemberPmb pmb = new SimpleMemberPmb();
 pmb.setMemberId(3);
 int count = memberBhv.outsideSql().execute(path, pmb);
 

パラメータ:

path - The path of SQL file. (NotNull)

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

戻り値:

The count of execution.

例外:

OutsideSqlNotFoundException - When the outsideSql is not found.

doExecute

protected int doExecute(String path,
                        Object pmb)

call

public void call(ProcedurePmb pmb)

Call the procedure.

 SpInOutParameterPmb pmb = new SpInOutParameterPmb();
 pmb.setVInVarchar("foo");
 pmb.setVInOutVarchar("bar");
 memberBhv.outsideSql().call(pmb);
 String outVar = pmb.getVOutVarchar();
 

It needs to use parameter-bean for procedure (ProcedurePmb). The way to generate is to set the option of DBFlute property and execute Sql2Entity.

パラメータ:

pmb - The parameter-bean for procedure. (NotNull)

createSelectListCommand

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

newOutsideSqlSelectListCommand

protected <ENTITY> OutsideSqlSelectListCommand<ENTITY> newOutsideSqlSelectListCommand()

createExecuteCommand

protected BehaviorCommand<Integer> createExecuteCommand(String path,
                                                        Object pmb)

newOutsideSqlExecuteCommand

protected OutsideSqlExecuteCommand newOutsideSqlExecuteCommand()

createCallCommand

protected BehaviorCommand<Void> createCallCommand(String path,
                                                  Object pmb)

newOutsideSqlCallCommand

protected OutsideSqlCallCommand newOutsideSqlCallCommand()

xsetupCommand

protected <COMMAND extends AbstractOutsideSqlCommand<?>> COMMAND xsetupCommand(COMMAND cmd,
                                                                               String path,
                                                                               Object pmb)

invoke

protected <RESULT> RESULT invoke(BehaviorCommand<RESULT> behaviorCommand)

Invoke the command of behavior.

型パラメータ:

RESULT - The type of result.

パラメータ:

behaviorCommand - The command of behavior. (NotNull)

戻り値:

The instance of result. (NullAllowed)

entityHandling

public OutsideSqlEntityExecutor<BEHAVIOR> entityHandling()

Prepare entity handling.

 memberBhv.outsideSql().entityHandling().selectEntityWithDeletedCheck(pmb);
 

戻り値:

The cursor executor of outsideSql. (NotNull)

createOutsideSqlEntityExecutor

protected OutsideSqlEntityExecutor<BEHAVIOR> createOutsideSqlEntityExecutor()

manualPaging

public OutsideSqlManualPagingExecutor<BEHAVIOR> manualPaging()

Prepare the paging as manual-paging.

 memberBhv.outsideSql().manualPaging().selectPage(pmb);
 

If you call this, you need to write paging condition on your SQL.

 e.g. MySQL
 select member.MEMBER_ID, member...
   from Member member
  where ...
  order by ...
  limit 40, 20 -- is necessary!
 

戻り値:

The executor of paging that the paging mode is manual. (NotNull)

createOutsideSqlManualPagingExecutor

protected OutsideSqlManualPagingExecutor<BEHAVIOR> createOutsideSqlManualPagingExecutor()

autoPaging

public OutsideSqlAutoPagingExecutor<BEHAVIOR> autoPaging()

Prepare the paging as auto-paging.

 memberBhv.outsideSql().autoPaging().selectPage(pmb);
 

If you call this, you don't need to write paging condition on your SQL.

 e.g. MySQL
 select member.MEMBER_ID, member...
   from Member member
  where ...
  order by ...
 -- limit 40, 20 -- is unnecessary!
 

戻り値:

The executor of paging that the paging mode is auto. (NotNull)

createOutsideSqlAutoPagingExecutor

protected OutsideSqlAutoPagingExecutor<BEHAVIOR> createOutsideSqlAutoPagingExecutor()

cursorHandling

public OutsideSqlCursorExecutor<BEHAVIOR> cursorHandling()

Prepare cursor handling.

 memberBhv.outsideSql().cursorHandling().selectCursor(pmb);
 

戻り値:

The cursor executor of outsideSql. (NotNull)

createOutsideSqlCursorExecutor

protected OutsideSqlCursorExecutor<BEHAVIOR> createOutsideSqlCursorExecutor()

removeBlockComment

public OutsideSqlBasicExecutor<BEHAVIOR> removeBlockComment()

Set up remove-block-comment for this outsideSql.

戻り値:

this. (NotNull)

removeLineComment

public OutsideSqlBasicExecutor<BEHAVIOR> removeLineComment()

Set up remove-line-comment for this outsideSql.

戻り値:

this. (NotNull)

formatSql

public OutsideSqlBasicExecutor<BEHAVIOR> formatSql()

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

戻り値:

this. (NotNull)

configure

public OutsideSqlBasicExecutor<BEHAVIOR> configure(StatementConfig statementConfig)

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

パラメータ:

statementConfig - The configuration of statement. (NotNull)

戻り値:

this. (NotNull)

createBhvExThrower

public BehaviorExceptionThrower createBhvExThrower()

assertTypedPmbNotNull

protected <ENTITY> void assertTypedPmbNotNull(TypedParameterBean<BEHAVIOR> pmb)

getOutsideSqlOption

public OutsideSqlOption getOutsideSqlOption()