Module bus.mapper

Package org.miaixz.bus.mapper.binding.logical

Interface LogicalMapper<T,I extends Serializable>

Type Parameters:

T - 实体类类型

I - 主键类型

All Superinterfaces:

BasicMapper<T,I>, ClassMapper<T>, ConditionMapper<T,Condition<T>>, CursorMapper<T,Condition<T>>, EntityMapper<T,I>, FunctionMapper<T>

public interface LogicalMapper<T,I extends Serializable>
extends BasicMapper<T,I>, FunctionMapper<T>

逻辑删除操作接口，覆盖基础查询、删除、更新方法以支持逻辑删除

Since:

Java 17+

Author:

Kimi Liu

Nested Class Summary

Nested classes/interfaces inherited from interface org.miaixz.bus.mapper.binding.basic.ClassMapper

ClassMapper.CachingEntityClass

Method Summary

Modifier and Type	Method	Description
default Condition<T>	condition()	创建 Condition 查询对象
long	countByCondition(Condition<T> condition)	根据 Condition 条件查询记录总数
int	delete(T entity)	根据实体条件逻辑删除记录
int	deleteByCondition(Condition<T> condition)	根据 Condition 条件逻辑删除记录
int	deleteByPrimaryKey(I id)	根据主键逻辑删除记录
List<T>	selectByCondition(Condition<T> condition)	根据 Condition 条件批量查询
List<T>	selectByCondition(Condition<T> condition, org.apache.ibatis.session.RowBounds rowBounds)	根据 Condition 条件分页查询
org.miaixz.bus.core.lang.Optional<T>	selectByPrimaryKey(I id)	根据主键查询实体
List<T>	selectColumns(T entity, Fn.FnArray<T> selectFields)	根据实体字段条件批量查询，仅返回指定字段
org.miaixz.bus.core.lang.Optional<T>	selectColumnsOne(T entity, Fn.FnArray<T> selectFields)	根据实体字段条件查询唯一实体，仅返回指定字段
long	selectCount(T entity)	根据实体字段条件查询记录总数
org.apache.ibatis.cursor.Cursor<T>	selectCursor(T entity)	根据实体字段条件进行游标查询
org.apache.ibatis.cursor.Cursor<T>	selectCursorByCondition(Condition<T> condition)	根据 Condition 条件进行游标查询
List<T>	selectList(T entity)	根据实体字段条件批量查询
org.miaixz.bus.core.lang.Optional<T>	selectOne(T entity)	根据实体字段条件查询唯一实体
org.miaixz.bus.core.lang.Optional<T>	selectOneByCondition(Condition<T> condition)	根据 Condition 条件查询唯一实体
<S extends T> int	updateByCondition(S entity, Condition<T> condition)	根据 Condition 条件批量更新实体
<S extends T> int	updateByConditionSelective(S entity, Condition<T> condition)	根据 Condition 条件批量更新实体非空字段
int	updateByConditionSetValues(Condition<T> condition)	根据 Condition 条件和 SET 值更新字段
<S extends T> int	updateByPrimaryKey(S entity)	根据主键更新实体
<S extends T> int	updateByPrimaryKeySelective(S entity)	根据主键更新实体中非空字段
<S extends T> int	updateByPrimaryKeySelectiveWithForceFields(S entity, Fn.FnArray<T> fields)	根据主键更新实体中非空字段，并强制更新指定字段

Methods inherited from interface org.miaixz.bus.mapper.binding.BasicMapper

deleteByFieldList, selectByFieldList, updateForFieldListByPrimaryKey, wrapper

Methods inherited from interface org.miaixz.bus.mapper.binding.basic.ClassMapper

entityClass, entityTable

Methods inherited from interface org.miaixz.bus.mapper.binding.basic.EntityMapper

insert, insertSelective

Method Details

