cn.org.atool.fluent.mybatis.base.entity.IRichEntity Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fluent-mybatis Show documentation
There is a newer version: 1.9.9
package cn.org.atool.fluent.mybatis.base.entity;

import cn.org.atool.fluent.mybatis.base.IEntity;
import cn.org.atool.fluent.mybatis.base.crud.IQuery;
import cn.org.atool.fluent.mybatis.utility.RefKit;

import java.util.List;
import java.util.Optional;

import static cn.org.atool.fluent.mybatis.mapper.FluentConst.*;

/**
 * 只需要Entity属性就可以执行的数据操作方法
 *
 * @author darui.wu
 */
@SuppressWarnings({"unchecked", "rawtypes"})
public interface IRichEntity extends IRich, IEntity {
    /**
     * 持久化entity到数据库, 调用 EntityMapper.insert(Entity)方法
     *
     * @param  IEntity类型
     * @return ignore
     */
    default  E save() {
        this.invoke(RE_Save, false);
        return (E) this;
    }

    /**
     * 按entity的主键更新entity非空字段, 调用 EntityMapper.updateById(id)方法
     *
     * @param  IEntity类型
     * @return ignore
     */
    default  E updateById() {
        if (this.findPk() == null) {
            throw new RuntimeException("the primary of entity can't be null.");
        }
        this.invoke(RE_UpdateById, false);
        return (E) this;
    }

    /**
     * 根据id查找entity, 调用 EntityMapper.findById(id)方法
     *
     * @param  IEntity类型
     * @return ignore
     */
    default  E findById() {
        if (this.findPk() == null) {
            throw new RuntimeException("the primary of entity can't be null.");
        }
        IEntity entity = this.invoke(RE_FindById, false);
        return (E) entity;
    }

    /**
     * 物理删除entity, 调用 EntityMapper.deleteById(id)方法
     */
    default void deleteById() {
        if (this.findPk() == null) {
            throw new RuntimeException("the primary of entity can't be null.");
        }
        this.invoke(RE_DeleteById, false);
    }

    /**
     * 逻辑删除entity, 调用 EntityMapper.logicDeleteById(id)方法
     */
    default void logicDeleteById() {
        if (this.findPk() == null) {
            throw new RuntimeException("the primary of entity can't be null.");
        }
        this.invoke(RE_LogicDeleteById, false);
    }

    /**
     * entity非空字段作为条件查询列表, 调用 EntityMapper.listByMap(map)方法
     *
     * @param  IEntity类型
     * @return ignore
     */
    default  List listByNotNull() {
        return this.invoke(RE_ListByNotNull, false);
    }

    /**
     * entity非空字段作为条件查询列表, 返回符合条件的第一条数据
     *
     * @param  IEntity类型
     * @return ignore
     */
    default  Optional firstByNotNull() {
        E entity = this.invoke(RE_FirstByNotNull, false);
        return Optional.ofNullable(entity);
    }

    /**
     * 将entity非空字段作为相同条件
     *
     * @return IQuery
     */
    default  Q asQuery() {
        IQuery query = RefKit.byEntity(entityClass()).query();
        query.where().eqByEntity(this);
        return (Q) query;
    }
}