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

API Documentation

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

firtex::index::CIndexBarrelReader类参考

#include <IndexBarrelReader.h>

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

firtex::index::CMultiIndexBarrelReader firtex::index::CSingleIndexBarrelReader 所有成员的列表。

公有成员

 CIndexBarrelReader (CDirectory *pDirectory)
virtual ~CIndexBarrelReader (void)
virtual void open (const tchar *name)=0
virtual document::CDocument * document (docid_t docID)=0
virtual document::CField * field (docid_t docID, fieldid_t fid)=0
virtual void deleteDocument (docid_t docID)=0
virtual void undeleteAll ()=0
virtual bool isDeleted (docid_t docID)=0
virtual bool hasDeletions ()=0
virtual count_t numDeletedDocs ()=0
virtual CTermReader * termReader ()=0
virtual CTermVectorReader * getTermVectorReader ()=0
virtual CNormBytes * norms (const tchar *field)=0
virtual CNormBytes * norms (fieldid_t fid)=0
virtual uint64_t numTerms ()=0
virtual CFieldsInfo & getFieldsInfo ()=0
virtual void close ()=0

保护属性

CDirectory * m_pDirectory

构造及析构函数文档

firtex::index::CIndexBarrelReader::CIndexBarrelReader (  CDirectory *  pDirectory  )  [inline]
 

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

成员函数文档

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

关闭索引桶，释放资源

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

删除索引文档

参数:
docID 文档编号

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

返回文档docID的stored fields

参数:
docID 文档编号
返回:
文档对象，需外部维护内存

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

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

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

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

获取域信息

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

获取词向量阅读器

返回:
词向量阅读器对象 内部对象,外部不能删除

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual bool firtex::index::CIndexBarrelReader::hasDeletions (   )  [pure virtual]
 

判断是否删除过文档

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual bool firtex::index::CIndexBarrelReader::isDeleted (  docid_t  docID  )  [pure virtual]
 

判断文档编号为docID的文档是否已经删除

参数:
docID 文档编号

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual CNormBytes* firtex::index::CIndexBarrelReader::norms (  fieldid_t  fid  )  [pure virtual]
 

获取指定域的norms Bytes

参数:
fid 域编号

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

获取指定域的norms Bytes

参数:
field 域名

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual count_t firtex::index::CIndexBarrelReader::numDeletedDocs (   )  [pure virtual]
 

删除文档总数

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual uint64_t firtex::index::CIndexBarrelReader::numTerms (   )  [pure virtual]
 

获取词总数

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

virtual void firtex::index::CIndexBarrelReader::open (  const tchar *  name  )  [pure virtual]
 

打开指定的索引桶读

参数:
pDirectory 存储位置
name 索引桶名称

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

获取索引桶的TermReader

参数:
如果失败则返回NULL，内存由内部维护，外部不能删除 

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

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

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

在firtex::index::CMultiIndexBarrelReader及firtex::index::CSingleIndexBarrelReader内被实现。

成员数据文档

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

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

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