updateByPrimaryKeySelectiveWithForceFields

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByPrimaryKeySelectiveWithForceFields")
<S extends T> int updateByPrimaryKeySelectiveWithForceFields(@Param("entity")
 S entity,
 @Param("fns")
 Fn.FnArray<T> fields)

根据主键更新实体中非空字段，并强制更新指定字段

Specified by:

updateByPrimaryKeySelectiveWithForceFields in interface BasicMapper<T,I extends Serializable>

Specified by:

updateByPrimaryKeySelectiveWithForceFields in interface FunctionMapper<T>

Type Parameters:

S - 实体类型

Parameters:

entity - 实体对象

fields - 强制更新的字段集合，通过 Fn.of(Fn...) 创建 Fn.FnArray

Returns:

1 表示成功，0 表示失败

selectColumnsOne

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectColumns")
org.miaixz.bus.core.lang.Optional<T> selectColumnsOne(@Param("entity")
 T entity,
 @Param("fns")
 Fn.FnArray<T> selectFields)

根据实体字段条件查询唯一实体，仅返回指定字段

Specified by:

selectColumnsOne in interface FunctionMapper<T>

Parameters:

entity - 实体对象

selectFields - 查询的字段集合，通过 Fn.of(Fn...) 创建 Fn.FnArray

Returns:

唯一实体对象，若结果多条则抛出异常，可能为空

selectColumns

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectColumns")
List<T> selectColumns(@Param("entity")
 T entity,
 @Param("fns")
 Fn.FnArray<T> selectFields)

根据实体字段条件批量查询，仅返回指定字段

Specified by:

selectColumns in interface FunctionMapper<T>

Parameters:

entity - 实体对象

selectFields - 查询的字段集合，通过 Fn.of(Fn...) 创建 Fn.FnArray

Returns:

实体对象列表

deleteByPrimaryKey

@Lang(Caching.class)
@DeleteProvider(type=LogicalProvider.class,
                method="deleteByPrimaryKey")
int deleteByPrimaryKey(I id)

根据主键逻辑删除记录

Specified by:

deleteByPrimaryKey in interface EntityMapper<T,I extends Serializable>

Parameters:

id - 主键

Returns:

1 表示成功，0 表示失败

delete

@Lang(Caching.class)
@DeleteProvider(type=LogicalProvider.class,
                method="delete")
int delete(T entity)

根据实体条件逻辑删除记录

Specified by:

delete in interface EntityMapper<T,I extends Serializable>

Parameters:

entity - 实体对象

Returns:

大于等于 1 表示成功，0 表示失败

updateByPrimaryKey

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByPrimaryKey")
<S extends T> int updateByPrimaryKey(S entity)

根据主键更新实体

Specified by:

updateByPrimaryKey in interface EntityMapper<T,I extends Serializable>

Type Parameters:

S - 实体类型

Parameters:

entity - 实体对象

Returns:

1 表示成功，0 表示失败

updateByPrimaryKeySelective

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByPrimaryKeySelective")
<S extends T> int updateByPrimaryKeySelective(S entity)

根据主键更新实体中非空字段

Specified by:

updateByPrimaryKeySelective in interface EntityMapper<T,I extends Serializable>

Type Parameters:

S - 实体类型

Parameters:

entity - 实体对象

Returns:

1 表示成功，0 表示失败

selectByPrimaryKey

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectByPrimaryKey")
org.miaixz.bus.core.lang.Optional<T> selectByPrimaryKey(I id)

根据主键查询实体

Specified by:

selectByPrimaryKey in interface EntityMapper<T,I extends Serializable>

Parameters:

id - 主键

Returns:

实体对象，可能为空

selectOne

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="select")
org.miaixz.bus.core.lang.Optional<T> selectOne(T entity)

根据实体字段条件查询唯一实体

Specified by:

selectOne in interface EntityMapper<T,I extends Serializable>

Parameters:

entity - 实体对象

Returns:

唯一实体对象，若结果多条则抛出异常，可能为空

