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

API Documentation

firtex::document::CField类参考

#include <Field.h>

所有成员的列表。

公有成员

CField (const tchar *name, const char *value, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, const wchar_t *value, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, CReader *reader, bool bDelete, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, char *text, size_t length, bool bNoCopy, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, wchar_t *text, size_t length, bool bNoCopy, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, byte *value, size_t length, bool bNoCopy, Store_ store, float fBoost=1.0)

CField (const tchar *name, CTokens *value, bool bDelete, TermVector_ termVector, float fBoost=1.0)

CField (const tchar *name, const numbervar &nvar, Store_ store, Index_ index, float fBoost=1.0)

CField (const CField &clone)

CField (fieldid_t id, const tchar *name, FieldType ft, Store_ store, Index_ index, TermVector_ tv, float fBoost=1.0)

virtual ~CField ()

fieldid_t getID ()

void setID (fieldid_t fid)

CFXString & getName ()

FieldType getFieldType () const

void setFieldType (FieldType type)

fielddata_t getDataType () const

Index_ getIndex ()

Store_ getStore ()

TermVector_ getTermVector ()

void fromFlag (FieldFlag flag)

FieldFlag toFlag ()

datarecord & binaryValue ()

CFXStringA * textValue ()

CFXStringW * textWValue ()

numbervar & numberValue ()

CReader * readerValue ()

CTokens * tokensValue ()

void textValue (char *text, size_t len, bool bNoCopy=true)

void textValue (wchar_t *text, size_t len, bool bNoCopy=true)

void textValue (const str_t &str, bool bNoCopy=true)

void textValue (const wstr_t &wstr, bool bNoCopy=true)

void binaryValue (byte *data, size_t len, bool bNoCopy=true)

void binaryValue (const datarecord &dr, bool bNoCopy=true)

void numberValue (const numbervar &num)

void readerValue (CReader *reader, bool bDelete=false)

void tokensValue (CTokens *tokens, bool bDelete=true)

CFieldData & getData ()

void setData (CFieldData &data)

void setBoost (float fBoost)

float getBoost ()

bool isIndexed ()

bool isAnalyzed ()

bool isStored ()

bool isCompressed ()

bool isStoreTermVector ()

CField * clone ()

静态公有成员

CField * Keyword (const tchar *name, const char *value, FieldType ft, float fBoost=1.0)

CField * Keyword (const tchar *name, const wchar_t *value, FieldType ft, float fBoost=1.0)

CField * Keyword (const tchar *name, const CDateTime &value, float fBoost=1.0)

CField * Keyword (const tchar *name, const numbervar &value, float fBoost=1.0)

CField * UnIndexed (const tchar *name, const char *value, float fBoost=1.0)

CField * UnIndexed (const tchar *name, const wchar_t *value, float fBoost=1.0)

CField * UnIndexed (const tchar *name, CReader *value, bool bDelete=false, float fBoost=1.0)

CField * UnIndexed (const tchar *name, char *text, size_t length, bool bNoCopy=false, float fBoost=1.0)

CField * UnIndexed (const tchar *name, wchar_t *text, size_t length, bool bNoCopy=false, float fBoost=1.0)

CField * UnIndexed (const tchar *name, const str_t &value, bool bNoCopy=true, float fBoost=1.0)

