org.xworker
接口 ThingManager

所有已知实现类：

AbstractFileThingManager, TransientThingManager, XerThingManager

public interface ThingManager

事物管理者是对事物的二级分类，一个事物管理者一般具体提供了如何按照某种格式保存和读取事物，事物管理者包含 目录和事物。

作者：

zyx

方法摘要

void	addThingManagerListener(ThingManagerListener listener) 添加事物管理者事件。
void	clearCache() 清空缓存。
boolean	createCategory(java.lang.String categoryName) 创建新的目录。
Category	getCategory(java.lang.String name) 通过指定的目录名称获取目录。
java.util.List<Category>	getCategorys() 返回事物管理者定义的所有目录列表。
java.lang.String	getName() 获得事物管理者的名称。
Project	getProject() 获得事物管理者所在的项目。
Thing	getThing(java.lang.String thingName) 通过事物的名称取得事物。
java.util.List<ThingIndex>	getThingIndexs(java.lang.String categoryName, boolean includeChildCategory) 返回指定目录下的事物索引列表。
java.util.List<ThingIndex>	getThingIndexs(java.lang.String categoryName, java.lang.String descriptorPath, boolean includeChildCategory) 根据描述者获取指定目录下的事物索引列表。
java.util.List<Thing>	getThings(java.lang.String categoryName, boolean includeChildCategory) 取得指定目录下的事物列表。
java.util.List<Thing>	getThings(java.lang.String categoryName, java.lang.String descriptorPath, boolean includeChildCategory) 根据事物描述者取得指定目录下的事物列表。
java.util.Iterator<Thing>	iterator(java.lang.String categoryName, boolean includeChildCategory) 指定目录遍历该目录下的事物。
java.util.Iterator<Thing>	iterator(java.lang.String categoryName, java.lang.String descriptorPath, boolean includeChildCategory) 指定事物的描述者遍历指定目录下的事物。
void	refresh() 刷新事物管理者。
void	refresh(java.lang.String categoryName, boolean includeChildCategory) 刷新指定目录。
boolean	remove() 删除此事物管理者，在此方法里实现清除此事物管理者的相关内容。
boolean	remove(Thing thing) 从事物管理者中移除一个事物。
boolean	removeCategory(java.lang.String categoryName) 删除一个目录。
boolean	removeThingManagerListener(ThingManagerListener listener) 删除事物管理者的监听事件。
boolean	save(Thing athing) 保存一个事物。

方法详细信息

addThingManagerListener

void addThingManagerListener(ThingManagerListener listener)

添加事物管理者事件。

参数：

listener - 事物管理者的事件

clearCache

void clearCache()

清空缓存。

createCategory

boolean createCategory(java.lang.String categoryName)

创建新的目录。

参数：

categoryName - 目录名称

返回：

已创建或已存在的目录

getCategory

Category getCategory(java.lang.String name)

通过指定的目录名称获取目录。

参数：

name - 目录的名称

返回：

目录，如果不存在返回null

getCategorys

java.util.List<Category> getCategorys()

返回事物管理者定义的所有目录列表。

返回：

事物管理者的所有目录

getName

java.lang.String getName()

获得事物管理者的名称。

返回：

事物管理者的名称

getProject

Project getProject()

获得事物管理者所在的项目。

返回：

项目

getThing

Thing getThing(java.lang.String thingName)

通过事物的名称取得事物。

参数：

thingName - 事物的名称，此名称为全名（包含目录）

返回：

事物

getThingIndexs

java.util.List<ThingIndex> getThingIndexs(java.lang.String categoryName,
                                          boolean includeChildCategory)

返回指定目录下的事物索引列表。

参数：

categoryName - 目录名称

includeChildCategory - 是否包含子目录

返回：

目录索引列表

getThingIndexs

java.util.List<ThingIndex> getThingIndexs(java.lang.String categoryName,
                                          java.lang.String descriptorPath,
                                          boolean includeChildCategory)

根据描述者获取指定目录下的事物索引列表。

参数：

categoryName - 目录名称

descriptorPath - 描述者路径

includeChildCategory - 是否包含子目录

返回：

目录索引列表

getThings

java.util.List<Thing> getThings(java.lang.String categoryName,
                                boolean includeChildCategory)

取得指定目录下的事物列表。

参数：

categoryName - 目录名称

includeChildCategory - 是否包含子目录

返回：

事物列表

getThings

java.util.List<Thing> getThings(java.lang.String categoryName,
                                java.lang.String descriptorPath,
                                boolean includeChildCategory)

根据事物描述者取得指定目录下的事物列表。

参数：

categoryName - 目录名称

descritporPath - 事物描述者的路径

includeChildCategory - 是否包含子目录

返回：

事物列表

iterator

java.util.Iterator<Thing> iterator(java.lang.String categoryName,
                                   boolean includeChildCategory)

指定目录遍历该目录下的事物。

参数：

categoryName - 目录名称

includeChildCategory - 是否包含子目录

返回：

事物遍历器

iterator

java.util.Iterator<Thing> iterator(java.lang.String categoryName,
                                   java.lang.String descriptorPath,
                                   boolean includeChildCategory)

指定事物的描述者遍历指定目录下的事物。

参数：

categoryName - 目录名称

descriptorPath - 描述者的路径

includeChildCategory - 是否包含子目录

返回：

事物遍历器

refresh

void refresh()

刷新事物管理者。

refresh

void refresh(java.lang.String categoryName,
             boolean includeChildCategory)

刷新指定目录。

参数：

categoryName - 目录

includechildCategory - 是否包含子目录

remove

boolean remove()

删除此事物管理者，在此方法里实现清除此事物管理者的相关内容。

remove

boolean remove(Thing thing)

从事物管理者中移除一个事物。

参数：

thing - 要移除的事物

返回：

已经被移除的事物，如果没有则返回null

removeCategory

boolean removeCategory(java.lang.String categoryName)

删除一个目录。

参数：

categoryName - 目录名称

返回：

是否删除成功

removeThingManagerListener

boolean removeThingManagerListener(ThingManagerListener listener)

删除事物管理者的监听事件。

参数：

listener - 事物管理者监听事件

save

boolean save(Thing athing)

保存一个事物。

参数：

athing - 要保存的事物

返回：

如果保存成功那么返回该事物的根父事物，否则返回null