Dialect.java

/*
 * Copyright 2004-2015 the Seasar Foundation and the Others.
 *
 * 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.seasar.extension.jdbc.it.util;

/**
 * 方言です。
 * 
 * @author taedium
 */
public interface Dialect {

    /**
     * SQLブロックの区切り文字を返します。
     * 
     * @return SQLブロックの区切り文字
     */
    String getSqlBlockDelimiter();

    /**
     * SQLブロックのコンテキストを返します。
     * 
     * @return
     */
    SqlBlockContext createSqlBlockContext();

    /**
     * SQLブロックのコンテキストです。
     * 
     * @author taedium
     */
    public static interface SqlBlockContext {

        /**
         * SQLのキーワードを追加します。
         * 
         * @param keyword
         */
        void addKeyword(String keyword);

        /**
         * SQLブロックの内側の場合{@code true}を返します。
         * 
         * @return SQLブロックの内側の場合{@code true}
         */
        boolean isInSqlBlock();
    }
}