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

API Documentation

firtex::store::CIndexOutput类参考

#include <IndexOutput.h>

继承图，类firtex::store::CIndexOutput


公有成员
	CIndexOutput (char *buffer, size_t buffsize)
	CIndexOutput (size_t buffsize=0)
virtual	~CIndexOutput (void)
void	write (CIndexInput *pInput, int64_t length)
void	write (const char *data, size_t length)
void	writeByte (byte b)
void	writeBytes (byte *b, size_t length)
void	writeInt (int32_t i)
void	writeVInt (int32_t i)
void	writeLong (int64_t i)
void	writeVLong (int64_t i)
void	writeString (const CFXString &s)
void	writeChars (const char *s, size_t start, size_t length)
byte	getVIntLength (int32_t i)
void	setBuffer (char *buf, size_t bufSize)
int64_t	getFilePointer ()
virtual void	flushBuffer (char *b, size_t len)=0
virtual int64_t	length ()=0
virtual void	close ()
virtual void	seek (int64_t pos)
保护成员
void	flush ()
保护属性
char *	m_buffer
size_t	m_buffersize
int64_t	m_bufferStart
size_t	m_bufferPosition
bool	m_bOwnBuff

构造及析构函数文档

firtex::store::CIndexOutput::CIndexOutput ( char * buffer,

size_t buffsize

)

firtex::store::CIndexOutput::CIndexOutput ( size_t buffsize = 0 )

virtual firtex::store::CIndexOutput::~CIndexOutput ( void ) [virtual]

成员函数文档

virtual void firtex::store::CIndexOutput::close ( ) [virtual]

关闭文件,释放资源,子类可以重载此函数但必须显式调用CIndexOutput::close()
被firtex::store::CFSIndexOutput及firtex::store::CRAMIndexOutput重载。

void firtex::store::CIndexOutput::flush ( ) [inline, protected]

virtual void firtex::store::CIndexOutput::flushBuffer ( char * b,

size_t len

) [pure virtual]

实现写buffer操作，在当前位置写数据，纯虚函数由子类实现
参数:

b 数据buffer

len b的长度

在firtex::store::CFSIndexOutput及firtex::store::CRAMIndexOutput内被实现。

int64_t firtex::store::CIndexOutput::getFilePointer ( ) [inline]

返回文件的当前位置

byte firtex::store::CIndexOutput::getVIntLength ( int32_t i ) [inline]

获取4字节整数变长存储的长度

virtual int64_t firtex::store::CIndexOutput::length ( ) [pure virtual]

返回文件长度
在firtex::store::CFSIndexOutput及firtex::store::CRAMIndexOutput内被实现。

virtual void firtex::store::CIndexOutput::seek ( int64_t pos ) [virtual]

文件定位，子类需重载,必须显式调用CIndexOutput::seek()
参数:

pos 定位位置

被firtex::store::CFSIndexOutput及firtex::store::CRAMIndexOutput重载。

void firtex::store::CIndexOutput::setBuffer ( char * buf,

size_t bufSize

) [inline]

设置内部buffer

void firtex::store::CIndexOutput::write ( const char * data,

size_t length

) [inline]

写数据到文件
参数:

data 数据块地址

length 数据长度

void firtex::store::CIndexOutput::write ( CIndexInput * pInput,

int64_t length

)

从文件中读取数据并写到新文件
参数:

pos 定位位置

void firtex::store::CIndexOutput::writeByte ( byte b ) [inline]

写一个字节

void firtex::store::CIndexOutput::writeBytes ( byte * b,

size_t length

) [inline]

写多个个字节

void firtex::store::CIndexOutput::writeChars ( const char * s,

size_t start,

size_t length

) [inline]

以UTF-8编码写字符序列
参数:

s 字符串

start 开始位置

length 长度