org.hswebframework.web.api.crud.entity

接口 TreeSupportEntity<PK>

类型参数:

PK - 主键类型

所有超级接口:

Entity, Serializable

所有已知子接口:

TreeSortSupportEntity<PK>

所有已知实现类:

GenericTreeSortSupportEntity

public interface TreeSupportEntity<PK>
extends Entity

支持树结构的实体类

从以下版本开始:

4.0

作者:

zhouhao

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	TreeSupportEntity.TreeHelper<T,PK> 树结构Helper

方法概要

限定符和类型	方法和说明
static <T extends TreeSupportEntity<PK>,PK> List<T>	expandTree2List(T parent, IDGenerator<PK> idGenerator)
static <T extends TreeSupportEntity<PK>,PK> void	expandTree2List(T parent, List<T> target, IDGenerator<PK> idGenerator)
static <T extends TreeSupportEntity<PK>,PK> void	expandTree2List(T root, List<T> target, IDGenerator<PK> idGenerator, java.util.function.BiConsumer<T,List<T>> childConsumer) 将树形结构转为列表结构，并填充对应的数据。
static <T extends TreeSupportEntity> void	forEach(Collection<T> list, java.util.function.Consumer<T> consumer)
<T extends TreeSupportEntity<PK>> List<T>	getChildren() 获取所有子节点,默认情况下此字段只会返回null.可以使用list2tree(Collection, BiConsumer)将 列表结构转为树形结构
PK	getId() 获取主键
Integer	getLevel() 获取节点层级
PK	getParentId() 获取上级ID
static String	getParentPath(String path) 根据path获取父节点的path
String	getPath() 获取树路径,树路径表示当前节点所在位置 格式通常为: aBcD-EfgH-iJkl,以-分割,一个分割表示一级.
static <N extends TreeSupportEntity<PK>,PK> List<N>	list2tree(Collection<N> dataList, java.util.function.BiConsumer<N,List<N>> childConsumer) 集合转为树形结构,返回根节点集合
static <N extends TreeSupportEntity<PK>,PK> List<N>	list2tree(Collection<N> dataList, java.util.function.BiConsumer<N,List<N>> childConsumer, java.util.function.Function<TreeSupportEntity.TreeHelper<N,PK>,java.util.function.Predicate<N>> predicateFunction) 列表结构转为树结构,并返回根节点集合
static <N extends TreeSupportEntity<PK>,PK> List<N>	list2tree(Collection<N> dataList, java.util.function.BiConsumer<N,List<N>> childConsumer, java.util.function.Predicate<N> rootNodePredicate)
void	setId(PK id) 设置主键
void	setLevel(Integer level) 设置节点层级
void	setParentId(PK parentId) 设置上级节点ID
void	setPath(String path) 设置路径,此值通常不需要手动设置,在进行保存时，由service自动进行分配.
default void	tryValidate(Class<?>... groups) 使用jsr303对当前实体类进行验证，如果未通过验证则会抛出ValidationException异常

从接口继承的方法 org.hswebframework.web.api.crud.entity.Entity

copyFrom, copyTo, copyTo, tryValidate, tryValidate

方法详细资料

getId

PK getId()

获取主键

返回:

ID

setId

void setId(PK id)

设置主键

参数:

id - ID

getPath

String getPath()

获取树路径,树路径表示当前节点所在位置 格式通常为: aBcD-EfgH-iJkl,以-分割,一个分割表示一级. 比如: aBcD-EfgH-iJkl表示 当前节点在第三级,上一个节点为EfgH.

返回:

树路径

setPath

void setPath(String path)

设置路径,此值通常不需要手动设置,在进行保存时，由service自动进行分配.

参数:

path - 路径

另请参阅:

expandTree2List(TreeSupportEntity, IDGenerator)

getParentId

PK getParentId()

获取上级ID

返回:

上级ID

setParentId

void setParentId(PK parentId)

设置上级节点ID

参数:

parentId -

getLevel

Integer getLevel()

获取节点层级

返回:

节点层级

setLevel

void setLevel(Integer level)

设置节点层级

getChildren

<T extends TreeSupportEntity<PK>> List<T> getChildren()

获取所有子节点,默认情况下此字段只会返回null.可以使用list2tree(Collection, BiConsumer)将 列表结构转为树形结构

类型参数:

T - 当前实体类型

返回:

自己节点

tryValidate

default void tryValidate(Class<?>... groups)

从接口复制的说明: Entity

使用jsr303对当前实体类进行验证，如果未通过验证则会抛出ValidationException异常

指定者:

tryValidate 在接口中 Entity

参数:

groups - 分组

另请参阅:

ValidationException

getParentPath

static String getParentPath(String path)

根据path获取父节点的path

参数:

path - path

返回:

父节点path

forEach

static <T extends TreeSupportEntity> void forEach(Collection<T> list,
                                                  java.util.function.Consumer<T> consumer)

expandTree2List

static <T extends TreeSupportEntity<PK>,PK> List<T> expandTree2List(T parent,
                                                                    IDGenerator<PK> idGenerator)

expandTree2List

static <T extends TreeSupportEntity<PK>,PK> void expandTree2List(T parent,
                                                                 List<T> target,
                                                                 IDGenerator<PK> idGenerator)

expandTree2List

static <T extends TreeSupportEntity<PK>,PK> void expandTree2List(T root,
                                                                 List<T> target,
                                                                 IDGenerator<PK> idGenerator,
                                                                 java.util.function.BiConsumer<T,List<T>> childConsumer)

将树形结构转为列表结构，并填充对应的数据。
如树结构数据： {name:'父节点',children:[{name:'子节点1'},{name:'子节点2'}]}
解析后:[{id:'id1',name:'父节点',path:'aoSt'},{id:'id2',name:'子节点1',path:'aoSt-oS5a'},{id:'id3',name:'子节点2',path:'aoSt-uGpM'}]

类型参数:

T - 继承TreeSupportEntity的类型

PK - 主键类型

参数:

root - 树结构的根节点

target - 目标集合,转换后的数据将直接添加(List.add(Object))到这个集合.

idGenerator - ID生成策略

list2tree

static <N extends TreeSupportEntity<PK>,PK> List<N> list2tree(Collection<N> dataList,
                                                              java.util.function.BiConsumer<N,List<N>> childConsumer)

集合转为树形结构,返回根节点集合

类型参数:

N - 树节点类型

PK - 主键类型

参数:

dataList - 需要转换的集合

childConsumer - 设置子节点回调

返回:

树形结构集合

list2tree

static <N extends TreeSupportEntity<PK>,PK> List<N> list2tree(Collection<N> dataList,
                                                              java.util.function.BiConsumer<N,List<N>> childConsumer,
                                                              java.util.function.Predicate<N> rootNodePredicate)

list2tree

static <N extends TreeSupportEntity<PK>,PK> List<N> list2tree(Collection<N> dataList,
                                                              java.util.function.BiConsumer<N,List<N>> childConsumer,
                                                              java.util.function.Function<TreeSupportEntity.TreeHelper<N,PK>,java.util.function.Predicate<N>> predicateFunction)

列表结构转为树结构,并返回根节点集合

类型参数:

N - 元素类型

PK - 主键类型

参数:

dataList - 数据集合

childConsumer - 子节点消费接口,用于设置子节点

predicateFunction - 根节点判断函数,传入helper,获取一个判断是否为跟节点的函数

返回:

根节点集合