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

API Documentation

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

firtex::index::CFXInvIndex类参考

#include <FXInvIndex.h>

继承图，类firtex::index::CFXInvIndex

firtex::index::CIndex 所有成员的列表。

公有成员

 CFXInvIndex (const tchar *indName, bool bCreate)
 CFXInvIndex (CDirectory *pDirectory, bool bCreate)
virtual ~CFXInvIndex (void)
void addDocument (document::CDocument *pDoc)
void deleteDocument (docid_t docID)
void deleteDocuments (const CTerm *term)
void undeleteAll ()
void close ()
void removeAll ()
count_t numDocs ()
count_t maxDoc ()
void merge ()
void optimize (bool bDeleteDocs=false)
document::CDocument * document (docid_t docID)
document::CField * field (docid_t docID, fieldid_t fid)
CTermReader * termReader ()
CNormBytes * norms (fieldid_t fieldID)
CNormBytes * norms (const tchar *field)
string getVersion ()
CBarrelsInfo & getBarrelsInfo ()
CFieldsInfo & getFieldsInfo ()
CIndexBarrelReader * getBarrelReader ()
CTermVectorReader * getTermVectorReader ()

保护成员

void writeCache ()
void createBarrelReader ()

友元

class CMultiTermSearcher

构造及析构函数文档

firtex::index::CFXInvIndex::CFXInvIndex (  const tchar *  indName,
bool  bCreate
) 
 

firtex::index::CFXInvIndex::CFXInvIndex (  CDirectory *  pDirectory,
bool  bCreate
) 
 

virtual firtex::index::CFXInvIndex::~CFXInvIndex (  void   )  [virtual]
 

成员函数文档

void firtex::index::CFXInvIndex::addDocument (  document::CDocument *  pDoc  )  [virtual]
 

添加待索引文档建索引

参数:
pDoc 待添加索引的文档

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::close (   )  [virtual]
 

关闭索引释放资源

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::createBarrelReader (   )  [protected]
 

创建barrel读接口

void firtex::index::CFXInvIndex::deleteDocument (  docid_t  docID  )  [virtual]
 

删除文档文档编号为docID的文档

参数:
docID 文档编号

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::deleteDocuments (  const CTerm *  term  )  [virtual]
 

删除包含term的所有文档

实现了firtex::index::CIndex。

document::CDocument* firtex::index::CFXInvIndex::document (  docid_t  docID  )  [virtual]
 

返回文档docID的stored fields

参数:
docID 文档编号
返回:
文档对象 非内部对象,需外部删除

实现了firtex::index::CIndex。

document::CField* firtex::index::CFXInvIndex::field (  docid_t  docID,
fieldid_t  fid
)  [virtual]
 

获取指定文档编号指定字段编号的文档对象

参数:
docID 文档编号
fid 字段编号
返回:
字段对象,当该字段不是存储字段或不存在时返回NULL 非内部对象,需外部删除

实现了firtex::index::CIndex。

CIndexBarrelReader* firtex::index::CFXInvIndex::getBarrelReader (   )  [virtual]
 

获取索引桶的读接口，适合高级用户

返回:
返回索引桶读接口引用 内部对象,外部不能删除

实现了firtex::index::CIndex。

CBarrelsInfo& firtex::index::CFXInvIndex::getBarrelsInfo (   )  [inline, virtual]
 

获取索引桶信息

实现了firtex::index::CIndex。

CFieldsInfo& firtex::index::CFXInvIndex::getFieldsInfo (   )  [virtual]
 

获取字段信息

返回:
字段信息,内部对象

实现了firtex::index::CIndex。

CTermVectorReader* firtex::index::CFXInvIndex::getTermVectorReader (   )  [virtual]
 

获取Term Vector 阅读器

返回:
阅读器对象指针 内部对象,外部不能删除

实现了firtex::index::CIndex。

string firtex::index::CFXInvIndex::getVersion (   )  [inline, virtual]
 

获取索引的版本号

返回:
版本号字符串，格式：名称.版本号

实现了firtex::index::CIndex。

count_t firtex::index::CFXInvIndex::maxDoc (   )  [virtual]
 

返回可能最大的文档编号，一般情况下如果没有删除文档则maxDoc()=numDocs() 可以用来决定分配文档数组的大小

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::merge (   )  [virtual]
 

索引合并，索引合并有可能改变文档的内部编号，即文档编号为docID的文档 在合并完后编号不再是docID，在删除文档deleteDocument(docid_t docID) 或获取文档document(docid_t docID)时务必注意这一点

实现了firtex::index::CIndex。

CNormBytes* firtex::index::CFXInvIndex::norms (  const tchar *  field  )  [virtual]
 

获取指定域的norm bytes

参数:
field 域名
返回:
norms bytes 内部对象,外部不能删除

实现了firtex::index::CIndex。

CNormBytes* firtex::index::CFXInvIndex::norms (  fieldid_t  fieldID  )  [virtual]
 

获取指定域的norm bytes

参数:
fieldID 域编号
返回:
norms bytes 内部对象,外部不能删除

实现了firtex::index::CIndex。

count_t firtex::index::CFXInvIndex::numDocs (   )  [virtual]
 

索引中包含的文档总数

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::optimize (  bool  bDeleteDocs = false  )  [virtual]
 

索引优化，合并所有子索引成一个索引，删除已删除文档的索引

参数:
bDeleteDocs 是否真正删除用户已删除文档的索引数据。删除后将无法恢复删除文档
参见:
merge()

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::removeAll (   )  [virtual]
 

删除整个索引

实现了firtex::index::CIndex。

CTermReader* firtex::index::CFXInvIndex::termReader (   )  [virtual]
 

获取Term的访问接口

返回:
如果失败则返回NULL 内部对象，外部不能删除

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::undeleteAll (   )  [virtual]
 

恢复先前删除的所有文档，只有在调用optimize()前调用才有效

实现了firtex::index::CIndex。

void firtex::index::CFXInvIndex::writeCache (   )  [protected]
 

将索引缓冲写至directory

友元及相关函数文档

friend class CMultiTermSearcher [friend]
 

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

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