CLucene - a full-featured, c++ search engine
API Documentation


lucene::store::IndexInputStream Class Reference

JStream InputStream which reads from an IndexInput. More...

#include <IndexInput.h>

Inheritance diagram for lucene::store::IndexInputStream:

jstreams::BufferedInputStream< char > jstreams::StreamBase< char >

Public Member Functions

 IndexInputStream (IndexInput *input)
 ~IndexInputStream ()
int32_t fillBuffer (char *start, int32_t space)
 This function must be implemented by the subclasses.

Detailed Description

JStream InputStream which reads from an IndexInput.

This class is used by the FieldReader to create binary fields. You can then use a GZipInputStream to read compressed data or any of the other JStream stream types.


Constructor & Destructor Documentation

lucene::store::IndexInputStream::IndexInputStream ( IndexInput input  ) 

lucene::store::IndexInputStream::~IndexInputStream (  ) 


Member Function Documentation

int32_t lucene::store::IndexInputStream::fillBuffer ( char *  start,
int32_t  space 
) [virtual]

This function must be implemented by the subclasses.

It should write a maximum of space characters at the buffer position pointed to by start. If no more data is avaiable due to end of file, -1 should be returned. If an error occurs, the status should be set to Error, an error message should be set and the function must return -1.

Implements jstreams::BufferedInputStream< char >.


The documentation for this class was generated from the following file:

clucene.sourceforge.net