app.myoss.cloud.mybatis.mapper.template.select.SelectPageMapper Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2018 https://github.com/myoss
 *
 * 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 app.myoss.cloud.mybatis.mapper.template.select;

import java.util.List;
import java.util.Map;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.SelectProvider;

import app.myoss.cloud.core.lang.dto.Order;
import app.myoss.cloud.mybatis.mapper.annotation.RegisterMapper;
import app.myoss.cloud.mybatis.mapper.template.select.impl.SelectMapperTemplate;

/**
 * 查询记录通用 Mapper 接口
 *
 * @param  实体类
 * @author Jerry.Chen
 * @since 2018年5月10日 上午10:25:43
 */
@RegisterMapper
public interface SelectPageMapper {
    /**
     * 根据条件分页查询匹配的实体对象
     *
     * @param condition 匹配的条件
     * @param offset 记录行的偏移量（SELECT * FROM table LIMIT 0,10; // 检索记录行 1-10）
     * @param pageSize 分页的条数
     * @param orders 排序字段
     * @return 匹配的实体对象
     * @see SelectMapperTemplate#selectPage
     */
    @SelectProvider(type = SelectMapperTemplate.class, method = "dynamicSql")
    List selectPage(@Param("condition") T condition, @Param("offset") int offset, @Param("pageSize") int pageSize,
                       @Param("orders") List orders);

    /**
     * 根据条件分页查询匹配的实体对象
     *
     * @param condition 匹配的条件
     * @param extraCondition 扩展查询条件，需要自定义
     * @param offset 记录行的偏移量（SELECT * FROM table LIMIT 0,10; // 检索记录行 1-10）
     * @param pageSize 分页的条数
     * @param orders 排序字段
     * @return 匹配的实体对象
     * @see SelectMapperTemplate#selectPage2
     */
    @SelectProvider(type = SelectMapperTemplate.class, method = "dynamicSql")
    List selectPage2(@Param("condition") T condition, @Param("extraCondition") Map extraCondition,
                        @Param("offset") int offset, @Param("pageSize") int pageSize,
                        @Param("orders") List orders);
}