com.github.youyinnn.youdbutils.dao.interfaces.SqlExecutor Maven / Gradle / Ivy

Go to download
package com.github.youyinnn.youdbutils.dao.interfaces;

import com.github.youyinnn.youdbutils.exceptions.NoneffectiveUpdateExecuteException;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;

/**
 * SqlExecutor类提供了一系列操作让用户执行基本的sql语句.
 *
 * 对于更新操作:
 *  1.我们可以直接传入原生的sql语句.
 *  2.我们可以传入带占位符的Update型sql语句,以及包含更新值的填充列表,
 *  和条件值的填充列表,且条件列表允许为空.
 *  3.我们可以只传入model的名字,需要更新的字段以及新值组成的键值对,
 *  需要定位更新记录的条件字段以及条件值组成的键值对,连接条件的连词.
 *
 * 对于插入操作:
 *  1.原生sql.
 *  2.带占位符的sql,以及包含更新值的填充列表.
 *  3.只传入model的名字,需要插入的字段名和值组成的键值对.
 *
 *  删除/查询操作同理.
 *
 * @author youyinnn
 */
public interface SqlExecutor {

    /**
     * 使用statement执行正常的update操作
     *
     * @param sql 一个完整的update类型的sql语句
     * @return 更新操作影响到的记录数 int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executeStatementUpdate(String sql) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行update操作
     *
     * @param sql             一个完整的带有占位符的update类型的sql语句
     * @param newFieldValues  更新值的填充列表
     * @param conditionValues 条件值的填充列表 允许为空
     * @return 更新操作影响到的记录数 int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementUpdate(String sql, ArrayList newFieldValues, ArrayList conditionValues) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行update操作
     *
     * @param modelName         需要更新的model类名 我们使用这个来对应数据表
     * @param newFieldValuesMap 需要更新的字段以及新值组成的键值对
     * @param conditionsMap     需要定位更新记录的条件字段以及条件值组成的键值对
     * @param separateMark      连接条件的连词
     * @return 更新操作影响到的记录数 int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementUpdate(String modelName, HashMap newFieldValuesMap, HashMap conditionsMap,String separateMark) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用Statement执行insert操作
     *
     * @param sql the sql
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executeStatementInsert(String sql) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行insert操作
     *
     * @param sql            the sql
     * @param newFieldValues 填充的新值列表
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementInsert(String sql, ArrayList newFieldValues) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行insert操作
     *
     * @param modelName         需要插入的model类名 我们使用这个来对应数据表
     * @param newFieldValuesMap 填充的新值列表
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementInsert(String modelName, HashMap newFieldValuesMap) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用Statement执行delete操作
     *
     * @param sql the sql
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executeStatementDelete(String sql) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行delete操作
     *
     * @param sql             the sql
     * @param conditionValues 要填充的条件值列表
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementDelete(String sql, ArrayList conditionValues) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用PreparedStatement执行delete操作
     *
     * @param modelName     需要删除的model类名 我们使用这个来对应数据表
     * @param conditionsMap 需要定位删除记录的条件字段以及条件值组成的键值对
     * @param separateMark  连接条件的连词
     * @return the int
     * @throws NoneffectiveUpdateExecuteException the noneffective update execute exception
     */
    int executePreparedStatementDelete(String modelName, HashMap conditionsMap,String separateMark) throws NoneffectiveUpdateExecuteException;

    /**
     * 使用Statement执行query操作
     *
     * @param sql 一个完整的select类型的sql语句
     * @return 查询结果集转化出的Model类列表 result set
     * @throws SQLException the sql exceptions
     */
    ResultSet executeStatementQuery(String sql) throws SQLException;

    /**
     * 使用PreparedStatement执行query操作
     *
     * @param sql             一个完整的带有占位符的select类型的sql语句
     * @param conditionValues 要填充的条件值列表
     * @return 查询结果集转化出的Model类列表 result set
     * @throws SQLException the sql exceptions
     */
    ResultSet executePreparedStatementQuery(String sql, ArrayList conditionValues) throws SQLException;

    /**
     * 使用PreparedStatement执行query操作
     *
     * @param modelName      需要查询的model类名 我们使用这个来对应数据表
     * @param queryFieldList 需要查询的字段列名
     * @param conditionMap   需要定位查询记录的条件字段以及条件值组成的键值对
     * @param separateMark   连接条件的连词
     * @return the result set
     * @throws SQLException the sql exceptions
     */
    ResultSet executePreparedStatementQuery(String modelName, ArrayList queryFieldList, HashMap conditionMap,String separateMark) throws SQLException;


}