org.dbflute.cbean.coption.ConditionOption 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-2023 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 java.util.List;

import org.dbflute.cbean.cipher.GearedCipherManager;
import org.dbflute.cbean.dream.SpecifiedColumn;
import org.dbflute.cbean.sqlclause.query.QueryClauseArranger;
import org.dbflute.dbway.topic.ExtensionOperand;
import org.dbflute.dbway.topic.OnQueryStringConnector;

/**
 * The interface of condition-option.
 * @author jflute
 * @author h-funaki added isNullCompoundedAsEmpty()
 */
public interface ConditionOption {

    // ===================================================================================
    //                                                                         Rear Option
    //                                                                         ===========
    /**
     * Get the string expression of rear option.
     * @return The string for rear option. (NotNull, EmptyAllowed)
     */
    String getRearOption();

    // ===================================================================================
    //                                                                     Compound Column
    //                                                                     ===============
    /**
     * Does the option have compound columns?
     * @return The determination, true or false.
     */
    boolean hasCompoundColumn();

    /**
     * Get the list of compound columns.
     * @return The read-only list of specified column. (NotNull, EmptyAllowed)
     */
    List getCompoundColumnList();

    /**
     * Does the option treat null as empty when compounding columns?
     * @return The determination, true or false.
     */
    default boolean isNullCompoundedAsEmpty() {
        return false;
    };

    /**
     * Does the option have string connector basically for compound columns?
     * @return The determination, true or false.
     */
    boolean hasStringConnector();

    /**
     * Get the string connector basically for compound columns?
     * @return The interface providing string connector on query. (NullAllowed: if null, no compound anyway)
     */
    OnQueryStringConnector getStringConnector();

    // ===================================================================================
    //                                                                   Clause Adjustment
    //                                                                   =================
    /**
     * Get the extension operand. (e.g. use "ilike" instead of "like")
     * @return The interface providing operand. (NullAllowed: if null, it means no extension)
     */
    ExtensionOperand getExtensionOperand();

    /**
     * Get the arranger of query clause. (e.g. use "collate")
     * @return The interface providing arranged clause. (NullAllowed: if null, it means no arrangement)
     */
    QueryClauseArranger getWhereClauseArranger();

    /**
     * Get the manager of geared cipher. (basically for compound columns)
     * @return The manager of geared cipher. (NullAllowed: if null, it means no cipher)
     */
    GearedCipherManager getGearedCipherManager();
}