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

API Documentation


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

firtex::search::CIndexSearcher类参考

#include <IndexSearcher.h>

继承图,类firtex::search::CIndexSearcher

firtex::search::CSearcher 所有成员的列表。

公有成员

 CIndexSearcher (void)
 CIndexSearcher (const tchar *indexName)
 CIndexSearcher (CIndexReader *pIndexReader)
virtual ~CIndexSearcher (void)
CQueryHitssearch (CQuery *pQuery, int nDocs)
CQueryHitssearch (CQuery *pQuery, CFilter *pFilter, int nDocs)
CQueryHitssearch (CQuery *pQuery, CFilter *pFilter, int nDocs, CSort *pSort)
CQueryoptimizeQuery (CQuery *pOrgQuery)
freq_t docFreq (CTerm *t)
CTermReadertermReader () const
CNormBytesnorms (const tchar *field)
count_t maxDocs ()
void attachReader (CIndexReader *pIndexReader)
CIndexReaderdetachReader ()
document::CDocumentdoc (docid_t docID)

构造及析构函数文档

firtex::search::CIndexSearcher::CIndexSearcher void   ) 
 

firtex::search::CIndexSearcher::CIndexSearcher const tchar *  indexName  ) 
 

firtex::search::CIndexSearcher::CIndexSearcher CIndexReader pIndexReader  ) 
 

virtual firtex::search::CIndexSearcher::~CIndexSearcher void   )  [virtual]
 


成员函数文档

void firtex::search::CIndexSearcher::attachReader CIndexReader pIndexReader  ) 
 

捆绑索引器

参数:
pIndex 索引器,由内部维护,外部不能删除

CIndexReader* firtex::search::CIndexSearcher::detachReader  ) 
 

释放索引器,释放后外部负责维护索引器,CIndexWriter不再持有该索引器

返回:
索引器,外部维护

document::CDocument* firtex::search::CIndexSearcher::doc docid_t  docID  )  [inline, virtual]
 

返回文档docID的stored fields

参数:
docID 文档编号
文档对象,外部维护 

实现了firtex::search::CSearcher

freq_t firtex::search::CIndexSearcher::docFreq CTerm t  )  [virtual]
 

获取指定Term的文档频率

参数:
t Term对象
返回:
文档频率

实现了firtex::search::CSearcher

count_t firtex::search::CIndexSearcher::maxDocs  )  [inline, virtual]
 

返回可能最大的文档编号,一般情况下如果没有删除文档则maxDoc()=numDocs() 可以用来决定分配文档数组的大小

实现了firtex::search::CSearcher

CNormBytes* firtex::search::CIndexSearcher::norms const tchar *  field  )  [virtual]
 

获取指定域的norms bytes

参数:
field 域名
返回:
返回域的norms bytes,内存由内部维护

实现了firtex::search::CSearcher

CQuery* firtex::search::CIndexSearcher::optimizeQuery CQuery pOrgQuery  )  [virtual]
 

对查询进行优化,生成新的查询对象

参数:
pOrgQuery 需要优化的查询对象
返回:
优化后的新的查询对象,默认情况下返回自身 非内部对象,外部需要删除

实现了firtex::search::CSearcher

CQueryHits* firtex::search::CIndexSearcher::search CQuery pQuery,
CFilter pFilter,
int  nDocs,
CSort pSort
 

索引检索

参数:
pQuery 查询对象
pFilter 过滤对象,不在pFilter之列的文档将被过滤,不作为内部对象,需外部删除
nDocs 需要检索返回的文档数
pSort 外部排序对象,Hits结果将以pSort指定的方式排序
返回:
检索结果集,由外部删除

CQueryHits* firtex::search::CIndexSearcher::search CQuery pQuery,
CFilter pFilter,
int  nDocs
 

索引检索

参数:
pQuery 查询对象
pFilter 过滤对象,不在pFilter之列的文档将被过滤,不作为内部对象,需外部删除
nDocs 需要检索返回的文档数
返回:
检索结果集,由外部删除

CQueryHits* firtex::search::CIndexSearcher::search CQuery pQuery,
int  nDocs
[virtual]
 

索引检索

参数:
pQuery 查询对象
nDocs 需要检索返回的文档数
返回:
检索结果集,由外部删除

实现了firtex::search::CSearcher

CTermReader* firtex::search::CIndexSearcher::termReader  )  const [virtual]
 

获取索引的Term Reader对象

返回:
Term Reader 对象,内部维护

实现了firtex::search::CSearcher


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

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