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

API Documentation

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

firtex::store::CFSDirectory类参考

#include <FSDirectory.h>

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

firtex::store::CDirectory 所有成员的列表。

公有成员

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

静态公有成员

CFSDirectory * getDirectory (const tstring &path, bool bCreate)

保护成员

 CFSDirectory (const tstring &path, bool bCreate=false)
void create ()

保护属性

tstring m_directory
int m_refCount

构造及析构函数文档

firtex::store::CFSDirectory::CFSDirectory (  const tstring &  path,
bool  bCreate = false
)  [protected]
 

virtual firtex::store::CFSDirectory::~CFSDirectory (  void   )  [virtual]
 

成员函数文档

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

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

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

实现了firtex::store::CDirectory。

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

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

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

实现了firtex::store::CDirectory。

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

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

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

实现了firtex::store::CDirectory。

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

克隆一个新的对象

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

实现了firtex::store::CDirectory。

void firtex::store::CFSDirectory::close (   )  [virtual]
 

关闭存储对象

实现了firtex::store::CDirectory。

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

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

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

实现了firtex::store::CDirectory。

void firtex::store::CFSDirectory::create (   )  [protected]
 

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

创建文件

实现了firtex::store::CDirectory。

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

删除文件

实现了firtex::store::CDirectory。

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

判断文件是否存在

实现了firtex::store::CDirectory。

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

获取文件长度

实现了firtex::store::CDirectory。

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

获取文件的修改日期

实现了firtex::store::CDirectory。

CFSDirectory* firtex::store::CFSDirectory::getDirectory (  const tstring &  path,
bool  bCreate
)  [static]
 

FileList* firtex::store::CFSDirectory::list (   )  [virtual]
 

列出目录下所有文件

实现了firtex::store::CDirectory。

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

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

实现了firtex::store::CDirectory。

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

打开文件

实现了firtex::store::CDirectory。

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

修改文件名

实现了firtex::store::CDirectory。

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

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

实现了firtex::store::CDirectory。

成员数据文档

tstring firtex::store::CFSDirectory::m_directory [protected]
 

int firtex::store::CFSDirectory::m_refCount [protected]
 

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

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