selectList

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="select")
List<T> selectList(T entity)

根据实体字段条件批量查询

Specified by:

selectList in interface EntityMapper<T,I extends Serializable>

Parameters:

entity - 实体对象

Returns:

实体对象列表

selectCount

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectCount")
long selectCount(T entity)

根据实体字段条件查询记录总数

Specified by:

selectCount in interface EntityMapper<T,I extends Serializable>

Parameters:

entity - 实体对象

Returns:

记录总数

selectCursor

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="select")
org.apache.ibatis.cursor.Cursor<T> selectCursor(T entity)

根据实体字段条件进行游标查询

Specified by:

selectCursor in interface CursorMapper<T,I extends Serializable>

Parameters:

entity - 实体对象

Returns:

实体对象游标

selectCursorByCondition

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectByCondition")
org.apache.ibatis.cursor.Cursor<T> selectCursorByCondition(Condition<T> condition)

根据 Condition 条件进行游标查询

Specified by:

selectCursorByCondition in interface CursorMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

实体对象游标

condition

default Condition<T> condition()

创建 Condition 查询对象

Specified by:

condition in interface ConditionMapper<T,I extends Serializable>

Returns:

Condition 对象

deleteByCondition

@Lang(Caching.class)
@DeleteProvider(type=LogicalProvider.class,
                method="deleteByCondition")
int deleteByCondition(Condition<T> condition)

根据 Condition 条件逻辑删除记录

Specified by:

deleteByCondition in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

大于等于 1 表示成功，0 表示失败

updateByCondition

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByCondition")
<S extends T> int updateByCondition(@Param("entity")
 S entity,
 @Param("condition")
 Condition<T> condition)

根据 Condition 条件批量更新实体

Specified by:

updateByCondition in interface ConditionMapper<T,I extends Serializable>

Type Parameters:

S - 实体类型

Parameters:

entity - 实体对象

condition - 条件对象

Returns:

大于等于 1 表示成功，0 表示失败

updateByConditionSetValues

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByConditionSetValues")
int updateByConditionSetValues(@Param("condition")
 Condition<T> condition)

根据 Condition 条件和 SET 值更新字段

Specified by:

updateByConditionSetValues in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

大于等于 1 表示成功，0 表示失败

updateByConditionSelective

@Lang(Caching.class)
@UpdateProvider(type=LogicalProvider.class,
                method="updateByConditionSelective")
<S extends T> int updateByConditionSelective(@Param("entity")
 S entity,
 @Param("condition")
 Condition<T> condition)

根据 Condition 条件批量更新实体非空字段

Specified by:

updateByConditionSelective in interface ConditionMapper<T,I extends Serializable>

Type Parameters:

S - 实体类型

Parameters:

entity - 实体对象

condition - 条件对象

Returns:

大于等于 1 表示成功，0 表示失败

selectByCondition

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectByCondition")
List<T> selectByCondition(Condition<T> condition)

根据 Condition 条件批量查询

Specified by:

selectByCondition in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

实体对象列表

selectOneByCondition

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="selectByCondition")
org.miaixz.bus.core.lang.Optional<T> selectOneByCondition(Condition<T> condition)

根据 Condition 条件查询唯一实体

Specified by:

selectOneByCondition in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

唯一实体对象，若结果多条则抛出异常，可能为空

countByCondition

@Lang(Caching.class)
@SelectProvider(type=LogicalProvider.class,
                method="countByCondition")
long countByCondition(Condition<T> condition)

根据 Condition 条件查询记录总数

Specified by:

countByCondition in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

Returns:

记录总数

selectByCondition

List<T> selectByCondition(Condition<T> condition,
 org.apache.ibatis.session.RowBounds rowBounds)

根据 Condition 条件分页查询

Specified by:

selectByCondition in interface ConditionMapper<T,I extends Serializable>

Parameters:

condition - 条件对象

rowBounds - 分页信息

Returns:

实体对象列表