package com.yice.webadmin.app.service;

import com.yice.common.core.base.service.IBaseService;
import com.yice.webadmin.app.model.DatasetDetail;
import com.yice.webadmin.app.model.DatasetVersion;

import java.io.IOException;
import java.util.List;

/**
 * 数据集版本数据操作服务接口。
 *
 * @author linking
 * @date 2023-04-13
 */
public interface DatasetVersionService extends IBaseService<DatasetVersion, Long> {

    /**
     * 保存新增对象。
     *
     * @param datasetVersion 新增对象。
     * @return 返回新增对象。
     */
    DatasetVersion saveNew(DatasetVersion datasetVersion);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。
     *
     * @param datasetVersionList 新增对象列表。
     */
    void saveNewBatch(List<DatasetVersion> datasetVersionList);

    /**
     * 存储到python数据集中并进行更新操作
     * @param versionName
     * @throws IOException 异常操作
     */
    void saveDatasetInfo(String versionName) throws IOException;

    /**
     * 写入到mongodb中
     * @param bytes 字节
     * @param originalFilename 导入文件名称
     * @param versionId 版本标识
     */
    void writeDatasetFile(byte[] bytes, String originalFilename, Long versionId);

    /**
     * 更新数据对象。
     *
     * @param datasetVersion         更新的对象。
     * @param originalDatasetVersion 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(DatasetVersion datasetVersion, DatasetVersion originalDatasetVersion);

    /**
     * 更新数据对象。
     *
     * @param datasetVersion         更新的对象。
     * @return 成功返回true，否则false。
     */
    boolean update(DatasetVersion datasetVersion);

    /**
     * 删除指定数据。
     *
     * @param versionId 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long versionId);

    /**
     * 当前服务的支持表为从表，根据主表的关联Id，删除一对多的从表数据。
     *
     * @param datasetId 从表关联字段。
     * @return 删除数量。
     */
    int removeByDatasetId(Long datasetId);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getDatasetVersionListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<DatasetVersion> getDatasetVersionList(DatasetVersion filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getDatasetVersionList)，以便获取更好的查询性能。
     *
     * @param filter              主表过滤对象。
     * @param datasetDetailFilter 一对一从表过滤对象。
     * @param orderBy             排序参数。
     * @return 查询结果集。
     */
    List<DatasetVersion> getDatasetVersionListWithRelation(DatasetVersion filter, DatasetDetail datasetDetailFilter, String orderBy);
}
