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

API Documentation

firtex::store::CIndexInput类参考

#include <IndexInput.h>

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


公有成员
	CIndexInput (char *buffer, size_t buffsize)
	CIndexInput (size_t buffsize=0)
virtual	~CIndexInput (void)
void	read (char *data, size_t length)
byte	readByte ()
void	readBytes (byte *b, size_t offset, size_t len)
int32_t	readInt ()
int32_t	readVInt ()
int64_t	readLong ()
int64_t	readVLong ()
void	readString (string &s)
void	readString (CFXString &s)
void	readChars (char *buffer, size_t start, size_t length)
void	skipVInt (size_t nNum)
int64_t	getFilePointer ()
void	seek (int64_t pos)
bool	isEof ()
int64_t	length () const
void	setLength (int64_t newLen)
void	setBuffer (char *buf, size_t bufSize)
virtual void	readInternal (char *b, size_t offset, size_t length)=0
virtual CIndexInput *	clone (char *buffer, size_t buffsize)=0
virtual CIndexInput *	clone ()=0
virtual void	close ()=0
保护成员
void	refill ()
virtual void	seekInternal (int64_t pos)=0
保护属性
char *	m_buffer
size_t	m_bufferSize
int64_t	m_bufferStart
size_t	m_bufferLength
size_t	m_bufferPosition
int64_t	m_length
bool	m_bOwnBuff
友元
class	CIndexOutput

构造及析构函数文档

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

size_t buffsize

)

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

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

成员函数文档

virtual CIndexInput* firtex::store::CIndexInput::clone ( ) [pure virtual]

克隆一个CIndexInput对象,克隆对象使用自己私有的内存作为缓冲
在firtex::store::CFSIndexInput及firtex::store::CRAMIndexInput内被实现。

virtual CIndexInput* firtex::store::CIndexInput::clone ( char * buffer,

size_t buffsize

) [pure virtual]

克隆一个CIndexInput对象,克隆对象使用buffer作为缓冲
参数:

buffer 克隆对象使用的buffer

buffsize buffer的大小

在firtex::store::CFSIndexInput及firtex::store::CRAMIndexInput内被实现。

virtual void firtex::store::CIndexInput::close ( ) [pure virtual]

关闭文件，子类需实现
在firtex::store::CFSIndexInput及firtex::store::CRAMIndexInput内被实现。

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

返回在文件中的当前位置，下一次读从这个位置开始

bool firtex::store::CIndexInput::isEof ( ) [inline]

判断文件数据是否读完毕

int64_t firtex::store::CIndexInput::length ( ) const [inline]

返回文件长度

void firtex::store::CIndexInput::read ( char * data,

size_t length

)

直接读取数据块
参数:

data 目标数据块首地址

length 目标数据块大小

byte firtex::store::CIndexInput::readByte ( ) [inline]

读一个字节

void firtex::store::CIndexInput::readBytes ( byte * b,

size_t offset,

size_t len

)

读多个字节
参数:

b 读取字节存储位置

offset 存储到b的偏移offset处

len 读取字节数

void firtex::store::CIndexInput::readChars ( char * buffer,

size_t start,

size_t length

) [inline]

读UTF-8编码存储的字符
参数:

buffer 目标地址

start buffer的偏移量

length 长度

参见:
CCacheWriter.writeChars

int32_t firtex::store::CIndexInput::readInt ( ) [inline]

读4个字节

virtual void firtex::store::CIndexInput::readInternal ( char * b,

size_t offset,

size_t length

) [pure virtual]

从文件中当前位置读数据，子类需实现此函数
参数:

b 目标地址

offset b中的偏移量读取长度

在firtex::store::CFSIndexInput及firtex::store::CRAMIndexInput内被实现。

int64_t firtex::store::CIndexInput::readLong ( ) [inline]

读8个字节

void firtex::store::CIndexInput::readString ( CFXString & s ) [inline]

读字符串

void firtex::store::CIndexInput::readString ( string & s ) [inline]

读字符串

int32_t firtex::store::CIndexInput::readVInt ( ) [inline]

读变长存储的4个字节

int64_t firtex::store::CIndexInput::readVLong ( ) [inline]

读变长存储的8个字节

void firtex::store::CIndexInput::refill ( ) [inline, protected]

从文件中中读数据填充到缓冲区中

void firtex::store::CIndexInput::seek ( int64_t pos ) [inline]

设置文件的当前读位置，下一次读从这个位置开始
参数:

pos 定位的位置

virtual void firtex::store::CIndexInput::seekInternal ( int64_t pos ) [protected, pure virtual]

实现文件定位操作，readInternal的读操作从这个位置开始，需子类实现
参数:

pos 定位位置

在firtex::store::CFSIndexInput及firtex::store::CRAMIndexInput内被实现。

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

size_t bufSize

)

设置CIndexInput的读取buffer,只能在CIndexInput 读取任何数据之前使用
参数:

buf buffer地址，不作为内部对象，仍需外部删除

bufSize buf的长度