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

API Documentation


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

firtex::index::CIndexParameter类参考

#include <IndexParameter.h>

所有成员的列表。

公有成员

 CIndexParameter (void)
 CIndexParameter (const CDocumentSchema &schema)
virtual ~CIndexParameter (void)
void setSchema (const CDocumentSchema &schema)
CDocumentSchemagetSchema ()
bool isSchemaModified ()
void setSchemaModified (bool bModified=true)
void addMetadata (schemaid_t id, const string &value)
void addMetadata (schemaid_t id, const char *value)
void addMetadata (schemaid_t id, const wchar_t *value)
void addMetadata (schemaid_t id, char *value, size_t len, bool bNoCopy)
void addMetadata (schemaid_t id, wchar_t *value, size_t len, bool bNoCopy)
void addMetadata (schemaid_t id, const str_t &value, bool bNoCopy)
void addMetadata (schemaid_t id, const wstr_t &value, bool bNoCopy)
void addMetadata (schemaid_t id, const CNumber &number)
void addMetadata (schemaid_t id, const numbervar &number)
void addMetadata (schemaid_t id, const datarecord &datarec, bool bNoCopy)
void startIterator ()
bool hasNext ()
CMetadatanext ()
ParametergetParam ()
void setParam (const char *filename)
void setParam (const wchar_t *filename)
void setParam (char *buffer, size_t len)
int getMetaNum ()
CMetadatagetMetadata (const tchar *name)
CMetadatagetMetadata (schemaid_t id)
void cleanup ()
void applySchema ()


构造及析构函数文档

firtex::index::CIndexParameter::CIndexParameter void   ) 
 

firtex::index::CIndexParameter::CIndexParameter const CDocumentSchema schema  ) 
 

virtual firtex::index::CIndexParameter::~CIndexParameter void   )  [virtual]
 


成员函数文档

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const datarecord datarec,
bool  bNoCopy
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const numbervar number
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const CNumber number
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const wstr_t value,
bool  bNoCopy
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const str_t value,
bool  bNoCopy
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
wchar_t *  value,
size_t  len,
bool  bNoCopy
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
char *  value,
size_t  len,
bool  bNoCopy
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const wchar_t *  value
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const char *  value
[inline]
 

void firtex::index::CIndexParameter::addMetadata schemaid_t  id,
const string &  value
[inline]
 

添加元数据,如果元数据的值存在则自动覆盖,必须在调用setSchema()函数后方可调用下列函数

参数:
id schema id,setSchema()设定的schema的各个schema项的编号,一般按添加顺序递增
bNoCopy 是否拷贝文本或数据内容

void firtex::index::CIndexParameter::applySchema  ) 
 

void firtex::index::CIndexParameter::cleanup  ) 
 

CMetadata* firtex::index::CIndexParameter::getMetadata schemaid_t  id  ) 
 

根据元数据的schema id获取元数据

参数:
id 元数据的schema id
返回:
元数据,不存在则返回NULL

CMetadata* firtex::index::CIndexParameter::getMetadata const tchar *  name  ) 
 

根据元数据名获取元数据

参数:
name 元数据名
返回:
元数据,不存在则返回NULL

int firtex::index::CIndexParameter::getMetaNum  )  [inline]
 

获取元数据个数

返回:
元数据个数

Parameter& firtex::index::CIndexParameter::getParam  )  [inline]
 

获取Parameter值

CDocumentSchema* firtex::index::CIndexParameter::getSchema  )  [inline]
 

获取元数据的Schema

返回:
返回内部schema对象

bool firtex::index::CIndexParameter::hasNext  )  [inline]
 

bool firtex::index::CIndexParameter::isSchemaModified  )  [inline]
 

判断元数据的Schema是否修改

CMetadata* firtex::index::CIndexParameter::next  )  [inline]
 

void firtex::index::CIndexParameter::setParam char *  buffer,
size_t  len
[inline]
 

设置文件内容Buffer参数

参数:
buffer 文件内容
len buffer 长度

void firtex::index::CIndexParameter::setParam const wchar_t *  filename  )  [inline]
 

设置文件路径参数,Unicode

参数:
filename 文件路径名

void firtex::index::CIndexParameter::setParam const char *  filename  )  [inline]
 

设置文件路径参数,ANSI

参数:
filename 文件路径名

void firtex::index::CIndexParameter::setSchema const CDocumentSchema schema  ) 
 

设置元数据的Schema,只有调用此函数后才能根据schema id添加元数据项。

参数:
schema 元数据的模式,内部将拷贝构造一份

void firtex::index::CIndexParameter::setSchemaModified bool  bModified = true  )  [inline]
 

设置元数据的Schema修改标志

参数:
bModified 修改标志,默认为已修改

void firtex::index::CIndexParameter::startIterator  )  [inline]
 


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

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