Skip to content

Commit

Permalink
DBFlute Runtime: ConditionQuery invoking by extends option #183 ::
Browse files Browse the repository at this point in the history 
finish
  • Loading branch information
@jflute
jflute committed Jul 21, 2023
1 parent 789870c commit f1ab906
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 34 deletions.
1 change: 1 addition & 0 deletions dbflute-engine/embedded/templates/om/scala/cbean/AbstractBsConditionQuery.vmcala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1662,6 +1662,7 @@ abstract class ${myClassName}(referrerQuery: ConditionQuery, sqlClause: SqlClaus
// ===================================================================================
// Invoke Query
// ============
## this methods are moved to individual class since 1.2.7 so needs to fix here by jflute (2023/07/21)
override protected def xfilterInvokeQueryParameterType(colName: String, ckey: String, parameterType: Class[_]): Class[_] =
{ if (classOf[Collection[_]].isAssignableFrom(parameterType)) { classOf[List[_]] } else { parameterType } }

Expand Down
2 changes: 1 addition & 1 deletion dbflute-runtime/src/main/java/org/dbflute/cbean/coption/SimpleStringOption.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.dbflute.util.Srl;

/**
* The class of simple-string-option.
* The option of simple string, e.g. LikeSearch.
* @author jflute
*/
public class SimpleStringOption implements ConditionOption {
Expand Down
150 changes: 117 additions & 33 deletions dbflute-runtime/src/main/java/org/dbflute/cbean/garnish/invoking/InvokingQueryAgent.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@

import org.dbflute.cbean.ConditionQuery;
import org.dbflute.cbean.coption.ConditionOption;
import org.dbflute.cbean.coption.FromToOption;
import org.dbflute.cbean.coption.LikeSearchOption;
import org.dbflute.cbean.coption.RangeOfOption;
import org.dbflute.cbean.cvalue.ConditionValue;
import org.dbflute.dbmeta.DBMeta;
import org.dbflute.dbmeta.DBMetaProvider;
Expand Down Expand Up @@ -69,7 +72,7 @@ public ConditionValue invokeValue(DBMeta dbmeta, String columnFlexibleName) {
assertStringNotNullAndNotTrimmedEmpty("columnFlexibleName", columnFlexibleName);
final String columnCapPropName = initCap(dbmeta.findColumnInfo(columnFlexibleName).getPropertyName());
final String methodName = "xdfget" + columnCapPropName;
final Method method = xhelpGettingCQMethod(_rootQuery, methodName, (Class<?>[]) null);
final Method method = searchSimpleCQMethod(_rootQuery, methodName, (Class<?>[]) null);
if (method == null) {
throwConditionInvokingGetMethodNotFoundException(columnFlexibleName, methodName);
return null; // unreachable
Expand Down Expand Up @@ -124,8 +127,8 @@ public void invokeQuery(String colName, String ckey, Object value, ConditionOpti
}
final PropertyNameCQContainer container = xhelpExtractingPropertyNameCQContainer(colName);
final String flexibleName = container.getFlexibleName();
final ConditionQuery cq = container.getConditionQuery();
final DBMeta dbmeta = _dbmetaProvider.provideDBMetaChecked(cq.asTableDbName());
final ConditionQuery declaringCQ = container.getConditionQuery();
final DBMeta dbmeta = _dbmetaProvider.provideDBMetaChecked(declaringCQ.asTableDbName());
final ColumnInfo columnInfo;
try {
columnInfo = dbmeta.findColumnInfo(flexibleName);
Expand Down Expand Up @@ -171,23 +174,23 @@ public void invokeQuery(String colName, String ckey, Object value, ConditionOpti
}
}
}
if (option != null) {
if (option != null) { // always last argument (is implementation policy)
typeList.add(option.getClass());
}
final List<Class<?>> filteredTypeList = newArrayListSized(typeList.size());
for (Class<?> parameterType : typeList) {
filteredTypeList.add(xfilterInvokeQueryParameterType(colName, ckey, parameterType));
}
final Class<?>[] parameterTypes = filteredTypeList.toArray(new Class<?>[filteredTypeList.size()]);
final Method method = xhelpGettingCQMethod(cq, methodName, parameterTypes);
final Class<?>[] argTypes = filteredTypeList.toArray(new Class<?>[filteredTypeList.size()]);
final Method method = searchQuerySetMethod(declaringCQ, methodName, argTypes, option);
if (method == null) {
throwConditionInvokingSetMethodNotFoundException(colName, ckey, value, option, methodName, parameterTypes);
throwConditionInvokingSetMethodNotFoundException(colName, ckey, value, option, methodName, argTypes);
}
try {
final List<Object> argList = newArrayList();
if (fromTo || rangeOf) {
if (!(value instanceof List<?>)) { // check type
throwConditionInvokingDateFromToValueInvalidException(colName, ckey, value, option, methodName, parameterTypes);
throwConditionInvokingDateFromToValueInvalidException(colName, ckey, value, option, methodName, argTypes);
}
argList.addAll((List<?>) value);
} else {
Expand All @@ -202,24 +205,95 @@ public void invokeQuery(String colName, String ckey, Object value, ConditionOpti
for (Object arg : argList) {
filteredArgList.add(xfilterInvokeQueryParameterValue(colName, ckey, arg));
}
xhelpInvokingCQMethod(cq, method, filteredArgList.toArray());
xhelpInvokingCQMethod(declaringCQ, method, filteredArgList.toArray());
} catch (ReflectionFailureException e) {
throwConditionInvokingSetReflectionFailureException(colName, ckey, value, option, methodName, parameterTypes, e);
throwConditionInvokingSetReflectionFailureException(colName, ckey, value, option, methodName, argTypes, e);
}
}

// -----------------------------------------------------
// Method Name
// -----------
protected String xbuildQuerySetMethodName(String ckey, String columnCapPropName) {
return "set" + columnCapPropName + "_" + initCap(ckey);
}

// -----------------------------------------------------
// Parameter Type
// --------------
protected Class<?> xfilterInvokeQueryParameterType(String colName, String ckey, Class<?> parameterType) {
return parameterType; // no filter as default (e.g. overridden by Scala to convert to immutable list)
}

// -----------------------------------------------------
// Method Search
// -------------
protected Method searchQuerySetMethod(ConditionQuery declaringCQ, String methodName, Class<?>[] argTypes, ConditionOption option) {
Method found = findCQPublicMethod(declaringCQ, methodName, argTypes);
if (found != null) { // e.g. simple set method (without option), setSea_Equal(), setLand_GreaterThan()
return found;
}
// maybe non public method here (basically option-setting method)
// e.g. protected void setSea_LikeSearch(String, LikeSearchOption)
// (ConditionOptionCall<LikeSearchOption> is public, LikeSearchOption is protected since 1.1.0)

// retry for callback way of option-setting method
if (option != null) { // e.g. LikeSearch
// option is always last argument (is implementation policy)
Class<?>[] retryArgType = null;
if (isLastArgConditionOptionExtended(LikeSearchOption.class, argTypes)) {
retryArgType = deriveRetryArgType(argTypes, LikeSearchOption.class);
} else if (isLastArgConditionOptionExtended(RangeOfOption.class, argTypes)) {
retryArgType = deriveRetryArgType(argTypes, RangeOfOption.class);
} else if (isLastArgConditionOptionExtended(FromToOption.class, argTypes)) {
retryArgType = deriveRetryArgType(argTypes, FromToOption.class);
}
if (retryArgType != null) {
found = findCQWholeMethod(declaringCQ, methodName, retryArgType);
if (found != null) {
return found;
}
}
}

// so next, searching all protected, private methods
// non-cache #for_now e.g. native method of classification
// (but cache of Class.class can be available)
return findCQWholeMethod(declaringCQ, methodName, argTypes);
}

protected boolean isLastArgConditionOptionExtended(Class<?> pureOptionType, Class<?>[] argTypes) {
if (argTypes.length == 0) {
return false;
}
final Class<?> lastType = argTypes[argTypes.length - 1]; // actual type from specified option instance
return pureOptionType.isAssignableFrom(lastType) && !pureOptionType.equals(lastType);
}

protected Class<?>[] deriveRetryArgType(Class<?>[] argTypes, Class<?> pureOptionType) {
final Class<?>[] retryArgTypes = new Class<?>[argTypes.length];
int index = 0;
for (Class<?> argType : argTypes) {
if (index == argTypes.length - 1) { // last loop
retryArgTypes[index] = pureOptionType;
} else {
retryArgTypes[index] = argType;
}
++index;
}
return retryArgTypes;
}

// -----------------------------------------------------
// Parameter Value
// ---------------
protected Object xfilterInvokeQueryParameterValue(String colName, String ckey, Object parameterValue) {
return parameterValue; // no filter as default (e.g. overridden by Scala to convert to immutable list)
}

// -----------------------------------------------------
// Exception
// ---------
protected void throwConditionInvokingColumnFindFailureException(String columnFlexibleName, String conditionKeyName,
Object conditionValue, ConditionOption conditionOption, RuntimeException cause) {
final String notice = "Failed to find the column in the table.";
Expand All @@ -235,29 +309,29 @@ protected void throwConditionInvokingValueConvertFailureException(String columnF
}

protected void throwConditionInvokingSetMethodNotFoundException(String columnFlexibleName, String conditionKeyName,
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] parameterTypes) {
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] argTypes) {
final String notice = "Not found the method for setting the condition.";
doThrowConditionInvokingFailureException(notice, columnFlexibleName, conditionKeyName, conditionValue, conditionOption, methodName,
parameterTypes, null);
argTypes, null);
}

protected void throwConditionInvokingDateFromToValueInvalidException(String columnFlexibleName, String conditionKeyName,
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] parameterTypes) {
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] argTypes) {
final String notice = "The conditionValue should be List that has 2 elements, fromDate and toDate.";
doThrowConditionInvokingFailureException(notice, columnFlexibleName, conditionKeyName, conditionValue, conditionOption, methodName,
parameterTypes, null);
argTypes, null);
}

