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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
Lucene::RAMInputStream Class Reference

A memory-resident IndexInput implementation. More...

#include <RAMInputStream.h>

+ Inheritance diagram for Lucene::RAMInputStream:

Public Member Functions

 RAMInputStream ()
 
 RAMInputStream (const RAMFilePtr &f)
 
virtual ~RAMInputStream ()
 
virtual String getClassName ()
 
boost::shared_ptr< RAMInputStreamshared_from_this ()
 
virtual void close ()
 Closes the stream to further operations.
 
virtual int64_t length ()
 The number of bytes in the file.
 
virtual uint8_t readByte ()
 Reads and returns a single byte.
 
virtual void readBytes (uint8_t *b, int32_t offset, int32_t length)
 Reads a specified number of bytes into an array at the specified offset.
 
virtual int64_t getFilePointer ()
 Returns the current position in this file, where the next read will occur.
 
virtual void seek (int64_t pos)
 Sets current position in this file, where the next read will occur.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Returns a clone of this stream.
 
- Public Member Functions inherited from Lucene::IndexInput
 IndexInput ()
 
virtual ~IndexInput ()
 
boost::shared_ptr< IndexInputshared_from_this ()
 
virtual void readBytes (uint8_t *b, int32_t offset, int32_t length, bool useBuffer)
 Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer). Currently only BufferedIndexInput respects this parameter.
 
virtual int32_t readInt ()
 Reads four bytes and returns an int.
 
virtual int32_t readVInt ()
 Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual int64_t readLong ()
 Reads eight bytes and returns a int64.
 
virtual int64_t readVLong ()
 Reads a int64 stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual void setModifiedUTF8StringsMode ()
 Call this if readString should read characters stored in the old modified UTF8 format. This is used for indices written pre-2.4.
 
virtual String readString ()
 Reads a string.
 
virtual String readModifiedUTF8String ()
 Reads a modified UTF8 format string.
 
virtual int32_t readChars (wchar_t *buffer, int32_t start, int32_t length)
 Reads Lucene's old "modified UTF-8" encoded characters into an array.
 
virtual void skipChars (int32_t length)
 Similar to readChars(wchar_t*, int32_t, int32_t) but does not do any conversion operations on the bytes it is reading in. It still has to invoke readByte() just as readChars(wchar_t*, int32_t, int32_t) does, but it does not need a buffer to store anything and it does not have to do any of the bitwise operations, since we don't actually care what is in the byte except to determine how many more bytes to read.
 
virtual MapStringString readStringStringMap ()
 Read string map as a series of key/value pairs.
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::IndexInput
static String _getClassName ()
 

Static Public Attributes

static const int32_t BUFFER_SIZE
 

Protected Member Functions

void switchCurrentBuffer (bool enforceEOF)
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

RAMFilePtr file
 
int64_t _length
 
ByteArray currentBuffer
 
int32_t currentBufferIndex
 
int32_t bufferPosition
 
int64_t bufferStart
 
int32_t bufferLength
 
- Protected Attributes inherited from Lucene::IndexInput
bool preUTF8Strings
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

A memory-resident IndexInput implementation.

Constructor & Destructor Documentation

◆ RAMInputStream() [1/2]

Lucene::RAMInputStream::RAMInputStream ( )

◆ RAMInputStream() [2/2]

Lucene::RAMInputStream::RAMInputStream ( const RAMFilePtr f)

◆ ~RAMInputStream()

virtual Lucene::RAMInputStream::~RAMInputStream ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::RAMInputStream::_getClassName ( )
inlinestatic

◆ clone()

virtual LuceneObjectPtr Lucene::RAMInputStream::clone ( const LuceneObjectPtr other = LuceneObjectPtr())
virtual

Returns a clone of this stream.

Reimplemented from Lucene::IndexInput.

◆ close()

virtual void Lucene::RAMInputStream::close ( )
virtual

Closes the stream to further operations.

Implements Lucene::IndexInput.

◆ getClassName()

virtual String Lucene::RAMInputStream::getClassName ( )
inlinevirtual

Reimplemented from Lucene::IndexInput.

◆ getFilePointer()

virtual int64_t Lucene::RAMInputStream::getFilePointer ( )
virtual

Returns the current position in this file, where the next read will occur.

See also
seek(int64_t)

Implements Lucene::IndexInput.

◆ length()

virtual int64_t Lucene::RAMInputStream::length ( )
virtual

The number of bytes in the file.

Implements Lucene::IndexInput.

◆ readByte()

virtual uint8_t Lucene::RAMInputStream::readByte ( )
virtual

Reads and returns a single byte.

See also
IndexOutput::writeByte(uint8_t)

Implements Lucene::IndexInput.

◆ readBytes()

virtual void Lucene::RAMInputStream::readBytes ( uint8_t *  b,
int32_t  offset,
int32_t  length 
)
virtual

Reads a specified number of bytes into an array at the specified offset.

Parameters
bthe array to read bytes into.
offsetthe offset in the array to start storing bytes.
lengththe number of bytes to read.
See also
IndexOutput::writeBytes(const uint8_t*,int)

Implements Lucene::IndexInput.

◆ seek()

virtual void Lucene::RAMInputStream::seek ( int64_t  pos)
virtual

Sets current position in this file, where the next read will occur.

See also
getFilePointer()

Implements Lucene::IndexInput.

◆ shared_from_this()

boost::shared_ptr< RAMInputStream > Lucene::RAMInputStream::shared_from_this ( )
inline

◆ switchCurrentBuffer()

void Lucene::RAMInputStream::switchCurrentBuffer ( bool  enforceEOF)
protected

Field Documentation

◆ _length

int64_t Lucene::RAMInputStream::_length
protected

◆ BUFFER_SIZE

const int32_t Lucene::RAMInputStream::BUFFER_SIZE
static

◆ bufferLength

int32_t Lucene::RAMInputStream::bufferLength
protected

◆ bufferPosition

int32_t Lucene::RAMInputStream::bufferPosition
protected

◆ bufferStart

int64_t Lucene::RAMInputStream::bufferStart
protected

◆ currentBuffer

ByteArray Lucene::RAMInputStream::currentBuffer
protected

◆ currentBufferIndex

int32_t Lucene::RAMInputStream::currentBufferIndex
protected

◆ file

RAMFilePtr Lucene::RAMInputStream::file
protected

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

clucene.sourceforge.net