All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.ymate.platform.persistence.jdbc.ISession Maven / Gradle / Ivy

There is a newer version: 2.1.2
Show newest version
/*
 * Copyright 2007-2017 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 net.ymate.platform.persistence.jdbc;

import net.ymate.platform.persistence.*;
import net.ymate.platform.persistence.base.IEntity;
import net.ymate.platform.persistence.base.ShardingList;
import net.ymate.platform.persistence.jdbc.base.IResultSetHandler;
import net.ymate.platform.persistence.jdbc.query.BatchSQL;
import net.ymate.platform.persistence.jdbc.query.EntitySQL;
import net.ymate.platform.persistence.jdbc.query.SQL;
import net.ymate.platform.persistence.jdbc.query.Where;

import java.io.Serializable;
import java.util.List;

/**
 * 数据库会话操作接口定义
 *
 * @author 刘镇 ([email protected]) on 2011-9-21 下午01:45:36
 * @version 1.0
 */
public interface ISession extends ISessionBase {

    /**
     * @return 获取数据连接对象
     */
    IConnectionHolder getConnectionHolder();

    /**
     * @param      指定结果集数据类型
     * @param sql     SQL语句对象
     * @param handler 结果集数据处理器
     * @return 执行SQL查询,返回全部结果数据
     * @throws Exception 可能产生的异常
     */
     IResultSet find(SQL sql, IResultSetHandler handler) throws Exception;

    /**
     * @param      指定结果集数据类型
     * @param sql     SQL语句对象
     * @param handler 结果集数据处理器
     * @param page    分页参数对象
     * @return 执行SQL分页查询(执行总记录数统计)
     * @throws Exception 可能产生的异常
     */
     IResultSet find(SQL sql, IResultSetHandler handler, Page page) throws Exception;

    /**
     * @param entity 实体对象
     * @param     指定结果集数据类型
     * @return 根据实体属性值执行SQL查询,返回全部结果数据
     * @throws Exception 可能产生的异常
     */
     IResultSet find(T entity) throws Exception;

     IResultSet find(T entity, IShardingable shardingable) throws Exception;

     IResultSet find(T entity, Page page) throws Exception;

     IResultSet find(T entity, Page page, IShardingable shardingable) throws Exception;

     IResultSet find(T entity, Fields filter) throws Exception;

     IResultSet find(T entity, Fields filter, IShardingable shardingable) throws Exception;

     IResultSet find(T entity, Fields filter, Page page) throws Exception;

     IResultSet find(T entity, Fields filter, Page page, IShardingable shardingable) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体查询对象
     * @return 根据实体执行SQL查询,返回全部结果数据
     * @throws Exception 可能产生的异常
     */
     IResultSet find(EntitySQL entity) throws Exception;

     IResultSet find(EntitySQL entity, IShardingable shardingable) throws Exception;

     IResultSet find(EntitySQL entity, Page page) throws Exception;

     IResultSet find(EntitySQL entity, Page page, IShardingable shardingable) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体对象
     * @param where  查询条件对象
     * @return 根据实体执行SQL查询,返回全部结果数据
     * @throws Exception 可能产生的异常
     */
     IResultSet find(EntitySQL entity, Where where) throws Exception;

     IResultSet find(EntitySQL entity, Where where, IShardingable shardingable) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体对象
     * @param where  查询条件对象
     * @param page   分页参数对象
     * @return 根据实体执行SQL分页查询
     * @throws Exception 可能产生的异常
     */
     IResultSet find(EntitySQL entity, Where where, Page page) throws Exception;

     IResultSet find(EntitySQL entity, Where where, Page page, IShardingable shardingable) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体查询对象
     * @param id     记录Id
     * @return 通过ID查找指定的实体对象
     * @throws Exception 可能产生的异常
     */
     T find(EntitySQL entity, Serializable id) throws Exception;

     T find(EntitySQL entity, Serializable id, IShardingable shardingable) throws Exception;

