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

API Documentation

firtex::index::CTermReader类参考

#include <TermReader.h>

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


公有成员
	CTermReader (void)
virtual	~CTermReader (void)
virtual void	open (CDirectory pDirectory, const tchar barrelname, CFieldInfo pFieldInfo, CBitVector deletedDocs)=0
virtual CTermIterator *	termIterator (CTerm pLowerTerm, CTerm pUpperTerm)=0
virtual CTermIterator *	termIterator (const tchar *field)=0
virtual bool	seek (CTerm *term)=0
virtual CTermDocs *	termDocs ()=0
virtual CTermPositions *	termPositions ()=0
virtual freq_t	docFreq (CTerm *term)=0
virtual CTermInfo *	termInfo (CTerm *term)
virtual void	close ()=0

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

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

virtual freq_t firtex::index::CTermReader::docFreq ( CTerm * term ) [pure virtual]

获取指定Term的文档频率
返回:
返回文档频率

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual void firtex::index::CTermReader::open ( CDirectory * pDirectory,

const tchar * barrelname,

CFieldInfo * pFieldInfo,

CBitVector * deletedDocs

) [pure virtual]

打开指定索引桶的索引数据
参数:

pDirectory 索引存储位置

barrelname 索引桶名

fieldPointer 索引数据起始位置

deletedDocs 删除文档向量

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual bool firtex::index::CTermReader::seek ( CTerm * term ) [pure virtual]

定位到指定term
返回:
搜索成功则返回true,随后可以调用termDocs和termPositions

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual CTermDocs* firtex::index::CTermReader::termDocs ( ) [pure virtual]

调用seek搜索成功后，调用此函数返回当前搜索的term的docs信息
返回:
返回Docs，需要外部删除

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual CTermInfo* firtex::index::CTermReader::termInfo ( CTerm * term ) [inline, virtual]

获取指定Term的Term Info
返回:
返回Term Info

被firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader及firtex::index::CWordFieldTermReader重载。

virtual CTermIterator* firtex::index::CTermReader::termIterator ( const tchar * field ) [pure virtual]

获取特定字段的Term迭代子，可以按顺序访问所有Term
参数:

field 字段名

返回:
迭代子对象，需外部删除返回非内部对象,需外部删除

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual CTermIterator* firtex::index::CTermReader::termIterator ( CTerm * pLowerTerm,

CTerm * pUpperTerm

) [pure virtual]

获取Term迭代子，可以按顺序访问所有Term
参数:

pLowerTerm 下限,Term迭代子返回的Term>=term

pUpperTerm 下限,Term迭代子返回的Term<=term

返回:
迭代子对象，需外部删除返回非内部对象,需外部删除

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

virtual CTermPositions* firtex::index::CTermReader::termPositions ( ) [pure virtual]

调用search搜索成功后，调用此函数返回当前搜索term的positions信息
返回:
返回positions，需要外部删除

在firtex::index::CDateFieldTermReader、firtex::index::CMultiFieldTermReader、firtex::index::CMultiTermReader及firtex::index::CWordFieldTermReader内被实现。

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