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

API Documentation

firtex::document::CDocument类参考

#include <Document.h>

所有成员的列表。

公有成员

CDocument ()

~CDocument ()

void docID (docid_t did)

docid_t docID ()

float getBoost ()

void setBoost (float fBoost)

void setSchema (const CDocumentSchema &schema)

void setSchema (CDocumentSchema *schema)

CDocumentSchema * getSchema ()

void appendSchema (const CDocumentSchema &schema, bool bTail=true)

int addField (CField *pField)

void addField (fieldid_t id, const char *value)

void addField (fieldid_t id, const wchar_t *value)

void addField (fieldid_t id, char *value, size_t len, bool bNoCopy)

void addField (fieldid_t id, wchar_t *value, size_t len, bool bNoCopy)

void addField (fieldid_t id, const str_t &value, bool bNoCopy)

void addField (fieldid_t id, const wstr_t &value, bool bNoCopy)

void addField (fieldid_t id, CReader *reader, bool bDelete)

void addField (fieldid_t id, const CNumber &number)

void addField (fieldid_t id, const numbervar &number)

void addField (fieldid_t id, const datarecord &datarec, bool bNoCopy)

void removeField (const tchar *name)

void removeField (CField *pField)

CField * operator[] (int order)

CField * operator[] (const tchar *name)

CField * getField (const tchar *name)

CField * getField (int order)

bool isModified ()

void setModify (bool bMod=true)

void clear ()

void startIterator ()

bool hasNext ()

CField * next ()

保护成员

void applySchema ()

构造及析构函数文档

firtex::document::CDocument::CDocument ( )

firtex::document::CDocument::~CDocument ( )

成员函数文档

void firtex::document::CDocument::addField ( fieldid_t id,

const datarecord & datarec,

bool bNoCopy

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const numbervar & number

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const CNumber & number

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

CReader * reader,

bool bDelete

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const wstr_t & value,

bool bNoCopy

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const str_t & value,

bool bNoCopy

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

wchar_t * value,

size_t len,

bool bNoCopy

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

char * value,

size_t len,

bool bNoCopy

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const wchar_t * value

) [inline]

void firtex::document::CDocument::addField ( fieldid_t id,

const char * value

) [inline]

根据字段编号添加字段值到指定字段，必须在调用setSchema()设置文档模式后方可调用下列函数，

参数:

id 字段编号，编号值和setSchema(const CDocumentSchema& schema)的schema参数的字段编号一致

bNoCopy 是否拷贝对应参数的内容

int firtex::document::CDocument::addField ( CField * pField ) [inline]

添加文档字段
参数:

pField 待添加字段，由内部负责删除

void firtex::document::CDocument::appendSchema ( const CDocumentSchema & schema,

bool bTail = true

)

添加Schema,添加的Schema将与已有的Schema合并,必须在使用CDocument对象前调用,调用后CDocument内部已存在的字段信息将清除
参数:

schema schema对象

bTail true 则添加到已有schema的尾部,false 则添加到头部,默认添加到尾部

void firtex::document::CDocument::applySchema ( ) [protected]

void firtex::document::CDocument::clear ( )

清除文档的所有字段信息

docid_t firtex::document::CDocument::docID ( ) [inline]

void firtex::document::CDocument::docID ( docid_t did ) [inline]

获取/设置文档的ID

float firtex::document::CDocument::getBoost ( ) [inline]

获取/设置文档的boost值,boost值用于检索时的文档打分, boost越高,就越能提升文档的分值,默认情况下boost为1.0

CField * firtex::document::CDocument::getField ( int order ) [inline]

CField* firtex::document::CDocument::getField ( const tchar * name )

根据字段名获取字段
参数:

name 字段名

返回:
字段对象,如不存在名为name的字段则返回NULL

CDocumentSchema* firtex::document::CDocument::getSchema ( ) [inline]

获取文档的schema

bool firtex::document::CDocument::hasNext ( ) [inline]

bool firtex::document::CDocument::isModified ( ) [inline]

判断文档是否已经修改
返回:
true:文档已经修改 false 文档未修改

CField* firtex::document::CDocument::next ( ) [inline]

CField * firtex::document::CDocument::operator[] ( const tchar * name ) [inline]

CField * firtex::document::CDocument::operator[] ( int order ) [inline]

void firtex::document::CDocument::removeField ( CField * pField )

清除指定字段
参数:

pField 字段指针

void firtex::document::CDocument::removeField ( const tchar * name )

根据字段名清除指定字段
参数:

name 字段名

void firtex::document::CDocument::setBoost ( float fBoost ) [inline]

void firtex::document::CDocument::setModify ( bool bMod = true ) [inline]

设置文档已修改标志
参数:

bMod 设置还是清除文档标志，true设置,false清除,默认为设置

void firtex::document::CDocument::setSchema ( CDocumentSchema * schema )

设置文档的schema,必须在使用CDocument对象前调用,调用后CDocument内部已存在的字段信息将清除
参数:

schema schema对象,不作为内部对象

void firtex::document::CDocument::setSchema ( const CDocumentSchema & schema )

设置文档的schema,必须在使用CDocument对象前调用,调用后CDocument内部已存在的字段信息将清除
参数:

schema schema对象，内部拷贝一份作为内部对象

void firtex::document::CDocument::startIterator ( ) [inline]

以迭代方式访问文档的各个字段

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

include/document/Document.h

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


公有成员
	CDocument ()
	~CDocument ()
void	docID (docid_t did)
docid_t	docID ()
float	getBoost ()
void	setBoost (float fBoost)
void	setSchema (const CDocumentSchema &schema)
void	setSchema (CDocumentSchema *schema)
CDocumentSchema *	getSchema ()
void	appendSchema (const CDocumentSchema &schema, bool bTail=true)
int	addField (CField *pField)
void	addField (fieldid_t id, const char *value)
void	addField (fieldid_t id, const wchar_t *value)
void	addField (fieldid_t id, char *value, size_t len, bool bNoCopy)
void	addField (fieldid_t id, wchar_t *value, size_t len, bool bNoCopy)
void	addField (fieldid_t id, const str_t &value, bool bNoCopy)
void	addField (fieldid_t id, const wstr_t &value, bool bNoCopy)
void	addField (fieldid_t id, CReader *reader, bool bDelete)
void	addField (fieldid_t id, const CNumber &number)
void	addField (fieldid_t id, const numbervar &number)
void	addField (fieldid_t id, const datarecord &datarec, bool bNoCopy)
void	removeField (const tchar *name)
void	removeField (CField *pField)
CField *	operator[] (int order)
CField *	operator[] (const tchar *name)
CField *	getField (const tchar *name)
CField *	getField (int order)
bool	isModified ()
void	setModify (bool bMod=true)
void	clear ()
void	startIterator ()
bool	hasNext ()
CField *	next ()
保护成员
void	applySchema ()