org.dbflute.cbean.chelper

クラス HpSLSFunction<CB extends ConditionBean,RESULT>

java.lang.Object

org.dbflute.cbean.chelper.HpSLSFunction<CB,RESULT>

型パラメータ:

CB - The type of condition-bean.

RESULT - The type of result for scalar select

public class HpSLSFunction<CB extends ConditionBean,RESULT>
extends Object

The function for scalar select.

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected CB	_conditionBean The condition-bean for scalar select.
protected HpSLSExecutor<CB,RESULT>	_executor The executor of scalar select.
protected Class<RESULT>	_resultType The condition-bean for scalar select.

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

コンストラクタ

コンストラクタと説明
HpSLSFunction(CB conditionBean, Class<RESULT> resultType, HpSLSExecutor<CB,RESULT> executor)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertObjectNotNull(String variableName, Object value) Assert that the object is not null.
protected void	assertScalarQuery(ScalarQuery<?> scalarQuery)
protected void	assertScalarSelectOption(ScalarSelectOption option)
protected void	assertScalarSelectRequiredSpecifyColumn()
OptionalScalar<RESULT>	avg(ScalarQuery<CB> cbLambda) Select the average value.
OptionalScalar<RESULT>	avg(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the average value.
RESULT	count(ScalarQuery<CB> cbLambda) Select the count value.
RESULT	count(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the count value with function conversion option.
RESULT	countDistinct(ScalarQuery<CB> cbLambda) Select the count-distinct value.
RESULT	countDistinct(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the count-distinct value with function conversion option.
protected BehaviorExceptionThrower	createBhvExThrower()
protected ConditionBeanExceptionThrower	createCBExThrower()
protected ScalarSelectOption	createScalarSelectOption()
protected OptionalScalar<RESULT>	doAvg(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected RESULT	doCount(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected RESULT	doCountDistinct(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected OptionalScalar<RESULT>	doMax(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected OptionalScalar<RESULT>	doMin(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected OptionalScalar<RESULT>	doSum(ScalarQuery<CB> scalarQuery, ScalarSelectOption option)
protected RESULT	exec(ScalarQuery<CB> scalarQuery, SelectClauseType selectClauseType, ScalarSelectOption option)
OptionalScalar<RESULT>	max(ScalarQuery<CB> cbLambda) Select the maximum value.
OptionalScalar<RESULT>	max(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the maximum value with function conversion option.
OptionalScalar<RESULT>	min(ScalarQuery<CB> cbLambda) Select the minimum value.
OptionalScalar<RESULT>	min(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the minimum value with function conversion option.
protected ScalarSelectOption	newScalarSelectOption()
protected OptionalScalar<RESULT>	optionalOf(String title, RESULT result)
protected void	setupScalarSelectOption(ScalarSelectOption option)
protected void	setupTargetColumnInfo(ScalarSelectOption option)
OptionalScalar<RESULT>	sum(ScalarQuery<CB> cbLambda) Select the summary value.
OptionalScalar<RESULT>	sum(ScalarQuery<CB> cbLambda, FunctionFilterOptionCall<ScalarSelectOption> opLambda) Select the summary value with function conversion option.
protected void	throwScalarSelectInvalidColumnSpecificationException()
protected void	throwScalarSelectValueNotFoundException(String title)

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

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

フィールドの詳細

_conditionBean

protected final CB extends ConditionBean _conditionBean

The condition-bean for scalar select. (NotNull)

_resultType

protected final Class<RESULT> _resultType

The condition-bean for scalar select. (NotNull)

_executor

protected final HpSLSExecutor<CB extends ConditionBean,RESULT> _executor

The executor of scalar select. (NotNull)

コンストラクタの詳細

HpSLSFunction

public HpSLSFunction(CB conditionBean,
                     Class<RESULT> resultType,
                     HpSLSExecutor<CB,RESULT> executor)

パラメータ:

conditionBean - The condition-bean initialized only for scalar select. (NotNull)

resultType - The type as result. (NotNull)

executor - The executor of scalar select with select clause type. (NotNull)

メソッドの詳細

count

public RESULT count(ScalarQuery<CB> cbLambda)

Select the count value.
You can also get same result by selectCount(cb) method.

 memberBhv.scalarSelect(Integer.class).count(cb -> {
     cb.specify().columnMemberId(); // the required specification of (basically) primary key column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The count value calculated by function. (NotNull)

count

public RESULT count(ScalarQuery<CB> cbLambda,
                    FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the count value with function conversion option.

 memberBhv.scalarSelect(Integer.class).count(cb -> {
     cb.specify().columnMemberId(); // the required specification of (basically) primary key column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The count value calculated by function. (NotNull)

doCount

protected RESULT doCount(ScalarQuery<CB> scalarQuery,
                         ScalarSelectOption option)

countDistinct

public RESULT countDistinct(ScalarQuery<CB> cbLambda)

Select the count-distinct value.
You can also get same result by selectCount(cb) method.

 memberBhv.scalarSelect(Integer.class).countDistinct(cb -> {
     cb.specify().columnMemberId(); // the required specification of (basically) primary key column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The count-distinct value calculated by function. (NotNull)

countDistinct

public RESULT countDistinct(ScalarQuery<CB> cbLambda,
                            FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the count-distinct value with function conversion option.

 memberBhv.scalarSelect(Integer.class).countDistinct(cb -> {
     cb.specify().columnMemberId(); // the required specification of (basically) primary key column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The count-distinct value calculated by function. (NotNull)

doCountDistinct

protected RESULT doCountDistinct(ScalarQuery<CB> scalarQuery,
                                 ScalarSelectOption option)

max

public OptionalScalar<RESULT> max(ScalarQuery<CB> cbLambda)

Select the maximum value.

 memberBhv.scalarSelect(Date.class).max(cb -> {
     cb.specify().columnBirthdate(); // the required specification of target column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The optional scalar for maximum value calculated by function. (NullAllowed)

max

public OptionalScalar<RESULT> max(ScalarQuery<CB> cbLambda,
                                  FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the maximum value with function conversion option.

 memberBhv.scalarSelect(Date.class).max(cb -> {
     cb.specify().columnBirthdate(); // the required specification of target column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The optional scalar for maximum value calculated by function. (NullAllowed: or NotNull if you use coalesce by option)

doMax

protected OptionalScalar<RESULT> doMax(ScalarQuery<CB> scalarQuery,
                                       ScalarSelectOption option)

min

public OptionalScalar<RESULT> min(ScalarQuery<CB> cbLambda)

Select the minimum value.

 memberBhv.scalarSelect(Date.class).min(cb -> {
     cb.specify().columnBirthdate(); // the required specification of target column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The optional scalar for minimum value calculated by function. (NullAllowed)

min

public OptionalScalar<RESULT> min(ScalarQuery<CB> cbLambda,
                                  FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the minimum value with function conversion option.

 memberBhv.scalarSelect(Date.class).min(cb -> {
     cb.specify().columnBirthdate(); // the required specification of target column
     cb.query().setMemberStatusCode_Equal_Formalized(); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The optional scalar for minimum value calculated by function. (NullAllowed: or NotNull if you use coalesce by option)

doMin

protected OptionalScalar<RESULT> doMin(ScalarQuery<CB> scalarQuery,
                                       ScalarSelectOption option)

sum

public OptionalScalar<RESULT> sum(ScalarQuery<CB> cbLambda)

Select the summary value.

 purchaseBhv.scalarSelect(Integer.class).sum(cb -> {
     cb.specify().columnPurchaseCount(); // the required specification of target column
     cb.query().setPurchaseDatetime_GreaterEqual(date); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The optional scalar for summary value calculated by function. (NullAllowed)

sum

public OptionalScalar<RESULT> sum(ScalarQuery<CB> cbLambda,
                                  FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the summary value with function conversion option.

 purchaseBhv.scalarSelect(Integer.class).sum(cb -> {
     cb.specify().columnPurchaseCount(); // the required specification of target column
     cb.query().setPurchaseDatetime_GreaterEqual(date); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The optional scalar for summary value calculated by function. (NullAllowed: or NotNull if you use coalesce by option)

doSum

protected OptionalScalar<RESULT> doSum(ScalarQuery<CB> scalarQuery,
                                       ScalarSelectOption option)

avg

public OptionalScalar<RESULT> avg(ScalarQuery<CB> cbLambda)

Select the average value.

 purchaseBhv.scalarSelect(Integer.class).avg(cb -> {
     cb.specify().columnPurchaseCount(); // the required specification of target column
     cb.query().setPurchaseDatetime_GreaterEqual(date); // query as you like it
 });
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

戻り値:

The optional scalar for average value calculated by function. (NullAllowed)

avg

public OptionalScalar<RESULT> avg(ScalarQuery<CB> cbLambda,
                                  FunctionFilterOptionCall<ScalarSelectOption> opLambda)

Select the average value.

 purchaseBhv.scalarSelect(Integer.class).avg(cb -> {
     cb.specify().columnPurchaseCount(); // the required specification of target column
     cb.query().setPurchaseDatetime_GreaterEqual(date); // query as you like it
 }, op -> op.coalesce(0));
 

パラメータ:

cbLambda - The callback to select scalar value. (NotNull)

opLambda - The callback for option of scalar. (NotNull)

戻り値:

The optional scalar for average value calculated by function. (NullAllowed: or NotNull if you use coalesce by option)

doAvg

protected OptionalScalar<RESULT> doAvg(ScalarQuery<CB> scalarQuery,
                                       ScalarSelectOption option)

optionalOf

protected OptionalScalar<RESULT> optionalOf(String title,
                                            RESULT result)

throwScalarSelectValueNotFoundException

protected void throwScalarSelectValueNotFoundException(String title)

exec

protected RESULT exec(ScalarQuery<CB> scalarQuery,
                      SelectClauseType selectClauseType,
                      ScalarSelectOption option)

setupTargetColumnInfo

protected void setupTargetColumnInfo(ScalarSelectOption option)

setupScalarSelectOption

protected void setupScalarSelectOption(ScalarSelectOption option)

assertScalarSelectRequiredSpecifyColumn

protected void assertScalarSelectRequiredSpecifyColumn()

throwScalarSelectInvalidColumnSpecificationException

protected void throwScalarSelectInvalidColumnSpecificationException()

createScalarSelectOption

protected ScalarSelectOption createScalarSelectOption()

newScalarSelectOption

protected ScalarSelectOption newScalarSelectOption()

createBhvExThrower

protected BehaviorExceptionThrower createBhvExThrower()

createCBExThrower

protected ConditionBeanExceptionThrower createCBExThrower()

assertScalarQuery

protected void assertScalarQuery(ScalarQuery<?> scalarQuery)

assertScalarSelectOption

protected void assertScalarSelectOption(ScalarSelectOption option)

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

Assert that the object is not null.

パラメータ:

variableName - The variable name for message. (NotNull)

value - The value the checked variable. (NotNull)

例外:

IllegalArgumentException - When the variable name or the variable is null.