/*
 * Copyright 2020-2030 码匠君<herodotus@aliyun.com>
 *
 * Dante Engine 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.
 *
 * Dante Engine 是 Dante Cloud 系统核心组件库，采用 APACHE LICENSE 2.0 开源协议，您在使用过程中，需要注意以下几点：
 *
 * 1. 请不要删除和修改根目录下的LICENSE文件。
 * 2. 请不要删除和修改 Dante Engine 源码头部的版权声明。
 * 3. 请保留源码和相关描述文件的项目出处，作者声明等。
 * 4. 分发源码时候，请注明软件出处 <https://gitee.com/dromara/dante-cloud>
 * 5. 在修改包名，模块名称，项目代码等时，请注明软件出处 <https://gitee.com/dromara/dante-cloud>
 * 6. 若您的项目无法满足以上几点，可申请商业授权
 */

package org.dromara.dante.data.jpa.service;

import org.dromara.dante.core.domain.BaseEntity;
import org.dromara.dante.data.commons.service.BasePageableService;
import org.dromara.dante.data.jpa.repository.BaseJpaRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;

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

/**
 * <p> Description : JPA “读” 操作基础 Service 定义 </p>
 *
 * @author : gengwei.zheng
 * @date : 2020/2/15 11:56
 */
public interface BaseJpaReadableService<E extends BaseEntity, ID extends Serializable> extends BasePageableService<E, ID> {

    /**
     * 获取 Repository
     *
     * @return {@link BaseJpaRepository}
     */
    BaseJpaRepository<E, ID> getRepository();

    /**
     * 查询全部数据
     *
     * @return 全部数据列表
     */
    @Override
    default List<E> findAll() {
        return getRepository().findAll();
    }

    /**
     * 查询分页数据
     *
     * @param pageable {@link Pageable}
     * @return 分页数据
     */
    @Override
    default Page<E> findByPage(Pageable pageable) {
        return getRepository().findAll(pageable);
    }

    /**
     * 根据 ID 查询数据
     *
     * @param id 数据 ID
     * @return 与ID对应的数据，如果不存在则返回空
     */
    @Override
    default Optional<E> findById(ID id) {
        return getRepository().findById(id);
    }

    /**
     * 查询多个 ID 对应的数据
     *
     * @param ids {@link Iterable}
     * @return 数据对象 {@link List}
     */
    @Override
    default List<E> findAllById(Iterable<ID> ids) {
        return getRepository().findAllById(ids);
    }

    /**
     * 查询一个实体
     *
     * @param specification {@link Specification}
     * @return 查询结果 {@link Optional}
     */
    default Optional<E> findOne(Specification<E> specification) {
        return getRepository().findOne(specification);
    }

    /**
     * 数据是否存在
     *
     * @param id 数据 ID
     * @return true 存在，false 不存在
     */
    @Override
    default boolean existsById(ID id) {
        return getRepository().existsById(id);
    }

    /**
     * 查询数量
     *
     * @return 数据数量
     */
    default long count() {
        return getRepository().count();
    }

    /**
     * 查询数量
     *
     * @param specification {@link Specification}
     * @return 数据数量
     */
    default long count(Specification<E> specification) {
        return getRepository().count(specification);
    }

    /**
     * 查询全部数据
     *
     * @param sort {@link Sort}
     * @return 已排序的全部数据列表
     */
    default List<E> findAll(Sort sort) {
        return getRepository().findAll(sort);
    }

    /**
     * 查询全部数据
     *
     * @param specification {@link Specification}
     * @return 全部数据列表
     */
    default List<E> findAll(Specification<E> specification) {
        return getRepository().findAll(specification);
    }

    /**
     * 查询全部数据
     *
     * @param specification {@link Specification}
     * @param sort          {@link Sort}
     * @return 全部数据列表
     */
    default List<E> findAll(Specification<E> specification, Sort sort) {
        return getRepository().findAll(specification, sort);
    }

    /**
     * 查询分页数据
     *
     * @param specification {@link Specification}
     * @param pageable      {@link Pageable}
     * @return 分页数据
     */
    default Page<E> findByPage(Specification<E> specification, Pageable pageable) {
        return getRepository().findAll(specification, pageable);
    }

    /**
     * 查询分页数据
     *
     * @param specification {@link Specification}
     * @param pageNumber    当前页码, 起始页码 0
     * @param pageSize      每页显示的数据条数
     * @return 分页数据
     */
    default Page<E> findByPage(Specification<E> specification, int pageNumber, int pageSize) {
        return getRepository().findAll(specification, PageRequest.of(pageNumber, pageSize));
    }

    /**
     * 查询分页数据
     *
     * @param pageNumber 当前页码, 起始页码 0
     * @param pageSize   每页显示的数据条数
     * @param direction  {@link Sort.Direction}
     * @return 分页数据
     */
    default Page<E> findByPage(int pageNumber, int pageSize, Sort.Direction direction) {
        return findByPage(PageRequest.of(pageNumber, pageSize, direction));
    }

    /**
     * 根据 ID 查询数据
     * <p>
     * 该方法更类似于懒加载，与事务绑定紧密。
     * <p>
     * 参见 <a href="https://springdoc.cn/spring-data-jpa-getreferencebyid-findbyid-methods/">...</a>
     *
     * @param id 数据 ID
     * @return 与ID对应的数据，如果不存在则返回空
     */
    default E getReferenceById(ID id) {
        return getRepository().getReferenceById(id);
    }

    /**
     * 数据是否存在
     *
     * @param specification {@link Specification}
     * @return true 存在，false 不存在
     */
    default boolean exists(Specification<E> specification) {
        return getRepository().exists(specification);
    }
}
