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

API Documentation

firtex::analyzer::CAnalyzer类参考

#include <Analyzer.h>

继承图，类firtex::analyzer::CAnalyzer


公有成员
	CAnalyzer ()
	CAnalyzer (CParser *pParser)
virtual	~CAnalyzer (void)
virtual tstring	getCategory ()
virtual tstring	getIdentifier ()
void	attachParser (CParser *pParser)
CParser *	detachParser ()
void	attachTokenFilter (CTokenFilter *pTokenFilter)
CTokenFilter *	detachTokenFilter ()
document::CDocument *	analyze (CIndexParameter *pArg)
document::CDocument *	analyze (document::CDocument *pParsedDoc)
CTokens *	nextTokens (CReader reader, CTokens pInput)
virtual void	close ()
virtual TokenType	getTokenType ()=0
静态公有属性
const tstring	category
const tstring	identifier
保护成员
virtual CTokens *	nextTokensInternal (CReader reader, CTokens pInput)=0
CTokens *	tokenFilter (CTokens *pTokensInput)
保护属性
tstring	m_identifier
CTokenFilter *	m_pTokenFilter
CParser *	m_pParser
document::CDocument *	m_pCachedDoc
CReader *	m_reader

构造及析构函数文档

firtex::analyzer::CAnalyzer::CAnalyzer ( )

firtex::analyzer::CAnalyzer::CAnalyzer ( CParser * pParser )

virtual firtex::analyzer::CAnalyzer::~CAnalyzer ( void ) [virtual]

成员函数文档

document::CDocument* firtex::analyzer::CAnalyzer::analyze ( document::CDocument * pParsedDoc )

分析文档
参数:

pParserDoc 原始文档对象

返回:
分析完毕的文档对象

document::CDocument * firtex::analyzer::CAnalyzer::analyze ( CIndexParameter * pArg ) [inline]

分析文档
参数:

pArg 索引参数

返回:
分析完毕的文档对象

void firtex::analyzer::CAnalyzer::attachParser ( CParser * pParser ) [inline]

关联解析器
参数:

pParser 解析器指针，关联以后由CAnalyzer负责删除

void firtex::analyzer::CAnalyzer::attachTokenFilter ( CTokenFilter * pTokenFilter )

关联Token Filter,一般用于停用词
参数:

pTokenFilter Token Filter,关联以后由CAnalyzer负责删除

virtual void firtex::analyzer::CAnalyzer::close ( ) [virtual]

关闭分析器,释放资源,子类重载后需显式调用CAnalyzer::close()
被firtex::analyzer::CChineseAnalyzer及firtex::analyzer::CDateTimeAnalyzer重载。

CParser* firtex::analyzer::CAnalyzer::detachParser ( )

撤销解析器关联，撤销后由外部负责解析器的资源释放

CTokenFilter* firtex::analyzer::CAnalyzer::detachTokenFilter ( )

撤销Token Filter关联，撤销后由外部负责解析器的资源释放

virtual tstring firtex::analyzer::CAnalyzer::getCategory ( ) [inline, virtual]

获取对象分类名

virtual tstring firtex::analyzer::CAnalyzer::getIdentifier ( ) [inline, virtual]

获取对象标识

virtual TokenType firtex::analyzer::CAnalyzer::getTokenType ( ) [pure virtual]

返回Analyzer可以处理的Token类型
返回:
Token 类型,{

参见:
TokenType}

在firtex::analyzer::CChineseAnalyzer、firtex::analyzer::CDateTimeAnalyzer及firtex::plugin::CAnalyzerPlugin内被实现。

CTokens * firtex::analyzer::CAnalyzer::nextTokens ( CReader * reader,

CTokens * pInput

) [inline]

取一批分析完毕的Token，由派生的Analyzer实现
参数:

reader 读取器，用于读取原始文档

pInput 外部提供的tokens 容器，可为空

返回:
tokens容器，如果pInput不为空，则返回pInput，否则返回内部创建的tokens容器

被firtex::analyzer::CDateTimeAnalyzer重载。

virtual CTokens* firtex::analyzer::CAnalyzer::nextTokensInternal ( CReader * reader,

CTokens * pInput

) [protected, pure virtual]

取一批分析完毕的Token，由派生的Analyzer实现
参数:

reader 读取器，用于读取原始文档

pInput 外部提供的tokens 容器，可为空

返回:
tokens容器，如果pInput不为空，则返回pInput，否则返回内部创建的tokens容器

在firtex::analyzer::CChineseAnalyzer及firtex::plugin::CAnalyzerPlugin内被实现。