org.dbflute.cbean.coption.DerivedReferrerOption Maven / Gradle / Ivy
/*
* Copyright 2014-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.dbflute.cbean.coption;
import org.dbflute.cbean.ConditionBean;
import org.dbflute.cbean.chelper.HpCalcSpecification;
import org.dbflute.cbean.dream.SpecifiedColumn;
import org.dbflute.cbean.scoping.SpecifyQuery;
/**
* The option for DerivedReferrer.
* You can filter an aggregate function by scalar function filters.
* @author jflute
*/
public class DerivedReferrerOption extends FunctionFilterOption {
// ===================================================================================
// Attribute
// =========
/** Does it suppress the correlation condition on where clause? */
protected boolean _suppressCorrelation;
/** The specification object for calculation. (NullAllowed) */
protected HpCalcSpecification _calcSpecification;
// ===================================================================================
// Function Option
// ===============
/**
* Set the value for coalesce function.
* If you set string value and the derived column is date type, it converts it to a date object internally.
* For example, "2010-10-30 12:34:56.789", "2010/10/30" and so on ... are acceptable.
* @param coalesce An alternate value when group function returns null. (NullAllowed: if null, no coalesce)
* @return this. (NotNull)
*/
public DerivedReferrerOption coalesce(Object coalesce) {
doCoalesce(coalesce);
return this;
}
/**
* Round the specified part of the number.
* @param round Decimal digits or date format for round. (NullAllowed: if null, no round)
* @return this. (NotNull)
*/
public DerivedReferrerOption round(Object round) {
doRound(round);
return this;
}
/**
* Truncate the specified part of the number or date-time value.
* @param trunc Decimal digits or date option for trunc. (NullAllowed: if null, no trunc)
* @return this. (NotNull)
*/
public DerivedReferrerOption trunc(Object trunc) {
doTrunc(trunc);
return this;
}
// ===================================================================================
// Purpose Option
// ==============
// -----------------------------------------------------
// Truncate Date
// -------------
/**
* Truncate the month and day and time part of the date or the date-time value.
*
* e.g. 2012/12/31 01:50:46 -> 2012/01/01 00:00:00
*
* @return this. (NotNull)
*/
public DerivedReferrerOption truncMonth() {
doTruncMonth();
return this;
}
/**
* Truncate the day and time part of the date or the date-time value.
*
* e.g. 2012/12/31 01:50:46 -> 2012/12/01 00:00:00
*
* @return this. (NotNull)
*/
public DerivedReferrerOption truncDay() {
doTruncDay();
return this;
}
/**
* Truncate the time part of the date-time value.
*
* e.g. 2012/12/31 01:50:46 -> 2012/12/31 00:00:00
*
* @return this. (NotNull)
*/
public DerivedReferrerOption truncTime() {
doTruncTime();
return this;
}
// -----------------------------------------------------
// Add Date, Year
// --------------
/**
* Add years to the date or date-time value.
* @param addedYear The count of added years. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addYear(Integer addedYear) {
doAddYear(addedYear);
return this;
}
/**
* Add to the date or date-time value by the specified years column.
* Plus only, if you want minus, use substractYear() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID years)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addYear(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addYear(SpecifiedColumn addedColumn) {
doAddYear(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified years column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID years)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractYear(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractYear(SpecifiedColumn subtractedColumn) {
doAddYear(subtractedColumn, true);
return this;
}
// -----------------------------------------------------
// Add Date, Month
// ---------------
/**
* Add months to the date or date-time value.
* @param addedMonth The count of added months. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addMonth(Integer addedMonth) {
doAddMonth(addedMonth);
return this;
}
/**
* Add to the date or date-time value by the specified months column.
* Plus only, if you want minus, use substractMonth() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID months)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addMonth(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addMonth(SpecifiedColumn addedColumn) {
doAddMonth(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified months column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID months)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractMonth(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractMonth(SpecifiedColumn subtractedColumn) {
doAddMonth(subtractedColumn, true);
return this;
}
// -----------------------------------------------------
// Add Date, Day
// -------------
/**
* Add days to the date or date-time value.
* @param addedDay The count of added days. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addDay(Integer addedDay) {
doAddDay(addedDay);
return this;
}
/**
* Add to the date or date-time value by the specified days column.
* Plus only, if you want minus, use substractDay() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID days)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addDay(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addDay(SpecifiedColumn addedColumn) {
doAddDay(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified days column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID days)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractDay(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractDay(SpecifiedColumn subtractedColumn) {
doAddDay(subtractedColumn, true);
return this;
}
// -----------------------------------------------------
// Add Date, Hour
// --------------
/**
* Add hours to date-time value.
* @param addedHour The count of added hours. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addHour(Integer addedHour) {
doAddHour(addedHour);
return this;
}
/**
* Add to the date or date-time value by the specified hours column.
* Plus only, if you want minus, use substractHour() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID hours)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addHour(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addHour(SpecifiedColumn addedColumn) {
doAddHour(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified hours column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID hours)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractHour(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractHour(SpecifiedColumn subtractedColumn) {
doAddHour(subtractedColumn, true);
return this;
}
// -----------------------------------------------------
// Add Date, Minute
// ----------------
/**
* Add minutes to date-time value.
* @param addedMinute The count of added minutes. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addMinute(Integer addedMinute) {
doAddMinute(addedMinute);
return this;
}
/**
* Add to the date or date-time value by the specified minutes column.
* Plus only, if you want minus, use substractMinute() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID minutes)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addMinute(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addMinute(SpecifiedColumn addedColumn) {
doAddMinute(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified minutes column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID minutes)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractMinute(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractMinute(SpecifiedColumn subtractedColumn) {
doAddMinute(subtractedColumn, true);
return this;
}
// -----------------------------------------------------
// Add Date, Second
// ----------------
/**
* Add seconds to date-time value.
* @param addedSecond The count of added seconds. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addSecond(Integer addedSecond) {
doAddSecond(addedSecond);
return this;
}
/**
* Add to the date or date-time value by the specified seconds column.
* Plus only, if you want minus, use substractSecond() method.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) + (MEMBER_ID seconds)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .addSecond(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param addedColumn The added column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption addSecond(SpecifiedColumn addedColumn) {
doAddSecond(addedColumn);
return this;
}
/**
* Subtract to the date or date-time value by the specified seconds column.
*
* e.g. (Specify)DerivedReferrer: select max(PURCHASE_DATETIME) - (MEMBER_ID seconds)
* PurchaseCB cb = new PurchaseCB();
* cb.specify().derivedPurchaseList().max(new SubQuery<PurchaseCB>() {
* public void query(PurchaseCB subCB) {
* subCB.specify().columnPurchaseDatetime();
* }
* }, ..., new DerivedReferrerOption()
* .subtractSecond(cb.dreamCruiseCB().specify().columnMemberId()));
*
* @param subtractedColumn The subtracted column specified by your Dream. (NullAllowed: if null, no dateAdd)
* @return this. (NotNull)
*/
public DerivedReferrerOption subtractSecond(SpecifiedColumn subtractedColumn) {
doAddSecond(subtractedColumn, true);
return this;
}
// ===================================================================================
// Calculation Option
// ==================
/**
* Plus the specified column with the value. (+)
* @param plusValue The number value for plus. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption plus(Number plusValue) {
assertObjectNotNull("plusValue", plusValue);
getCalcSpecification().plus(plusValue);
return this;
}
/**
* Plus the specified column with the plus column. (+) {Dream Cruise}
*
* e.g. (Specify)DerivedReferrer: max(PURCHASE_PRICE) + SERVICE_POINT_COUNT
* MemberCB cb = new MemberCB();
* cb.specify().derivedPurchaseList().max(new SubQuery() {
* public void query(Purchase subCB) {
* cb.columnPurchasePrice();
* }
* }, ALIAS_..., new DerivedReferrerOption.plus(
* cb.dreamCruiseCB().specify().specify...().columnServicePointCount()));
*
* @param plusColumn The plus column specified by your Dream Cruise. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption plus(SpecifiedColumn plusColumn) {
assertObjectNotNull("plusColumn", plusColumn);
getCalcSpecification().plus(plusColumn);
return this;
}
/**
* Minus the specified column with the value. (-)
* @param minusValue The number value for minus. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption minus(Number minusValue) {
assertObjectNotNull("minusValue", minusValue);
getCalcSpecification().minus(minusValue);
return this;
}
/**
* Minus the specified column with the minus column. (-) {Dream Cruise}
*
* e.g. (Specify)DerivedReferrer: max(PURCHASE_PRICE) - SERVICE_POINT_COUNT
* MemberCB cb = new MemberCB();
* cb.specify().derivedPurchaseList().max(new SubQuery() {
* public void query(Purchase subCB) {
* cb.columnPurchasePrice();
* }
* }, ALIAS_..., new DerivedReferrerOption.minus(
* cb.dreamCruiseCB().specify().specify...().columnServicePointCount()));
*
* @param minusColumn The minus column specified by your Dream Cruise. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption minus(SpecifiedColumn minusColumn) {
assertObjectNotNull("minusColumn", minusColumn);
getCalcSpecification().minus(minusColumn);
return this;
}
/**
* Multiply the value to the specified column. (*)
* @param multiplyValue The number value for multiply. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption multiply(Number multiplyValue) {
assertObjectNotNull("multiplyValue", multiplyValue);
getCalcSpecification().multiply(multiplyValue);
return this;
}
/**
* Multiply the specified column with the multiply column. (*) {Dream Cruise}
*
* e.g. (Specify)DerivedReferrer: max(PURCHASE_PRICE) * SERVICE_POINT_COUNT
* MemberCB cb = new MemberCB();
* cb.specify().derivedPurchaseList().max(new SubQuery() {
* public void query(Purchase subCB) {
* cb.columnPurchasePrice();
* }
* }, ALIAS_..., new DerivedReferrerOption.multiply(
* cb.dreamCruiseCB().specify().specify...().columnServicePointCount()));
*
* @param multiplyColumn The multiply column specified by your Dream Cruise. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption multiply(SpecifiedColumn multiplyColumn) {
assertObjectNotNull("multiplyColumn", multiplyColumn);
getCalcSpecification().multiply(multiplyColumn);
return this;
}
/**
* Divide the specified column by the value. (/)
* @param divideValue The number value for divide. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption divide(Number divideValue) {
assertObjectNotNull("divideValue", divideValue);
getCalcSpecification().divide(divideValue);
return this;
}
/**
* Divide the specified column with the divide column. (/) {Dream Cruise}
*
* e.g. (Specify)DerivedReferrer: max(PURCHASE_PRICE) / SERVICE_POINT_COUNT
* MemberCB cb = new MemberCB();
* cb.specify().derivedPurchaseList().max(new SubQuery() {
* public void query(Purchase subCB) {
* cb.columnPurchasePrice();
* }
* }, ALIAS_..., new DerivedReferrerOption.divide(
* cb.dreamCruiseCB().specify().specify...().columnServicePointCount()));
*
* @param divideColumn The divide column specified by your Dream Cruise. (NotNull)
* @return this. (NotNull)
*/
public DerivedReferrerOption divide(SpecifiedColumn divideColumn) {
assertObjectNotNull("divideColumn", divideColumn);
getCalcSpecification().divide(divideColumn);
return this;
}
// -----------------------------------------------------
// CalcSpecification Handling
// --------------------------
protected HpCalcSpecification getCalcSpecification() {
if (_calcSpecification == null) {
_calcSpecification = createEmptyCalcSpecification();
}
return _calcSpecification;
}
protected HpCalcSpecification createEmptyCalcSpecification() {
return newCalcSpecification(createEmptySpecifyQuery());
}
protected SpecifyQuery createEmptySpecifyQuery() {
return new SpecifyQuery() {
public void specify(ConditionBean cb) { // as dummy
}
};
}
protected HpCalcSpecification newCalcSpecification(SpecifyQuery specifyQuery) {
return new HpCalcSpecification(specifyQuery);
}
public void xacceptBaseCB(ConditionBean cb) { // called after registered internally
if (_calcSpecification != null) {
_calcSpecification.specify(cb); // to (e.g.) find cipher manager
}
}
@Override
protected String processCalculation(String functionExp) {
if (_calcSpecification != null) {
return _calcSpecification.buildStatementToSpecifidName(functionExp);
}
return super.processCalculation(functionExp);
}
// ===================================================================================
// Adjustment Option
// =================
public boolean isSuppressCorrelation() {
return _suppressCorrelation;
}
/**
* Suppress the correlation condition on where clause (to be plain sub-query).
* @return this. (NotNull)
*/
public DerivedReferrerOption suppressCorrelation() {
_suppressCorrelation = true;
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy