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

API Documentation

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

firtex::search::CQuery类参考

#include <Query.h>

继承图，类firtex::search::CQuery

firtex::search::CBooleanQuery firtex::search::CPhraseQuery firtex::search::CRangeQuery firtex::search::CTermQuery 所有成员的列表。

公有成员

 CQuery (void)
virtual ~CQuery (void)
float getBoost ()
void setBoost (float fBoost)
CWeight * weight (CSearcher *pSearcher)
bool instanceOf (const tchar *other)
CSimilarity * getSimilarity (CSearcher *pSearcher)
virtual CQuery * optimize (firtex::index::CIndexReader *pReader)
virtual CWeight * createWeight (CSearcher *pSearcher)
virtual CScorer * scorer (CSearcher *pSearcher)
virtual CQuery * clone ()=0
virtual const tchar * getQueryName () const =0

保护属性

float m_fBoost

构造及析构函数文档

firtex::search::CQuery::CQuery (  void   ) 
 

virtual firtex::search::CQuery::~CQuery (  void   )  [virtual]
 

成员函数文档

virtual CQuery* firtex::search::CQuery::clone (   )  [pure virtual]
 

克隆新的对象,需子类实现 非内部对象,外部删除

在firtex::search::CBooleanQuery、firtex::search::CPhraseQuery、firtex::search::CRangeQuery及firtex::search::CTermQuery内被实现。

virtual CWeight* firtex::search::CQuery::createWeight (  CSearcher *  pSearcher  )  [virtual]
 

创建Query对应的Weight

返回:
Weight对象指针，该对象一般由外部调用create的对象销废

被firtex::search::CBooleanQuery、firtex::search::CPhraseQuery及firtex::search::CTermQuery重载。

float firtex::search::CQuery::getBoost (   )  [inline]
 

获取/设置查询对象的提升值(boost)

virtual const tchar* firtex::search::CQuery::getQueryName (   )  const [pure virtual]
 

获取查询名称标识

在firtex::search::CBooleanQuery、firtex::search::CPhraseQuery、firtex::search::CRangeQuery及firtex::search::CTermQuery内被实现。

CSimilarity* firtex::search::CQuery::getSimilarity (  CSearcher *  pSearcher  ) 
 

获取Similarity组件

参数:
pSearcher 搜索组件指针 内部对象,外部不能删除

bool firtex::search::CQuery::instanceOf (  const tchar *  other  ) 
 

判断是否是某一查询的实例

参数:
other 查询名称

virtual CQuery* firtex::search::CQuery::optimize (  firtex::index::CIndexReader *  pReader  )  [virtual]
 

对查询进行优化,生成新的查询对象,子类可重载,默认情况下返回自身

参数:
pReader 用于访问索引
返回:
优化后的新的查询对象,默认情况下返回自身 非内部对象,外部需要删除

被firtex::search::CBooleanQuery及firtex::search::CRangeQuery重载。

virtual CScorer* firtex::search::CQuery::scorer (  CSearcher *  pSearcher  )  [virtual]
 

返回打分器,需子类实现

参数:
pSearcher 索引搜索器 非内部对象,外部删除

被firtex::search::CBooleanQuery、firtex::search::CPhraseQuery及firtex::search::CTermQuery重载。

void firtex::search::CQuery::setBoost (  float  fBoost  )  [inline]
 

CWeight* firtex::search::CQuery::weight (  CSearcher *  pSearcher  ) 
 

获取查询对象的权重计算部件

参数:
pSearcher 搜索对象指针 非内部对象,需外部删除

成员数据文档

float firtex::search::CQuery::m_fBoost [protected]
 

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

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