protected void throwConditionInvokingSetReflectionFailureException(String columnFlexibleName, String conditionKeyName,
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] parameterTypes,
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] argTypes,
ReflectionFailureException cause) {
final String notice = "Failed to invoke the method for setting the condition.";
doThrowConditionInvokingFailureException(notice, columnFlexibleName, conditionKeyName, conditionValue, conditionOption, methodName,
parameterTypes, cause);
argTypes, cause);
}

protected void doThrowConditionInvokingFailureException(String notice, String columnFlexibleName, String conditionKeyName,
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] parameterTypes, RuntimeException cause) {
Object conditionValue, ConditionOption conditionOption, String methodName, Class<?>[] argTypes, RuntimeException cause) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice(notice);
br.addItem("Table");
Expand All @@ -273,13 +347,13 @@ protected void doThrowConditionInvokingFailureException(String notice, String co
br.addElement(conditionOption);
if (methodName != null) {
final StringBuilder sb = new StringBuilder();
if (parameterTypes != null) {
if (argTypes != null) {
int index = 0;
for (Class<?> parameterType : parameterTypes) {
for (Class<?> argType : argTypes) {
if (index > 0) {
sb.append(", ");
}
sb.append(DfTypeUtil.toClassTitle(parameterType));
sb.append(DfTypeUtil.toClassTitle(argType));
++index;
}
}
Expand All @@ -306,7 +380,7 @@ public void invokeOrderBy(String columnFlexibleName, boolean isAsc) {
final DBMeta dbmeta = _dbmetaProvider.provideDBMetaChecked(cq.asTableDbName());
final String columnCapPropName = initCap(dbmeta.findColumnInfo(flexibleName).getPropertyName());
final String methodName = "addOrderBy_" + columnCapPropName + "_" + ascDesc;
final Method method = xhelpGettingCQMethod(cq, methodName, (Class<?>[]) null);
final Method method = searchSimpleCQMethod(cq, methodName, (Class<?>[]) null);
if (method == null) {
throwConditionInvokingOrderMethodNotFoundException(columnFlexibleName, isAsc, methodName);
}
Expand Down Expand Up @@ -367,7 +441,7 @@ public ConditionQuery invokeForeignCQ(String foreignPropertyName) {
protected ConditionQuery doInvokeForeignCQ(ConditionQuery foreignCQ, String foreignPropertyName) {
assertStringNotNullAndNotTrimmedEmpty("foreignPropertyName", foreignPropertyName);
final String methodName = "query" + initCap(foreignPropertyName);
final Method method = xhelpGettingCQMethod(foreignCQ, methodName, (Class<?>[]) null);
final Method method = searchSimpleCQMethod(foreignCQ, methodName, (Class<?>[]) null);
if (method == null) {
throwConditionInvokingForeignQueryMethodNotFoundException(foreignCQ, foreignPropertyName, methodName);
return null; // unreachable
Expand Down Expand Up @@ -432,7 +506,7 @@ public boolean invokeHasForeignCQ(String foreignPropertyName) {
protected boolean doInvokeHasForeignCQ(ConditionQuery foreignCQ, String foreignPropertyName) {
assertStringNotNullAndNotTrimmedEmpty("foreignPropertyName", foreignPropertyName);
final String methodName = "hasConditionQuery" + initCap(foreignPropertyName);
final Method method = xhelpGettingCQMethod(foreignCQ, methodName, (Class<?>[]) null);
final Method method = searchSimpleCQMethod(foreignCQ, methodName, (Class<?>[]) null);
if (method == null) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Not found the method for determining a foreign condition query.");
Expand Down Expand Up @@ -460,6 +534,9 @@ protected boolean doInvokeHasForeignCQ(ConditionQuery foreignCQ, String foreignP
// ===================================================================================
// Assist Logic
// ============
// -----------------------------------------------------
// Property Name
// -------------
protected PropertyNameCQContainer xhelpExtractingPropertyNameCQContainer(String chainedColumnName) {
final String[] strings = chainedColumnName.split("\\.");
final int length = strings.length;
Expand Down Expand Up @@ -496,20 +573,27 @@ public ConditionQuery getConditionQuery() {
}
}

protected Method xhelpGettingCQMethod(ConditionQuery declaringCQ, String methodName, Class<?>[] argTypes) {
final Class<? extends ConditionQuery> cqType = declaringCQ.getClass();
final DfBeanDesc beanDesc = DfBeanDescFactory.getBeanDesc(cqType);
final Method found = beanDesc.getMethodNoException(methodName, argTypes); // public only
// -----------------------------------------------------
// Method Search
// -------------
protected Method searchSimpleCQMethod(ConditionQuery declaringCQ, String methodName, Class<?>[] argTypes) {
Method found = findCQPublicMethod(declaringCQ, methodName, argTypes);
if (found != null) { // e.g. simple set method (without option), setSea_Equal(), setLand_GreaterThan()
return found;
}
// maybe non public method here (option-setting method e.g. LikeSearch)
// ConditionOptionCall<LikeSearchOption> is public, LikeSearchOption is protected since 1.1.0
// so next, searching also protected, private
// non public so searching all protected, private methods
// non-cache #for_now (but cache of Class.class can be available)
return findCQWholeMethod(declaringCQ, methodName, argTypes);
}

// non-cache #for_now e.g. native method of classification or protected option method
// (but cache of Class.class can be available)
return DfReflectionUtil.getWholeMethod(cqType, methodName, argTypes);
protected Method findCQPublicMethod(ConditionQuery declaringCQ, String methodName, Class<?>[] argTypes) {
final Class<? extends ConditionQuery> cqType = declaringCQ.getClass();
final DfBeanDesc beanDesc = DfBeanDescFactory.getBeanDesc(cqType);
return beanDesc.getMethodNoException(methodName, argTypes); // public only
}

protected Method findCQWholeMethod(ConditionQuery declaringCQ, String methodName, Class<?>[] argTypes) {
return DfReflectionUtil.getWholeMethod(declaringCQ.getClass(), methodName, argTypes);
}

protected Object xhelpInvokingCQMethod(ConditionQuery cq, Method method, Object[] args) {
Expand Down

0 comments on commit f1ab906

Please sign in to comment.