org.seasar.extension.jdbc.JdbcManager Maven / Gradle / Ivy
/*
* 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;
import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import org.seasar.extension.jdbc.annotation.InOut;
import org.seasar.extension.jdbc.annotation.Out;
import org.seasar.extension.jdbc.parameter.Parameter;
/**
* JDBCによるSQLの実行を管理するインターフェースです。
*
* @author higa
*
*/
public interface JdbcManager {
/**
* 自動検索を作成します。
*
* @param
* 戻り値のベースの型です。
* @param baseClass
* ベースクラス
* @return 自動検索
*/
AutoSelect from(Class baseClass);
/**
* SQL検索を作成します。
*
* @param
* 戻り値のベースの型です。
* @param baseClass
* ベースクラス
* @param sql
* SQL
* @param params
* パラメータの配列
*
* パラメータの配列の要素が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータの配列の要素が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQL検索
* @see SqlSelect
*/
SqlSelect selectBySql(Class baseClass, String sql,
Object... params);
/**
* {@link #selectBySql}で実行可能なSQLが返す結果セットの行数を返します。
*
* このメソッドは通常、select count(*) from (SQL)を
* 実行した結果を返します。
*
*
* @param sql
* SQL
* @param params
* パラメータの配列
*
* パラメータの配列の要素が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータの配列の要素が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLが返す結果セットの行数
* @see DbmsDialect#convertGetCountSql(String)
*/
long getCountBySql(String sql, Object... params);
/**
* SQLファイル検索を作成します。
*
* @param
* 戻り値のベースの型です。
* @param baseClass
* ベースクラス
* @param path
* SQLファイルのパス
* @return SQLファイル検索
* @see #selectBySqlFile(Class, String, Object)
*/
SqlFileSelect selectBySqlFile(Class baseClass, String path);
/**
* SQLファイル検索を作成します。
*
* @param
* 戻り値のベースの型です。
* @param baseClass
* ベースクラス
* @param path
* SQLファイルのパス
* @param parameter
*
* パラメータ。
*
*
* パラメータが1つしかない場合は、値を直接指定します。 パラメータが複数ある場合は、JavaBeansを作って、
* プロパティ名をSQLファイルのバインド変数名とあわせます。
* JavaBeansはpublicフィールドで定義することもできます。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLファイル検索
* @see SqlFileSelect
* @see Parameter
*/
SqlFileSelect selectBySqlFile(Class baseClass, String path,
Object parameter);
/**
* {@link #selectBySql}で実行可能なSQLが返す結果セットの行数を返します。
*
* このメソッドは通常、select count(*) from (SQL)を
* 実行した結果を返します。
*
*
* @param path
* SQLファイルのパス
* @return SQLが返す結果セットの行数
* @see DbmsDialect#convertGetCountSql(String)
*/
long getCountBySqlFile(String path);
/**
* {@link #selectBySql}で実行可能なSQLが返す結果セットの行数を返します。
*
* このメソッドは通常、select count(*) from (SQL)を
* 実行した結果を返します。
*
*
* @param path
* SQLファイルのパス
* @param parameter
*
* パラメータ。
*
*
* パラメータが1つしかない場合は、値を直接指定します。 パラメータが複数ある場合は、JavaBeansを作って、
* プロパティ名をSQLファイルのバインド変数名とあわせます。
* JavaBeansはpublicフィールドで定義することもできます。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLが返す結果セットの行数
* @see DbmsDialect#convertGetCountSql(String)
*/
long getCountBySqlFile(String path, Object parameter);
/**
* 自動挿入を作成します。
*
* @param
* 挿入するエンティティの型です。
* @param entity
* エンティティ
* @return 自動挿入
*/
AutoInsert insert(T entity);
/**
* 自動バッチ挿入を作成します。
*
* @param
* 挿入するエンティティの型です。
* @param entities
* エンティティの並び
* @return 自動バッチ挿入
*/
AutoBatchInsert insertBatch(@SuppressWarnings("unchecked") T... entities);
/**
* 自動バッチ挿入を作成します。
*
* @param
* 挿入するエンティティの型です。
* @param entities
* エンティティのリスト
* @return 自動バッチ挿入
*/
AutoBatchInsert insertBatch(List entities);
/**
* 自動更新を作成します。
*
* @param
* 更新するエンティティの型です。
* @param entity
* エンティティ
* @return 自動更新
*/
AutoUpdate update(T entity);
/**
* 自動バッチ更新を作成します。
*
* @param
* 更新するエンティティの型です。
* @param entities
* エンティティの並び
* @return 自動バッチ更新
*/
AutoBatchUpdate updateBatch(@SuppressWarnings("unchecked") T... entities);
/**
* 自動バッチ更新を作成します。
*
* @param
* 更新するエンティティの型です。
* @param entities
* エンティティのリスト
* @return 自動バッチ更新
*/
AutoBatchUpdate updateBatch(List entities);
/**
* SQL更新を返します。
*
* @param sql
* SQL
* @param paramClasses
* パラメータのクラスの配列
* @return SQL更新
*/
SqlUpdate updateBySql(String sql, Class... paramClasses);
/**
* SQLバッチ更新を返します。
*
* @param sql
* SQL
* @param paramClasses
* パラメータのクラスの配列
* @return SQLバッチ更新
*/
SqlBatchUpdate updateBatchBySql(String sql, Class... paramClasses);
/**
* SQLファイル更新を作成します。
*
* @param path
* SQLファイルのパス
* @return SQLファイル更新
* @see #updateBySqlFile(String, Object)
*/
SqlFileUpdate updateBySqlFile(String path);
/**
* SQLファイル更新を作成します。
*
* @param path
* SQLファイルのパス
* @param parameter
*
* パラメータ。
*
*
* パラメータが1つで値がnullではない場合は、値を直接指定します。
* それ以外の場合は、JavaBeansを作って、 プロパティ名をSQLファイルのバインド変数名とあわせます。
* JavaBeansはpublicフィールドで定義することもできます。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLファイル更新
* @see SqlFileUpdate
*/
SqlFileUpdate updateBySqlFile(String path, Object parameter);
/**
* SQLバッチファイル更新を作成します。
*
* @param
* パラメータの型です。
* @param path
* SQLファイルのパス
* @param params
*
* パラメータの配列。
*
*
* パラメータが1つで値がnullにならない場合は、 値の可変長引数を指定します。
* それ以外の場合は、JavaBeansを作って、
* プロパティ名をSQLファイルのバインド変数名とあわせ、JavaBeansの可変長引数を指定します。
* JavaBeansはpublicフィールドで定義することもできます。
*
* @return SQLバッチファイル更新
* @see SqlFileBatchUpdate
*/
SqlFileBatchUpdate updateBatchBySqlFile(String path, @SuppressWarnings("unchecked") T... params);
/**
* SQLバッチファイル更新を作成します。
*
* @param
* パラメータの型です。
* @param path
* SQLファイルのパス
* @param params
*
* パラメータのリスト。
*
*
* パラメータが1つで値がnullにならない場合は、 値のリストを指定します。
* それ以外の場合は、JavaBeansを作って、
* プロパティ名をSQLファイルのバインド変数名とあわせ、JavaBeansのリストを指定します。
* JavaBeansはpublicフィールドで定義することもできます。
*
* @return SQLバッチファイル更新
* @see SqlFileBatchUpdate
*/
SqlFileBatchUpdate updateBatchBySqlFile(String path, List params);
/**
* 自動削除を作成します。
*
* @param
* 削除するエンティティの型です。
* @param entity
* エンティティ
* @return 自動更新
*/
AutoDelete delete(T entity);
/**
* 自動バッチ削除を作成します。
*
* @param
* 削除するエンティティの型です。
* @param entities
* エンティティの並び
* @return 自動バッチ削除
*/
AutoBatchDelete deleteBatch(@SuppressWarnings("unchecked") T... entities);
/**
* 自動バッチ削除を作成します。
*
* @param
* 削除するエンティティの型です。
* @param entities
* エンティティのリスト
* @return 自動バッチ更新
*/
AutoBatchDelete deleteBatch(List entities);
/**
* 自動プロシージャ呼び出しを返します。
*
* @param procedureName
* 呼び出すストアドプロシージャの名前
* @return 自動プロシージャ呼び出し
* @see #call(String, Object)
*/
AutoProcedureCall call(String procedureName);
/**
* 自動プロシージャ呼び出しを返します。
*
* @param procedureName
* 呼び出すストアドプロシージャの名前
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
*
* プロシージャを呼び出すバインド変数の順番にJavaBeansのフィールドを定義します。 OUTパラメータのフィールドには{@link Out}アノテーションを指定します。
* IN OUTパラメータのフィールドには{@link InOut}アノテーションを指定します。
* いずれのアノテーションも付けられていない場合は、INパラメータになります。
*
*
* プロシージャが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return 自動プロシージャ呼び出し
* @see Parameter
*/
AutoProcedureCall call(String procedureName, Object parameter);
/**
* SQLプロシージャ呼び出しを返します。
*
* @param sql
* SQL
* @return SQLプロシージャ呼び出し
* @see #callBySql(String, Object)
*/
SqlProcedureCall callBySql(String sql);
/**
* SQLプロシージャ呼び出しを返します。
*
* @param sql
* SQL
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
*
* プロシージャを呼び出すバインド変数の順番にJavaBeansのフィールドを定義します。 OUTパラメータのフィールドには{@link Out}アノテーションを指定します。
* IN OUTパラメータのフィールドには{@link InOut}アノテーションを指定します。
* いずれのアノテーションも付けられていない場合は、INパラメータになります。
*
*
* プロシージャが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLプロシージャ呼び出し
*/
SqlProcedureCall callBySql(String sql, Object parameter);
/**
* SQLファイルプロシージャ呼び出しを返します。
*
* @param path
* SQLファイルのパス
* @return SQLファイルプロシージャ呼び出し
* @see #callBySqlFile(String, Object)
*/
SqlFileProcedureCall callBySqlFile(String path);
/**
* SQLファイルプロシージャ呼び出しを返します。
*
* @param path
* SQLファイルのパス
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
* プロシージャを呼び出すパラメータの順番にJavaBeansのフィールドを定義します。
*
* - フィールド名が_OUTで終わっている場合
OUTパラメータになります。
* - フィールド名が_IN_OUTで終わっている場合
IN OUTパラメータになります。
* - フィールド名が_INで終わっている場合
INパラメータになります。
* - フィールド名が_OUT、_IN_OUT、_INで終わっていない場合は、
INパラメータになります。
*
*
* プロシージャが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @return SQLファイルプロシージャ呼び出し
* @see Parameter
*/
SqlFileProcedureCall callBySqlFile(String path, Object parameter);
/**
* 自動ファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param functionName
* 呼び出すストアドファンクションの名前
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return 自動ファンクション呼び出し
* @see #call(Class, String, Object)
*/
AutoFunctionCall call(Class resultClass, String functionName);
/**
* 自動ファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param functionName
* 呼び出すストアドファンクションの名前
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
*
* ファンクションを呼び出すバインド変数の順番にJavaBeansのフィールドを定義します。 OUTパラメータのフィールドには{@link Out}アノテーションを指定します。
* IN OUTパラメータのフィールドには{@link InOut}アノテーションを指定します。
* いずれのアノテーションも付けられていない場合は、INパラメータになります。
*
*
* ファンクションが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return 自動ファンクション呼び出し
* @see Parameter
*/
AutoFunctionCall call(Class resultClass, String functionName,
Object parameter);
/**
* SQLファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param sql
* SQL
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return SQLファンクション呼び出し
* @see #callBySql(Class, String, Object)
*/
SqlFunctionCall callBySql(Class resultClass, String sql);
/**
* SQLファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param sql
* SQL
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
*
* ファンクションを呼び出すバインド変数の順番にJavaBeansのフィールドを定義します。 OUTパラメータのフィールドには{@link Out}アノテーションを指定します。
* IN OUTパラメータのフィールドには{@link InOut}アノテーションを指定します。
* いずれのアノテーションも付けられていない場合は、INパラメータになります。
*
*
* ファンクションが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return SQLファンクション呼び出し
* @see Parameter
*/
SqlFunctionCall callBySql(Class resultClass, String sql,
Object parameter);
/**
* SQLファイルファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param path
* SQLファイルのパス
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return SQLファイルファンクション呼び出し
* @see #call(Class, String, Object)
*/
SqlFileFunctionCall callBySqlFile(Class resultClass, String path);
/**
* SQLファイルファンクション呼び出しを返します。
*
* @param resultClass
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @param path
* SQLファイルのパス
* @param parameter
*
* パラメータです。
*
*
* INパラメータが1つで値がnullにならない場合は、数値や文字列などを直接指定します。
* それ以外は、JavaBeansを指定します。
*
*
* ファンクションを呼び出すバインド変数の順番にJavaBeansのフィールドを定義します。 OUTパラメータのフィールドには{@link Out}アノテーションを指定します。
* IN OUTパラメータのフィールドには{@link InOut}アノテーションを指定します。
* いずれのアノテーションも付けられていない場合は、INパラメータになります。
*
*
* ファンクションが結果セットを返す場合、フィールドの型はList<レコードの型>にします。
*
*
* JavaBeansの場合、継承もとのクラスのフィールドは認識しません。
*
*
* パラメータが1つで型が{@link Date}、{@link Calendar}のいずれか場合、{@link Parameter}に定義されたメソッドによりパラメータの時制を指定できます。
*
*
* パラメータが1つで型が{@link String}、byte[]、{@link Serializable}のいずれかの場合、{@link Parameter}に定義されたメソッドによりパラメータをラージオブジェクトとして扱えます。
*
* @param
* ファンクションの戻り値の型。ファンクションの戻り値が結果セットの場合はリストの要素のクラス
* @return SQLファイルファンクション呼び出し
* @see Parameter
*/
SqlFileFunctionCall callBySqlFile(Class resultClass, String path,
Object parameter);
}