org.sagacity.sqltoy.service.SqlToyCRUDService Maven / Gradle / Ivy
package org.sagacity.sqltoy.service;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.sagacity.sqltoy.model.CacheMatchFilter;
import org.sagacity.sqltoy.model.Page;
import org.sagacity.sqltoy.model.ParallQuery;
import org.sagacity.sqltoy.model.ParallelConfig;
import org.sagacity.sqltoy.model.QueryResult;
import org.sagacity.sqltoy.translate.TranslateHandler;
/**
* @project sqltoy-orm
* @description 通过SqlToy提供通用的增删改查操作Service接口,从而减少针对一些非常
* 简单的操作自行编写service实现，减少了代码开发量
* @author zhongxuchen
* @version v1.0,Date:2012-7-16
* @see 推荐自定义service中引入sqltoy自带的lightDao，而非直接使用sqltoy提供的SqlToyCRUDService
* @modify Date:2020-4-23 {对分页查询增加泛型支持}
*/
@SuppressWarnings("rawtypes")
public interface SqlToyCRUDService {
/**
* @todo 保存单条记录对象
* @param entity
* @return
*/
public Object save(Serializable entity);
/**
* @todo 批量保存对象
* @param
* @param entities
* @return
*/
public Long saveAll(List entities);
/**
* @todo 批量保存对象并忽视已经存在的记录
* @param
* @param entities
* @return
*/
public Long saveAllIgnoreExist(List entities);
/**
* @todo 修改对象，设置强制修改的属性
* @param entity
* @param forceUpdateProps
* @return
*/
public Long update(Serializable entity, String... forceUpdateProps);
/**
* @TODO 提供级联修改
* @param entity
* @param forceUpdateProps
* @return
*/
public Long updateCascade(Serializable entity, String... forceUpdateProps);
/**
* @todo 对属性进行强制修改,属性值为null则强制更新数据库字段值
* @param entity
* @return
*/
public Long updateDeeply(Serializable entity);
/**
* @todo 批量对象修改，通过forceUpdateProps指定哪些字段需要强制修改
* @param
* @param entities
* @param forceUpdateProps 强制修改的字段
* @return
*/
public Long updateAll(List entities, String... forceUpdateProps);
/**
* @todo 批量深度集合修改，属性值为null将直接覆盖数据库中的值
* @param
* @param entities
* @return
*/
public Long updateAllDeeply(List entities);
/**
* @todo 修改或保存单条记录
* @param entity 实体对象
* @param forceUpdateProps 强制修改的对象属性
* @return
*/
public Long saveOrUpdate(Serializable entity, String... forceUpdateProps);
/**
* @todo 批量保存或修改对象
* @param
* @param entities 对象集合
* @param forceUpdateProps 需强制修改的属性
* @return
*/
public Long saveOrUpdateAll(List entities, String... forceUpdateProps);
/**
* @todo 获取对象数据
* @param entity
* @return
*/
public T load(T entity);
/**
* @todo 级联加载对象
* @param entity
* @return
*/
public T loadCascade(T entity);
/**
* @todo 删除单条对象
* @param entity
* @return
*/
public Long delete(Serializable entity);
/**
* @todo 批量删除对象
* @param
* @param entities
* @return
*/
public Long deleteAll(List entities);
public Long deleteByIds(final Class entityClass, Object... ids);
/**
* @todo 清除表的记录
* @param entityClass
*/
public void truncate(final Class entityClass);
/**
* @todo 判断是否唯一 true 表示唯一不重复；false 表示不唯一，即数据库中已经存在
* @param entity
* @param paramsNamed group+uniqueField 对象属性名称(不是数据库表字段名称)
* @return
*/
public boolean isUnique(Serializable entity, final String... paramsNamed);
/**
* @todo 对树形数据进行封装，构造对象对应表的nodeRoute，nodeLevel，isLeaf等信息 便于对树形结构数据快速查询
* @param entity
* @param pidField 父节点属性名称(java对象属性名称)
* @return
*/
public boolean wrapTreeTableRoute(final Serializable entity, String pidField);
/**
* @todo 对树形数据进行封装，构造对象对应表的nodeRoute，nodeLevel，isLeaf等信息 便于对树形结构数据快速查询
* @param entity
* @param pidField 父节点属性名称(java对象属性名称)
* @param appendIdSize 构造成nodeRoute时单个id值的长度，如：1001,1002如果长度设置为6，则001001,001002
* @return
*/
public boolean wrapTreeTableRoute(final Serializable entity, String pidField, int appendIdSize);
/**
* @todo 根据对象主键获取对象详细信息
* @param entities
* @return
*/
public List loadAll(List entities);
/**
* @todo 选择性的加载子表信息
* @param entities
* @param cascadeTypes 级联加载的子表对象类型
* @return
*/
public List loadAllCascade(List entities, final Class... cascadeTypes);
/**
* @TODO 根据id集合批量加载对象
* @param
* @param voClass
* @param ids
* @return
*/
public List loadByIds(final Class voClass, Object... ids);
/**
* @todo 获取业务ID
* @param signature 格式:tableName_yyyyMMdd,如：staff_info20210701
* @param increment
* @return
*/
public long generateBizId(String signature, int increment);
/**
* @todo 根据实体对象对应的POJO配置的业务主键策略,提取对象的属性值产生业务主键
* @param entity
* @return
*/
public String generateBizId(Serializable entity);
/**
* @TODO 利用缓存通过反调模式对集合数据进行编码转名称翻译
* @param dataSet
* @param cacheName
* @param translateHandler 反调方法:取key 和回写名称
*/
public void translate(Collection dataSet, String cacheName, TranslateHandler translateHandler);
/**
* @todo 对记录进行翻译(可以)
* @param dataSet
* @param cacheName
* @param cacheType 针对类似数据字典性质的有分类的缓存
* @param cacheNameIndex 手动指定缓存中名称对应的列(缓存默认格式为:key,name,extName1,extName2
* 默认cacheNameIndex为1)
* @param translateHandler
*/
public void translate(Collection dataSet, String cacheName, String cacheType, Integer cacheNameIndex,
TranslateHandler translateHandler);
/**
* @todo 判断缓存是否存在
* @param cacheName
* @return
*/
public boolean existCache(String cacheName);
/**
* @todo 获取所有缓存的名称
* @return
*/
public Set getCacheNames();
/**
* @TODO 通过缓存将名称进行模糊匹配取得key的集合
* @param cacheMatchFilter
* @param matchRegexes 匹配表达式，如:中国 上海,xxx公司
* @return
*/
public String[] cacheMatchKeys(CacheMatchFilter cacheMatchFilter, String... matchRegexes);
/**
* @TODO 实现VO和POJO之间属性值的复制,如名称不一致，在VO中字段上使用@SqlToyFieldAlias 注解来处理
* @param
* @param source
* @param resultType
* @return
*/
public T convertType(Serializable source, Class resultType);
/**
* @TODO 实现VO和POJO 集合之间属性值的复制，如名称不一致，在VO中字段上使用@SqlToyFieldAlias 注解来处理
* @param
* @param sourceList
* @param resultType
* @return
*/
public List convertType(List sourceList, Class resultType);
/**
* @TODO 实现分页对象的类型转换
* @param
* @param sourcePage
* @param resultType
* @return
*/
public Page convertType(Page sourcePage, Class resultType);
/**
* @TODO 基于map传参的并行查询
* @param
* @param parallQueryList
* @param paramsMap
* @param parallelConfig 例如:ParallelConfig.create().maxThreads(20)
* @return
*/
public List> parallQuery(List parallQueryList, Map paramsMap,
ParallelConfig parallelConfig);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy