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

API Documentation


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

firtex::index::CMultiFieldTermReader类参考

#include <MultiFieldTermReader.h>

继承图,类firtex::index::CMultiFieldTermReader

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

公有成员

 CMultiFieldTermReader (CDirectory *pDirectory, const tchar *barrelname, CFieldsInfo *pFieldsInfo, CBitVector *deletedDocs)
virtual ~CMultiFieldTermReader (void)
void open (CDirectory *pDirectory, const tchar *barrelname, CFieldInfo *pFieldsInfo, CBitVector *deletedDocs)
CTermIteratortermIterator (CTerm *pLowerTerm, CTerm *pUpperTerm)
CTermIteratortermIterator (const tchar *field)
bool seek (CTerm *term)
CTermDocstermDocs ()
CTermPositionstermPositions ()
freq_t docFreq (CTerm *term)
CTermInfotermInfo (CTerm *term)
CTermReadertermReader (const tstring &field)
void close ()

保护成员

virtual void open (CDirectory *pDirectory, const tchar *barrelname, CFieldsInfo *pFieldsInfo)

保护属性

map< tstring, CTermReader * > m_fieldsTermReaders
CTermReaderm_curReader
CBitVectorm_deletedDocs

构造及析构函数文档

firtex::index::CMultiFieldTermReader::CMultiFieldTermReader CDirectory pDirectory,
const tchar *  barrelname,
CFieldsInfo pFieldsInfo,
CBitVector deletedDocs
 

virtual firtex::index::CMultiFieldTermReader::~CMultiFieldTermReader void   )  [virtual]
 


成员函数文档

void firtex::index::CMultiFieldTermReader::close  )  [virtual]
 

关闭搜索器,释放资源

实现了firtex::index::CTermReader

freq_t firtex::index::CMultiFieldTermReader::docFreq CTerm term  )  [virtual]
 

获取指定Term的文档频率

返回:
返回文档频率

实现了firtex::index::CTermReader

virtual void firtex::index::CMultiFieldTermReader::open CDirectory pDirectory,
const tchar *  barrelname,
CFieldsInfo pFieldsInfo
[protected, virtual]
 

void firtex::index::CMultiFieldTermReader::open CDirectory pDirectory,
const tchar *  barrelname,
CFieldInfo pFieldsInfo,
CBitVector deletedDocs
[virtual]
 

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

参数:
pDirectory 索引存储位置
barrelname 索引桶名
fieldPointer 索引数据起始位置
deletedDocs 删除文档向量

实现了firtex::index::CTermReader

bool firtex::index::CMultiFieldTermReader::seek CTerm term  )  [virtual]
 

搜索指定term

返回:
搜索成功则返回true,随后可以调用termDocs和termPositions

实现了firtex::index::CTermReader

CTermDocs* firtex::index::CMultiFieldTermReader::termDocs  )  [virtual]
 

调用seek搜索成功后,调用此函数返回当前搜索的term的docs信息

返回:
返回Docs,需要外部删除

实现了firtex::index::CTermReader

CTermInfo* firtex::index::CMultiFieldTermReader::termInfo CTerm term  )  [virtual]
 

获取指定Term的TermInfo

参数:
term 
返回:
返回词信息,内存由内部维护,外部不能删除

重载firtex::index::CTermReader

CTermIterator* firtex::index::CMultiFieldTermReader::termIterator const tchar *  field  )  [virtual]
 

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

参数:
field 字段名
返回:
迭代子对象,需外部删除 返回非内部对象,需外部删除

实现了firtex::index::CTermReader

CTermIterator* firtex::index::CMultiFieldTermReader::termIterator CTerm pLowerTerm,
CTerm pUpperTerm
[virtual]
 

获取Term迭代子,可以按顺序访问所有Term

参数:
pLowerTerm 下限,Term迭代子返回的Term>=term
pUpperTerm 下限,Term迭代子返回的Term<=term
返回:
迭代子对象,需外部删除 返回非内部对象,需外部删除

实现了firtex::index::CTermReader

CTermPositions* firtex::index::CMultiFieldTermReader::termPositions  )  [virtual]
 

调用seek搜索成功后,调用此函数返回当前搜索term的positions信息

返回:
返回positions,需要外部删除

实现了firtex::index::CTermReader

CTermReader* firtex::index::CMultiFieldTermReader::termReader const tstring &  field  ) 
 

获取指定字段的Term Reader

参数:
field 字段名
返回:
返回该字段的Reader,内存由内部维护,外部不能删除


成员数据文档

CTermReader* firtex::index::CMultiFieldTermReader::m_curReader [protected]
 

CBitVector* firtex::index::CMultiFieldTermReader::m_deletedDocs [protected]
 

map<tstring,CTermReader*> firtex::index::CMultiFieldTermReader::m_fieldsTermReaders [protected]
 


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

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