CField * Text (const tchar *name, const char *value, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Text (const tchar *name, const wchar_t *value, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Text (const tchar *name, CReader *value, bool bDelete=false, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Text (const tchar *name, char *text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Text (const tchar *name, wchar_t *text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Text (const tchar *name, const str_t &value, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, const char *value, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, const wchar_t *value, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, CReader *value, bool bDelete=false, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, char *text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, wchar_t *text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * UnStored (const tchar *name, const str_t &value, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

CField * Binary (const tchar *name, byte *value, size_t length, bool bNoCopy, bool bCompress, float fBoost=1.0)

CField * Binary (const tchar *name, const datarecord &dr, bool bNoCopy, bool bCompress, float fBoost=1.0)

CField * Tokens (const tchar *name, CTokens *value, bool bDelete=true, TermVector_ termVector=TermVector::NO, float fBoost=1.0)

构造及析构函数文档

firtex::document::CField::CField ( const tchar * name,

const char * value,

FieldType ft,

Store_ store,

Index_ index,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value 字符串值

store 存储方式

index 索引方式

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

const wchar_t * value,

FieldType ft,

Store_ store,

Index_ index,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value 宽字符字符串值

store 存储方式

index 索引方式

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

CReader * reader,

bool bDelete,

Store_ store,

Index_ index,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value 文本reader

bDelete 是否由内部删除

store 存储方式

index 索引方式

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

char * text,

size_t length,

bool bNoCopy,

FieldType ft,

Store_ store,

Index_ index,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value 文本

length 文本长度

bNoCopy 是否拷贝文本

store 存储方式

index 索引方式

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

wchar_t * text,

size_t length,

bool bNoCopy,

FieldType ft,

Store_ store,

Index_ index,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value 文本

length 文本长度

bNoCopy 是否拷贝文本

store 存储方式

index 索引方式

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

byte * value,

size_t length,

bool bNoCopy,

Store_ store,

float fBoost = 1.0

)

参数:

name 字段名

value 二进制值

length 二进制长度

bNoCopy 是否拷贝二进制

store 存储方式

firtex::document::CField::CField ( const tchar * name,

CTokens * value,

bool bDelete,

TermVector_ termVector,

float fBoost = 1.0

)

参数:

name 字段名

value Token值

bDelete 是否由内部删除Token对象

termVector 词向量方式

firtex::document::CField::CField ( const tchar * name,

const numbervar & nvar,

Store_ store,

Index_ index,

float fBoost = 1.0

)

参数:

name 字段名

nvar 数字值

store 存储方式

index 索引方式

firtex::document::CField::CField ( const CField & clone )

拷贝构造函数

firtex::document::CField::CField ( fieldid_t id,

const tchar * name,

FieldType ft,

Store_ store,

Index_ index,

TermVector_ tv,

float fBoost = 1.0

)

构造一个值为空的字段
参数:

id 字段id

name 字段名

store 存储方式

index 索引方式

termVector 词向量方式

virtual firtex::document::CField::~CField ( ) [virtual]

成员函数文档

CField* firtex::document::CField::Binary ( const tchar * name,

const datarecord & dr,

bool bNoCopy,

bool bCompress,

float fBoost = 1.0

) [inline, static]

构造一个二进制类型的索引字段，该字段存储，不分析不索引无词向量
参数:

name 字段名

dr 二进制值

bNoCopy 是否拷贝二进制值

bCompress 是否压缩

返回:
字段对象

CField* firtex::document::CField::Binary ( const tchar * name,

byte * value,

size_t length,

bool bNoCopy,

bool bCompress,

float fBoost = 1.0

) [inline, static]

构造一个二进制类型的索引字段，该字段存储，不分析不索引无词向量
参数:

name 字段名

value 二进制值

length value 的长度

bNoCopy 是否拷贝二进制值

bCompress 是否压缩

返回:
字段对象

void firtex::document::CField::binaryValue ( const datarecord & dr,

bool bNoCopy = true

) [inline]

void firtex::document::CField::binaryValue ( byte * data,

size_t len,

bool bNoCopy = true

) [inline]

datarecord & firtex::document::CField::binaryValue ( ) [inline]

CField* firtex::document::CField::clone ( ) [inline]

浅克隆一个CField对象，不拷贝数据部分
返回:
返回新的字段对象,由外部删除

void firtex::document::CField::fromFlag ( FieldFlag flag )

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

CFieldData& firtex::document::CField::getData ( ) [inline]

fielddata_t firtex::document::CField::getDataType ( ) const [inline]

FieldType firtex::document::CField::getFieldType ( ) const [inline]

fieldid_t firtex::document::CField::getID ( ) [inline]

Index_ firtex::document::CField::getIndex ( ) [inline]

CFXString& firtex::document::CField::getName ( ) [inline]

Store_ firtex::document::CField::getStore ( ) [inline]

TermVector_ firtex::document::CField::getTermVector ( ) [inline]

bool firtex::document::CField::isAnalyzed ( ) [inline]

bool firtex::document::CField::isCompressed ( ) [inline]

bool firtex::document::CField::isIndexed ( ) [inline]

bool firtex::document::CField::isStored ( ) [inline]

bool firtex::document::CField::isStoreTermVector ( ) [inline]

CField* firtex::document::CField::Keyword ( const tchar * name,

const numbervar & value,

float fBoost = 1.0

) [inline, static]

构造一个时间日期类型的关键字字段，该字段索引、存储但不分析无词向量
参数:

name 字段名

value 时间日期值

返回:
字段对象

CField* firtex::document::CField::Keyword ( const tchar * name,

const CDateTime & value,

float fBoost = 1.0

) [inline, static]

构造一个时间日期类型的关键字字段，该字段索引、存储但不分析无词向量
参数:

name 字段名

value 时间日期值

返回:
字段对象

CField* firtex::document::CField::Keyword ( const tchar * name,

const wchar_t * value,

FieldType ft,

float fBoost = 1.0

) [inline, static]

构造一个字符串类型的关键字字段，该字段索引、存储但不分析无词向量
参数:

name 字段名

value 字符串值

返回:
字段对象

CField* firtex::document::CField::Keyword ( const tchar * name,

const char * value,

FieldType ft,

float fBoost = 1.0

) [inline, static]

构造一个字符串类型的关键字字段，该字段索引、存储但不分析,无词向量
参数:

name 字段名

value 字符串值

返回:
字段对象

void firtex::document::CField::numberValue ( const numbervar & num ) [inline]

numbervar & firtex::document::CField::numberValue ( ) [inline]

void firtex::document::CField::readerValue ( CReader * reader,

bool bDelete = false

) [inline]

CReader * firtex::document::CField::readerValue ( ) [inline]

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

void firtex::document::CField::setData ( CFieldData & data ) [inline]

void firtex::document::CField::setFieldType ( FieldType type ) [inline]

void firtex::document::CField::setID ( fieldid_t fid ) [inline]

CField* firtex::document::CField::Text ( const tchar * name,

const str_t & value,

bool bNoCopy = true,

FieldType ft = FIELD_WORD,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的索引字段，该字段分析，索引，存储、词向量可选
参数:

name 字段名

value 文本

bNoCopy 是否拷贝文本

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

CField* firtex::document::CField::Text ( const tchar * name,

wchar_t * text,

size_t length,

bool bNoCopy = true,

FieldType ft = FIELD_WORD,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的索引字段，该字段分析，索引，存储、词向量可选
参数:

name 字段名

value 文本

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

CField* firtex::document::CField::Text ( const tchar * name,

char * text,

size_t length,

bool bNoCopy = true,

FieldType ft = FIELD_WORD,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的索引字段，该字段分析，索引，存储、词向量可选
参数:

name 字段名

value 文本

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

CField* firtex::document::CField::Text ( const tchar * name,

CReader * value,

bool bDelete = false,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个reader类型的索引字段，该字段分析，索引，存储和词向量可选
参数:

name 字段名

value reader

bDelete 是否由内部删除

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

CField* firtex::document::CField::Text ( const tchar * name,

const wchar_t * value,

FieldType ft = FIELD_WORD,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的索引字段，该字段分析，索引，存储和词向量可选
参数:

name 字段名

value 文本

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

CField* firtex::document::CField::Text ( const tchar * name,

const char * value,

FieldType ft = FIELD_WORD,

Store_ store = Store::NO,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的索引字段，该字段分析，索引，存储和词向量可选
参数:

name 字段名

value 文本

store 存储方式，默认不存储

termVector 词向量方式，默认无词向量

返回:
字段对象

void firtex::document::CField::textValue ( const wstr_t & wstr,

bool bNoCopy = true

) [inline]

void firtex::document::CField::textValue ( const str_t & str,

bool bNoCopy = true

) [inline]

void firtex::document::CField::textValue ( wchar_t * text,

size_t len,

bool bNoCopy = true

) [inline]

void firtex::document::CField::textValue ( char * text,

size_t len,

bool bNoCopy = true

) [inline]

CFXString * firtex::document::CField::textValue ( ) [inline]

CFXStringW * firtex::document::CField::textWValue ( ) [inline]

FieldFlag firtex::document::CField::toFlag ( )

CField* firtex::document::CField::Tokens ( const tchar * name,

CTokens * value,

bool bDelete = true,

TermVector_ termVector = TermVector::NO,

float fBoost = 1.0

) [inline, static]

构造一个Token类型的索引字段，该字段不存储不分析不索引，词向量可选
参数:

name 字段名

value Token值

bDelete 是否由内部删除Token值

termVector 词向量方式，默认为无词向量

返回:
字段对象

void firtex::document::CField::tokensValue ( CTokens * tokens,

bool bDelete = true

) [inline]

CTokens * firtex::document::CField::tokensValue ( ) [inline]

CField* firtex::document::CField::UnIndexed ( const tchar * name,

const str_t & value,

bool bNoCopy = true,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的非索引字段，该字段存储、但不分析不索引无词向量
参数:

name 字段名

value 文本

bNoCopy 是否拷贝文本

返回:
字段对象

CField* firtex::document::CField::UnIndexed ( const tchar * name,

wchar_t * text,

size_t length,

bool bNoCopy = false,

float fBoost = 1.0

) [inline, static]

构造一个文本类型的非索引字段，该字段存储、但不分析不索引无词向量
参数:

name 字段名

text 文本

length 文本长度

bNoCopy 是否拷贝文本

返回:
字段对象


公有成员
	CField (const tchar name, const char value, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar name, const wchar_t value, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar name, CReader reader, bool bDelete, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar name, char text, size_t length, bool bNoCopy, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar name, wchar_t text, size_t length, bool bNoCopy, FieldType ft, Store_ store, Index_ index, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar name, byte value, size_t length, bool bNoCopy, Store_ store, float fBoost=1.0)
	CField (const tchar name, CTokens value, bool bDelete, TermVector_ termVector, float fBoost=1.0)
	CField (const tchar *name, const numbervar &nvar, Store_ store, Index_ index, float fBoost=1.0)
	CField (const CField &clone)
	CField (fieldid_t id, const tchar *name, FieldType ft, Store_ store, Index_ index, TermVector_ tv, float fBoost=1.0)
virtual	~CField ()
fieldid_t	getID ()
void	setID (fieldid_t fid)
CFXString &	getName ()
FieldType	getFieldType () const
void	setFieldType (FieldType type)
fielddata_t	getDataType () const
Index_	getIndex ()
Store_	getStore ()
TermVector_	getTermVector ()
void	fromFlag (FieldFlag flag)
FieldFlag	toFlag ()
datarecord &	binaryValue ()
CFXStringA *	textValue ()
CFXStringW *	textWValue ()
numbervar &	numberValue ()
CReader *	readerValue ()
CTokens *	tokensValue ()
void	textValue (char *text, size_t len, bool bNoCopy=true)
void	textValue (wchar_t *text, size_t len, bool bNoCopy=true)
void	textValue (const str_t &str, bool bNoCopy=true)
void	textValue (const wstr_t &wstr, bool bNoCopy=true)
void	binaryValue (byte *data, size_t len, bool bNoCopy=true)
void	binaryValue (const datarecord &dr, bool bNoCopy=true)
void	numberValue (const numbervar &num)
void	readerValue (CReader *reader, bool bDelete=false)
void	tokensValue (CTokens *tokens, bool bDelete=true)
CFieldData &	getData ()
void	setData (CFieldData &data)
void	setBoost (float fBoost)
float	getBoost ()
bool	isIndexed ()
bool	isAnalyzed ()
bool	isStored ()
bool	isCompressed ()
bool	isStoreTermVector ()
CField *	clone ()
静态公有成员
CField *	Keyword (const tchar name, const char value, FieldType ft, float fBoost=1.0)
CField *	Keyword (const tchar name, const wchar_t value, FieldType ft, float fBoost=1.0)
CField *	Keyword (const tchar *name, const CDateTime &value, float fBoost=1.0)
CField *	Keyword (const tchar *name, const numbervar &value, float fBoost=1.0)
CField *	UnIndexed (const tchar name, const char value, float fBoost=1.0)
CField *	UnIndexed (const tchar name, const wchar_t value, float fBoost=1.0)
CField *	UnIndexed (const tchar name, CReader value, bool bDelete=false, float fBoost=1.0)
CField *	UnIndexed (const tchar name, char text, size_t length, bool bNoCopy=false, float fBoost=1.0)
CField *	UnIndexed (const tchar name, wchar_t text, size_t length, bool bNoCopy=false, float fBoost=1.0)
CField *	UnIndexed (const tchar *name, const str_t &value, bool bNoCopy=true, float fBoost=1.0)
CField *	Text (const tchar name, const char value, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Text (const tchar name, const wchar_t value, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Text (const tchar name, CReader value, bool bDelete=false, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Text (const tchar name, char text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Text (const tchar name, wchar_t text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Text (const tchar *name, const str_t &value, bool bNoCopy=true, FieldType ft=FIELD_WORD, Store_ store=Store::NO, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar name, const char value, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar name, const wchar_t value, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar name, CReader value, bool bDelete=false, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar name, char text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar name, wchar_t text, size_t length, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	UnStored (const tchar *name, const str_t &value, bool bNoCopy=true, FieldType ft=FIELD_WORD, TermVector_ termVector=TermVector::NO, float fBoost=1.0)
CField *	Binary (const tchar name, byte value, size_t length, bool bNoCopy, bool bCompress, float fBoost=1.0)
CField *	Binary (const tchar *name, const datarecord &dr, bool bNoCopy, bool bCompress, float fBoost=1.0)
CField *	Tokens (const tchar name, CTokens value, bool bDelete=true, TermVector_ termVector=TermVector::NO, float fBoost=1.0)