FirteX－高性能全文索引和检索平台

API Documentation

首页 | 名字空间列表 | 类继承关系 | 组合类型列表 | $(BL\录(B | 文件列表 | 名字空间成员 | 组合类型成员 | 文件成员

firtex::store::CDirectory类参考

#include <Directory.h>

继承图，类firtex::store::CDirectory

firtex::store::CFSDirectory firtex::store::CRAMDirectory 所有成员的列表。

公有成员

 CDirectory (void)
virtual ~CDirectory (void)
virtual bool fileExists (const tstring &name) const =0
virtual int64_t fileModified (const tstring &name) const =0
virtual int64_t fileLength (const tstring &name) const =0
virtual FileList * list ()=0
virtual CIndexInput * openInput (const tstring &name)=0
virtual CIndexInput * openInput (const tstring &name, char *buf, size_t bufsize)=0
virtual void deleteFile (const tstring &filename, bool throwError=true)=0
virtual void renameFile (const tstring &from, const tstring &to)=0
virtual void batDeleteFiles (const tstring &filename, bool throwError=true)=0
virtual void copyFile (const tstring &filename, CIndexInput *pSrcFile, bool throwError=true)=0
virtual void batCopyFiles (CDirectory *pFromDir, const tstring &from, const tstring &to, bool throwError=true)=0
virtual void batRenameFiles (const tstring &from, const tstring &to)=0
virtual CIndexOutput * createOutput (const tstring &name)=0
virtual void touchFile (const tstring &name)=0
virtual CDirectory * clone ()=0
virtual void close ()=0

构造及析构函数文档

firtex::store::CDirectory::CDirectory (  void   )  [inline]
 

virtual firtex::store::CDirectory::~CDirectory (  void   )  [inline, virtual]
 

成员函数文档

virtual void firtex::store::CDirectory::batCopyFiles (  CDirectory *  pFromDir,
const tstring &  from,
const tstring &  to,
bool  throwError = true
)  [pure virtual]
 

批量拷贝文件，实现copy from.* to.*

参数:
pFromDir 源目录
from 相对于pFromDir的文件名,不带扩展名
to 相对于自身目录的文件名，不带扩展名
throwError 拷贝文件出错时是否抛出异常

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::batDeleteFiles (  const tstring &  filename,
bool  throwError = true
)  [pure virtual]
 

批量删除，将删除所有名字为filename的文件，相当于删除文件filenam.*

参数:
filename 相对于本Directory的文件名，不带扩展名
throwError 删除文件出错是否抛出异常

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::batRenameFiles (  const tstring &  from,
const tstring &  to
)  [pure virtual]
 

批量修改文件名，将from.* 改名成to.*

参数:
from 相对于本Directory的源文件名，不带扩展名
to 相对于本Directory的目标文件名，不带扩展名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual CDirectory* firtex::store::CDirectory::clone (   )  [pure virtual]
 

克隆一个新的对象

返回:
克隆对象 非内部对象,外部删除

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::close (   )  [pure virtual]
 

关闭存储对象

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::copyFile (  const tstring &  filename,
CIndexInput *  pSrcFile,
bool  throwError = true
)  [pure virtual]
 

文件拷贝，将文件的文件从pSrcFile拷贝到filename

参数:
filename 相对于本Directory的径文件名，不带扩展名
throwError 拷贝文件出错是否抛出异常

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual CIndexOutput* firtex::store::CDirectory::createOutput (  const tstring &  name  )  [pure virtual]
 

创建文件

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::deleteFile (  const tstring &  filename,
bool  throwError = true
)  [pure virtual]
 

删除文件

参数:
filename 相对路径文件名，带扩展名
throwError 删除文件出错是否抛出异常

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual bool firtex::store::CDirectory::fileExists (  const tstring &  name  )  const [pure virtual]
 

判断文件是否存在

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual int64_t firtex::store::CDirectory::fileLength (  const tstring &  name  )  const [pure virtual]
 

获取文件长度

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual int64_t firtex::store::CDirectory::fileModified (  const tstring &  name  )  const [pure virtual]
 

获取文件的修改日期

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual FileList* firtex::store::CDirectory::list (   )  [pure virtual]
 

列出目录下所有文件

返回:
文件列表数组 非内部对象,外部删除

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual CIndexInput* firtex::store::CDirectory::openInput (  const tstring &  name,
char *  buf,
size_t  bufsize
)  [pure virtual]
 

使用指定的文件读缓存打开文件

参数:
name 文件名
buf 提供给返回的CIndexInput对象的可用内存
bufSize buf的大小

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual CIndexInput* firtex::store::CDirectory::openInput (  const tstring &  name  )  [pure virtual]
 

打开文件

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::renameFile (  const tstring &  from,
const tstring &  to
)  [pure virtual]
 

修改文件名

参数:
from 原文件名
to 目标文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

virtual void firtex::store::CDirectory::touchFile (  const tstring &  name  )  [pure virtual]
 

将文件得修改时间设置成当前时间

参数:
name 文件名

在firtex::store::CFSDirectory及firtex::store::CRAMDirectory内被实现。

该类的文档由以下文件生成：

http://www.firtex.org http://www.sourceforge.net/projects/firtex