    /**
     * @param      指定结果集数据类型
     * @param sql     SQL语句对象
     * @param handler 结果集数据处理器
     * @return 执行SQL查询,返回结果集中第一条数据
     * @throws Exception 可能产生的异常
     */
     T findFirst(SQL sql, IResultSetHandler handler) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体查询对象
     * @param where  查询条件对象
     * @return 根据实体执行SQL查询,返回结果集中第一条数据
     * @throws Exception 可能产生的异常
     */
     T findFirst(EntitySQL entity, Where where) throws Exception;

     T findFirst(EntitySQL entity, Where where, IShardingable shardingable) throws Exception;

     T findFirst(EntitySQL entity) throws Exception;

     T findFirst(EntitySQL entity, IShardingable shardingable) throws Exception;

    /**
     * @param sql SQL语句对象
     * @return 执行SQL更新(如更新、插入和删除),返回此次更新影响的记录数
     * @throws Exception 可能产生的异常
     */
    int executeForUpdate(SQL sql) throws Exception;

    /**
     * @param sql 批量SQL更新语句
     * @return 执行SQL批量更新(如批更新、插入和删除),返回此次更新影响的记录数
     * @throws Exception 可能产生的异常
     */
    int[] executeForUpdate(BatchSQL sql) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体查询对象
     * @param filter 显示字段过滤集合
     * @return 根据实体执行SQL更新,返回更新后的实体对象,若影响记录数为0则返回null
     * @throws Exception 可能产生的异常
     */
     T update(T entity, Fields filter) throws Exception;

     T update(T entity, Fields filter, IShardingable shardingable) throws Exception;

    /**
     * @param       指定结果集数据类型
     * @param entities 实体查询对象集合
     * @param filter   显示字段过滤集合
     * @return 根据实体执行SQL批量更新,返回更新后的实体对象集合
     * @throws Exception 可能产生的异常
     */
     List update(List entities, Fields filter) throws Exception;

     List update(ShardingList entities, Fields filter) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体对象
     * @return 根据实体执行记录插入,返回插入后的实体对象,若影响记录数为0则返回null
     * @throws Exception 可能产生的异常
     */
     T insert(T entity) throws Exception;

     T insert(T entity, IShardingable shardingable) throws Exception;

     T insert(T entity, Fields filter) throws Exception;

     T insert(T entity, Fields filter, IShardingable shardingable) throws Exception;

    /**
     * @param       指定结果集数据类型
     * @param entities 实体对象集合
     * @return 根据实体执行记录批量插入,返回插入后的实体对象集合
     * @throws Exception 可能产生的异常
     */
     List insert(List entities) throws Exception;

     List insert(ShardingList entities) throws Exception;

     List insert(List entities, Fields filter) throws Exception;

     List insert(ShardingList entities, Fields filter) throws Exception;

    /**
     * @param     指定结果集数据类型
     * @param entity 实体对象
     * @return 根据实体执行记录删除,返回删除后的实体对象,若影响记录数为0则返回null
     * @throws Exception 可能产生的异常
     */
     T delete(T entity) throws Exception;

     T delete(T entity, IShardingable shardingable) throws Exception;

     int delete(Class entityClass, Serializable id) throws Exception;

     int delete(Class entityClass, Serializable id, IShardingable shardingable) throws Exception;

    /**
     * @param       指定结果集数据类型
     * @param entities 实体对象集合
     * @return 根据实体执行记录批量删除,返回删除后的实体对象集合
     * @throws Exception 可能产生的异常
     */
     List delete(List entities) throws Exception;

     List delete(ShardingList entities) throws Exception;

     int[] delete(Class entityClass, Serializable[] ids) throws Exception;

     int[] delete(Class entityClass, ShardingList ids) throws Exception;

    /**
     * @param          指定实体类型
     * @param entityClass 实体类对象
     * @param where       查询条件对象
     * @return 计算查询结果总记录数量
     * @throws Exception 可能产生的异常
     */
     long count(Class entityClass, Where where) throws Exception;

     long count(Class entityClass, Where where, IShardingable shardingable) throws Exception;

    /**
     * @param sql SQL语句对象
     * @return 计算查询结果总记录数量
     * @throws Exception 可能产生的异常
     */
    long count(SQL sql) throws Exception;
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy