API
Class

com.justep.doc.Docs (com.justep.doc.Docs)

使用范围：BIZ

Contents

class com.justep.doc.Docs (com.justep.doc.Docs)

文档容器类

Constructor Top

  Docs ()
  Docs ()

Methods Top

boolean addDirs (String parentIDorPath, String subPath)
Doc addDoc (String sID, String sDocName, String sKind, Doc dirDoc)
Doc get (String sID)
boolean getIsEditInfo ()
Boolean getIsLogicDelete ()
Iterator getIterator ()
Docs query (String docID, String docPath, String columns, String orderBy, String custom)
Docs queryByDocID (String fileID)
Docs queryByDocPath (String docPath)
Docs queryByFileID (String fileID)
Docs remove (String sID)
Docs remove (Doc doc)
int save ()
void setIsEditInfo (boolean editInfo)
void setIsLogicDelete ()
int size ()

Constructor details Top

public Docs ()

文档容器类

public Docs ()

创建文档容器

Methods Detail Top

public boolean addDirs (String parentIDorPath, String subPath)

创建目录,并且会把创建的doc对象和使用到的父对象装载到当前容器中，docs中原有的数据会丢失.

Parameters

String parentIDorPath

已经在当前容器中存在的父目录
String subPath

子目录 支持模型函数(fn)

Return Value

boolean

public Doc addDoc (String sID, String sDocName, String sKind, Doc dirDoc)

添加一个文档到当前容器中(目录也是Doc)

Parameters

String sID

文档的id
String sDocName

文档名称
String sKind

文档类型 目录的sKind是dir 其他文件的skind是这个文件的mimeType
Doc dirDoc

文档所在的文件夹对象

Return Value

Doc

public Doc get (String sID)

获取文档对象(从当前容器中获取，如果当前容器中不存在，则返回null)

Parameters

String sID

文档的id

Return Value

Doc

public boolean getIsEditInfo ()

See com.justep.doc.Docs#setIsEditInfo

Return Value

boolean

public Boolean getIsLogicDelete ()

是否是逻辑删除文档（默认是逻辑删除）

Return Value

Boolean

public Iterator getIterator ()

返回所有文档的迭代器。

Return Value

Iterator

public Docs query (String docID, String docPath, String columns, String orderBy, String custom)

查询符合条件的文档,装载到当前docs容器中,docs中原有的数据会丢失

Parameters

String docID

文档的id
String docPath

文档的路径
String columns

需要查询的字段
String orderBy

排序的字段
String custom

自定义查询条件，符合ksql语法的where子句，直接采用and方式拼接到查询的ksql语句上

Return Value

Docs

public Docs queryByDocID (String fileID)

查询符合条件的文档,装载到当前docs容器中,docs中原有的数据会丢失

Parameters

String fileID

文档id

Return Value

Docs

public Docs queryByDocPath (String docPath)

查询符合条件的文档,装载到当前docs容器中,docs中原有的数据会丢失

Parameters

String docPath

文档的路径

Return Value

Docs

public Docs queryByFileID (String fileID)

查询符合条件的文档,装载到当前docs容器中,docs中原有的数据会丢失

Parameters

String fileID

文档id

Return Value

Docs

public Docs remove (String sID)

从容器中移除指定的文档

Parameters

String sID

文档的id

Return Value

Docs

public Docs remove (Doc doc)

从容器中移除指定的文档

Parameters

Doc doc

文档对象

Return Value

Docs

public int save ()

保存对当前容器所做的修改，需要存储到数据库的会存储数据库，需要同步文档服务的会同步到文档服务。

Return Value

int

public void setIsEditInfo (boolean editInfo)

设置是否是仅仅修改了文档属性信息，没有修改文件内容
一般来说对文档对象的修改通常是修改文档内容,然后传到文档服务器形成当前文档的新版本，或者形成新的文档，但是也有少数情况是对这个文件进行关键字，描述信心的维护，这些信息不会影响文档的内容，这个时候需要设置editInfo为true，默认editInfo为false

Parameters

boolean editInfo

Return Value

void

public void setIsLogicDelete ()

设置是否是逻辑删除文档（默认是逻辑删除）

Return Value

void

public int size ()

获取当前容器中的文档数量

Return Value

int