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

API Documentation


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

firtex::utility::CArgument类参考

#include <Argument.h>

所有成员的列表。

公有成员

 CArgument (void)
 ~CArgument (void)
void parseArg (const tchar *argFile)
void saveArg (const tchar *argFile=NULL)
const tstring & getFileName ()
void replaceStdArg ()
void restoreStdArg ()
void resetArg ()

公有属性

firtex::utility::CArgument::scollection collection
firtex::utility::CArgument::sparser parser
firtex::utility::CArgument::sanalyzer analyzer
firtex::utility::CArgument::sindex index
firtex::utility::CArgument::sindexmerger indexmerger
firtex::utility::CArgument::slog log

保护类型

typedef vector< pair< tstring,
TermVector_ > > 
termvector_array

保护成员

void add (const tstring &sName, int64_t *pInt64, int64_t nDefault)
void add (const tstring &sName, int32_t *pInt32, int32_t nDefault)
void add (const tstring &sName, double *pFloat, double nDefault)
void add (const tstring &sName, tstring *pString, const tstring &pszDefault)
void add (const tstring &sName, bool *pBool, bool bDefault=true)
void add (const tstring &sName, termvector_array *pTermVector)

保护属性

firtex::utility::CArgument::sstd_analyzer std_analyzer
firtex::utility::CArgument::sstd_index std_index
firtex::utility::CArgument::sstd_indexmerger std_indexmerger
vector< CArgumentItem * > m_items
tstring m_filename


成员类型定义文档

typedef vector<pair<tstring,TermVector_> > firtex::utility::CArgument::termvector_array [protected]
 


构造及析构函数文档

firtex::utility::CArgument::CArgument void   ) 
 

firtex::utility::CArgument::~CArgument void   ) 
 


成员函数文档

void firtex::utility::CArgument::add const tstring &  sName,
termvector_array pTermVector
[protected]
 

void firtex::utility::CArgument::add const tstring &  sName,
bool *  pBool,
bool  bDefault = true
[protected]
 

void firtex::utility::CArgument::add const tstring &  sName,
tstring *  pString,
const tstring &  pszDefault
[protected]
 

void firtex::utility::CArgument::add const tstring &  sName,
double *  pFloat,
double  nDefault
[protected]
 

void firtex::utility::CArgument::add const tstring &  sName,
int32_t *  pInt32,
int32_t  nDefault
[protected]
 

void firtex::utility::CArgument::add const tstring &  sName,
int64_t *  pInt64,
int64_t  nDefault
[protected]
 

const tstring& firtex::utility::CArgument::getFileName  )  [inline]
 

获取CArgument对应的文件路径名

返回:

void firtex::utility::CArgument::parseArg const tchar *  argFile  ) 
 

分析参数文件

参数:
argFile 参数文件路径
异常:
解释失败则抛出CFirteException 参数文件格式: <collection> <identifier></identifier> </collection> <parser> <identifier></identifier> <termvector> <field></field> <method></method> </termvector> </parser> <analyzer> <identifier></identifier> <stopword></stopword> </analyzer> <index> <src></src> <dst></dst> <append></append> <optimize></optimize> <maxterms></maxterms> <memory></memory> </index> <indexmerge> <factor></factor> <maxbarrels></maxbarrels> </indexmerge> <log></log>

void firtex::utility::CArgument::replaceStdArg  ) 
 

替代GlobalConfig中的标准参数,使设置的标准参数奏效

void firtex::utility::CArgument::resetArg  ) 
 

重新设置参数成默认值

void firtex::utility::CArgument::restoreStdArg  ) 
 

恢复GlobalConfig中的标准参数,使后续操作继续使用标准参数值

void firtex::utility::CArgument::saveArg const tchar *  argFile = NULL  ) 
 

保存参数至文件

参数:
argFile 参数文件路径,如果为NULL则自动保存至parseArg传入的参数文件
异常:
解释失败则抛出CFirteException 


成员数据文档

struct firtex::utility::CArgument::sanalyzer firtex::utility::CArgument::analyzer
 

struct firtex::utility::CArgument::scollection firtex::utility::CArgument::collection
 

struct firtex::utility::CArgument::sindex firtex::utility::CArgument::index
 

struct firtex::utility::CArgument::sindexmerger firtex::utility::CArgument::indexmerger
 

struct firtex::utility::CArgument::slog firtex::utility::CArgument::log
 

tstring firtex::utility::CArgument::m_filename [protected]
 

vector<CArgumentItem*> firtex::utility::CArgument::m_items [protected]
 

struct firtex::utility::CArgument::sparser firtex::utility::CArgument::parser
 

struct firtex::utility::CArgument::sstd_analyzer firtex::utility::CArgument::std_analyzer [protected]
 

struct firtex::utility::CArgument::sstd_index firtex::utility::CArgument::std_index [protected]
 

struct firtex::utility::CArgument::sstd_indexmerger firtex::utility::CArgument::std_indexmerger [protected]
 


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

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