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

API Documentation

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

firtex::index::CWordFieldTermReader类参考

#include <WordFieldTermReader.h>

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

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

公有成员

 CWordFieldTermReader (void)
 CWordFieldTermReader (CDirectory *pDirectory, const tchar *barrelname, CFieldInfo *pFieldInfo, CBitVector *deletedDocs)
virtual ~CWordFieldTermReader (void)
void open (CDirectory *pDirectory, const tchar *barrelname, CFieldInfo *pFieldInfo, CBitVector *deletedDocs)
CTermIterator * termIterator (CTerm *pLowerTerm, CTerm *pUpperTerm)
CTermIterator * termIterator (const tchar *field)
bool seek (CTerm *term)
CTermDocs * termDocs ()
CTermPositions * termPositions ()
freq_t docFreq (CTerm *term)
void close ()

保护成员

CTermInfo * termInfo (CTerm *term)

保护属性

CFXString m_field
CIndexInput * m_dfiStream
CIndexInput * m_ptiStream
CBitVector * m_deletedDocs
CVocabulary< termid_t > * m_pVocabulary
CTermInfo * m_pCurTermInfo

构造及析构函数文档

firtex::index::CWordFieldTermReader::CWordFieldTermReader (  void   ) 
 

firtex::index::CWordFieldTermReader::CWordFieldTermReader (  CDirectory *  pDirectory,
const tchar *  barrelname,
CFieldInfo *  pFieldInfo,
CBitVector *  deletedDocs
) 
 

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

成员函数文档

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

关闭搜索器，释放资源

实现了firtex::index::CTermReader。

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

获取指定term的df

实现了firtex::index::CTermReader。

void firtex::index::CWordFieldTermReader::open (  CDirectory *  pDirectory,
const tchar *  barrelname,
CFieldInfo *  pFieldInfo,
CBitVector *  deletedDocs
)  [virtual]
 

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

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

实现了firtex::index::CTermReader。

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

搜索指定term

返回:
搜索成功则返回true

实现了firtex::index::CTermReader。

CTermDocs* firtex::index::CWordFieldTermReader::termDocs (   )  [virtual]
 

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

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

实现了firtex::index::CTermReader。

CTermInfo* firtex::index::CWordFieldTermReader::termInfo (  CTerm *  term  )  [protected, virtual]
 

获取指定term的TermInfo

返回:
返回TermInfo，不需要外部删除

重载firtex::index::CTermReader。

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

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

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

实现了firtex::index::CTermReader。

CTermIterator* firtex::index::CWordFieldTermReader::termIterator (  CTerm *  pLowerTerm,
CTerm *  pUpperTerm
)  [virtual]
 

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

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

实现了firtex::index::CTermReader。

CTermPositions* firtex::index::CWordFieldTermReader::termPositions (   )  [virtual]
 

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

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

实现了firtex::index::CTermReader。

成员数据文档

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

CIndexInput* firtex::index::CWordFieldTermReader::m_dfiStream [protected]
 

CFXString firtex::index::CWordFieldTermReader::m_field [protected]
 

CTermInfo* firtex::index::CWordFieldTermReader::m_pCurTermInfo [protected]
 

CIndexInput* firtex::index::CWordFieldTermReader::m_ptiStream [protected]
 

CVocabulary<termid_t>* firtex::index::CWordFieldTermReader::m_pVocabulary [protected]
 

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

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