org.dbflute.cbean.dream.ColumnCalculator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
There is a newer version: 1.2.8
/*
 * Copyright 2014-2019 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.dream;

import org.dbflute.cbean.coption.ColumnConversionOption;
import org.dbflute.cbean.coption.FunctionFilterOptionCall;

/**
 * The calculator interface of column, also providing one of DreamCruise.
 * @author jflute
 */
public interface ColumnCalculator {

    // ===================================================================================
    //                                                                         Calculation
    //                                                                         ===========
    /**
     * Plus the specified column with the value. (+)
     * @param plusValue The number value for plus. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator plus(Number plusValue);

    /**
     * Plus the specified column with the plus column. (+) {Dream Cruise}
     *      * e.g. ManualOrder: order by PURCHASE_PRICE + PURCHASE_COUNT
     *  cb.query().addOrderBy_PurchasePrice_Asc().withManualOrder(op -> {
     *      op.plus(cb.dreamCruiseCB().specify().columnPurchaseCount());
     *  });
     * 
     * e.g. ColumnQuery: ... > PURCHASE_PRICE + PURCHASE_COUNT
     *  cb.columnQuery(colCB -> {
     *      cb.column...();
     *  }).greaterThan(colCB -> {
     *      cb.columnPurchasePrice();
     *  }).plus(cb.dreamCruiseCB().specify().columnPurchaseCount());
     * 
     * @param plusColumn The plus column specified by your Dream Cruise. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator plus(SpecifiedColumn plusColumn);

    /**
     * Minus the specified column with the value. (-)
     * @param minusValue The number value for minus. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator minus(Number minusValue);

    /**
     * Minus the specified column with the minus column. (-) {Dream Cruise}
     *      * e.g. ManualOrder: order by PURCHASE_PRICE - PURCHASE_COUNT
     *  cb.query().addOrderBy_PurchasePrice_Asc().withManualOrder(op -> {
     *      op.minus(cb.dreamCruiseCB().specify().columnPurchaseCount());
     *  });
     * 
     * e.g. ColumnQuery: ... > PURCHASE_PRICE - PURCHASE_COUNT
     *  cb.columnQuery(colCB -> {
     *      cb.column...();
     *  }).greaterThan(colCB -> {
     *      cb.columnPurchasePrice();
     *  }).minus(cb.dreamCruiseCB().specify().columnPurchaseCount());
     * 
     * @param minusColumn The minus column specified by your Dream Cruise. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator minus(SpecifiedColumn minusColumn);

    /**
     * Multiply the value to the specified column. (*)
     * @param multiplyValue The number value for multiply. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator multiply(Number multiplyValue);

    /**
     * Multiply the specified column with the multiply column. (*) {Dream Cruise}
     *      * e.g. ManualOrder: order by PURCHASE_PRICE * PURCHASE_COUNT
     *  cb.query().addOrderBy_PurchasePrice_Asc().withManualOrder(op -> {
     *      op.multiply(cb.dreamCruiseCB().specify().columnPurchaseCount());
     *  });
     * 
     * e.g. ColumnQuery: ... > PURCHASE_PRICE * PURCHASE_COUNT
     *  cb.columnQuery(colCB -> {
     *      cb.column...();
     *  }).greaterThan(colCB -> {
     *      cb.columnPurchasePrice();
     *  }).multiply(cb.dreamCruiseCB().specify().columnPurchaseCount());
     * 
     * @param multiplyColumn The multiply column specified by your Dream Cruise. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator multiply(SpecifiedColumn multiplyColumn);

    /**
     * Divide the specified column by the value. (/)
     * @param divideValue The number value for divide. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator divide(Number divideValue);

    /**
     * Divide the specified column with the divide column. (/) {Dream Cruise}
     *      * e.g. ManualOrder: order by PURCHASE_PRICE / PURCHASE_COUNT
     *  cb.query().addOrderBy_PurchasePrice_Asc().withManualOrder(op -> {
     *      op.divide(cb.dreamCruiseCB().specify().columnPurchaseCount());
     *  });
     * 
     * e.g. ColumnQuery: ... > PURCHASE_PRICE / PURCHASE_COUNT
     *  cb.columnQuery(colCB -> {
     *      cb.column...();
     *  }).greaterThan(colCB -> {
     *      cb.columnPurchasePrice();
     *  }).divide(cb.dreamCruiseCB().specify().columnPurchaseCount());
     * 
     * @param divideColumn The divide column specified by your Dream Cruise. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator divide(SpecifiedColumn divideColumn);

    /**
     * Convert the value of right column by function.
     *      * ...).convert(op -> op.addDay(8).truncTime());
     * 
     * @param opLambda The callback for conversion option of column. (NotNull)
     * @return this. (NotNull)
     */
    ColumnCalculator convert(FunctionFilterOptionCall opLambda);

    // ===================================================================================
    //                                                                     Left/Right Mode
    //                                                                     ===============
    /**
     * To be for left column.
     * @return this. (NotNull)
     */
    ColumnCalculator left();

    /**
     * To be for right column. (default)

     * It also means main process internally.
     * @return this. (NotNull)
     */
    ColumnCalculator right();
}