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


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

File used as buffer in RAMDirectory. More...

#include <RAMFile.h>

+ Inheritance diagram for Lucene::RAMFile:

Public Member Functions

 RAMFile ()
 
 RAMFile (const RAMDirectoryPtr &directory)
 
virtual ~RAMFile ()
 
virtual String getClassName ()
 
boost::shared_ptr< RAMFileshared_from_this ()
 
int64_t getLength ()
 For non-stream access from thread that might be concurrent with writing.
 
void setLength (int64_t length)
 
int64_t getLastModified ()
 For non-stream access from thread that might be concurrent with writing.
 
void setLastModified (int64_t lastModified)
 
int64_t getSizeInBytes ()
 
ByteArray addBuffer (int32_t size)
 
ByteArray getBuffer (int32_t index)
 
int32_t numBuffers ()
 
- 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 LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
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 ()
 

Data Fields

INTERNAL : int64_t length
 
RAMDirectoryWeakPtr _directory
 

Protected Member Functions

virtual ByteArray newBuffer (int32_t size)
 Allocate a new buffer. Subclasses can allocate differently.
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

Collection< ByteArray > buffers
 
int64_t sizeInBytes
 
int64_t lastModified
 This is publicly modifiable via Directory.touchFile(), so direct access not supported.
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

File used as buffer in RAMDirectory.

Constructor & Destructor Documentation

◆ RAMFile() [1/2]

Lucene::RAMFile::RAMFile ( )

◆ RAMFile() [2/2]

Lucene::RAMFile::RAMFile ( const RAMDirectoryPtr directory)

◆ ~RAMFile()

virtual Lucene::RAMFile::~RAMFile ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ addBuffer()

ByteArray Lucene::RAMFile::addBuffer ( int32_t  size)

◆ getBuffer()

ByteArray Lucene::RAMFile::getBuffer ( int32_t  index)

◆ getClassName()

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

Reimplemented in Lucene::PerDocBuffer.

◆ getLastModified()

int64_t Lucene::RAMFile::getLastModified ( )

For non-stream access from thread that might be concurrent with writing.

◆ getLength()

int64_t Lucene::RAMFile::getLength ( )

For non-stream access from thread that might be concurrent with writing.

◆ getSizeInBytes()

int64_t Lucene::RAMFile::getSizeInBytes ( )

◆ newBuffer()

virtual ByteArray Lucene::RAMFile::newBuffer ( int32_t  size)
protectedvirtual

Allocate a new buffer. Subclasses can allocate differently.

Reimplemented in Lucene::PerDocBuffer.

◆ numBuffers()

int32_t Lucene::RAMFile::numBuffers ( )

◆ setLastModified()

void Lucene::RAMFile::setLastModified ( int64_t  lastModified)

◆ setLength()

void Lucene::RAMFile::setLength ( int64_t  length)

◆ shared_from_this()

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

Field Documentation

◆ __pad0__

INTERNAL Lucene::RAMFile::__pad0__

◆ _directory

RAMDirectoryWeakPtr Lucene::RAMFile::_directory

◆ buffers

Collection<ByteArray> Lucene::RAMFile::buffers
protected

◆ lastModified

int64_t Lucene::RAMFile::lastModified
protected

This is publicly modifiable via Directory.touchFile(), so direct access not supported.

◆ sizeInBytes

int64_t Lucene::RAMFile::sizeInBytes
protected

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

clucene.sourceforge.net