firtex::index::CIndex类参考

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

构造及析构函数文档

firtex::index::CIndex::CIndex (  void   )  [inline]

firtex::index::CIndex::CIndex (  CDirectory *  pDir  )  [inline]

virtual firtex::index::CIndex::~CIndex (  void   )  [inline, virtual]

成员函数文档

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

添加待索引文档建索引 参数: pDoc  待添加索引的文档 在firtex::index::CFXInvIndex内被实现。

virtual void firtex::index::CIndex::close (   )  [pure virtual]

关闭索引释放资源 在firtex::index::CFXInvIndex内被实现。

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

删除文档文档编号为docID的文档 参数: docID  文档编号 在firtex::index::CFXInvIndex内被实现。

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

删除包含term的所有文档 在firtex::index::CFXInvIndex内被实现。

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

返回文档docID的stored fields 参数: docID  文档编号 在firtex::index::CFXInvIndex内被实现。

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

获取指定文档编号指定字段编号的文档对象 参数: docID  文档编号 fid  字段编号 返回: 字段对象,当该字段不是存储字段或不存在时返回NULL 非内部对象,需外部删除 在firtex::index::CFXInvIndex内被实现。

virtual CIndexBarrelReader* firtex::index::CIndex::getBarrelReader (   )  [pure virtual]

获取索引桶的读接口，适合高级用户 返回: 返回索引桶读接口引用 在firtex::index::CFXInvIndex内被实现。

virtual CBarrelsInfo& firtex::index::CIndex::getBarrelsInfo (   )  [pure virtual]

获取索引桶信息 在firtex::index::CFXInvIndex内被实现。

CDirectory* firtex::index::CIndex::getDirectory (   )  [inline]

获取索引的directory对象

virtual CFieldsInfo& firtex::index::CIndex::getFieldsInfo (   )  [pure virtual]

获取字段信息 返回: 字段信息,内部对象 在firtex::index::CFXInvIndex内被实现。

virtual CTermVectorReader* firtex::index::CIndex::getTermVectorReader (   )  [pure virtual]

获取Term Vector 阅读器 返回: 阅读器对象指针 内部对象,外部不能删除 在firtex::index::CFXInvIndex内被实现。

virtual string firtex::index::CIndex::getVersion (   )  [pure virtual]

获取索引的版本号 返回: 版本号字符串，格式：名称.版本号 在firtex::index::CFXInvIndex内被实现。

virtual count_t firtex::index::CIndex::maxDoc (   )  [pure virtual]

返回可能最大的文档编号，一般情况下如果没有删除文档则maxDoc()=numDocs() 可以用来决定分配文档数组的大小 在firtex::index::CFXInvIndex内被实现。

virtual void firtex::index::CIndex::merge (   )  [pure virtual]

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

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

获取指定域的norm bytes 参数: field  域名 返回: norms bytes,内存由内部维护 在firtex::index::CFXInvIndex内被实现。

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

获取指定域的norm bytes 参数: fieldID  域编号 返回: norms bytes,内存由内部维护 在firtex::index::CFXInvIndex内被实现。

virtual count_t firtex::index::CIndex::numDocs (   )  [pure virtual]

索引中包含的文档总数 在firtex::index::CFXInvIndex内被实现。

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

索引优化，合并所有子索引成一个索引，删除已删除文档的索引 参数: bDeleteDocs  是否真正删除用户已删除文档的索引数据。删除后将无法恢复删除文档 参见: merge() 在firtex::index::CFXInvIndex内被实现。

virtual void firtex::index::CIndex::removeAll (   )  [pure virtual]

删除整个索引 在firtex::index::CFXInvIndex内被实现。

void firtex::index::CIndex::setDirectory (  CDirectory *  pDir  )  [inline]

设置索引名称

virtual CTermReader* firtex::index::CIndex::termReader (   )  [pure virtual]

获取索引的TermReader，TermReader用于读取term的索引信息 在firtex::index::CFXInvIndex内被实现。

virtual void firtex::index::CIndex::undeleteAll (   )  [pure virtual]

恢复先前删除的所有文档，只有在调用optimize()前调用才有效 在firtex::index::CFXInvIndex内被实现。

成员数据文档

CDirectory* firtex::index::CIndex::m_pDirectory [protected]

• include/index/Index.h

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