org.dbflute.cbean.chelper.HpCalcStatement 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.chelper;

import java.util.Map;

/**
 * @author jflute
 */
public interface HpCalcStatement {

    /**
     * Build the calculation statement of the column as SQL name. 

     * e.g. called by Update Calculation
     * @param aliasName The alias name of the target column, containing dot mark. (NullAllowed)
     * @return The statement that has calculation. (NullAllowed: if null, means the column is not specified)
     */
    String buildStatementAsSqlName(String aliasName);

    /**
     * Build the calculation statement to the specified column. 

     * e.g. called by ColumnQuery Calculation
     * @param columnExp The expression of the column. (NotNull)
     * @return The statement that has calculation. (NullAllowed: if null, means the column is not specified)
     */
    String buildStatementToSpecifidName(String columnExp);

    /**
     * Build the calculation statement to the specified column. 

     * No cipher here because the column has already been handled cipher. 

     * e.g. called by ManualOrder Calculation
     * @param columnExp The expression of the column. (NotNull)
     * @param columnAliasMap The map of column alias. (NotNull)
     * @return The statement that has calculation. (NullAllowed: if null, means the column is not specified)
     */
    String buildStatementToSpecifidName(String columnExp, Map columnAliasMap);
}