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


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

Convenience class for reading character files. More...

#include <FileReader.h>

+ Inheritance diagram for Lucene::FileReader:

Public Member Functions

 FileReader (const String &fileName)
 Creates a new FileReader, given the file name to read from.
 
virtual ~FileReader ()
 
virtual String getClassName ()
 
boost::shared_ptr< FileReadershared_from_this ()
 
virtual int32_t read ()
 Read a single character.
 
virtual int32_t read (wchar_t *buffer, int32_t offset, int32_t length)
 Read characters into a portion of an array.
 
virtual void close ()
 Close the stream.
 
virtual bool markSupported ()
 Tell whether this stream supports the mark() operation.
 
virtual void reset ()
 Reset the stream.
 
virtual int64_t length ()
 The number of bytes in the file.
 
- Public Member Functions inherited from Lucene::Reader
virtual ~Reader ()
 
boost::shared_ptr< Readershared_from_this ()
 
virtual int64_t skip (int64_t n)
 Skip characters.
 
virtual void mark (int32_t readAheadLimit)
 Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
 
- 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 ()
 
- Static Public Member Functions inherited from Lucene::Reader
static String _getClassName ()
 

Static Public Attributes

static const int32_t FILE_EOF
 
static const int32_t FILE_ERROR
 
- Static Public Attributes inherited from Lucene::Reader
static const int32_t READER_EOF
 

Protected Attributes

ifstreamPtr file
 
int64_t _length
 
ByteArray fileBuffer
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::Reader
 Reader ()
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Detailed Description

Convenience class for reading character files.

Constructor & Destructor Documentation

◆ FileReader()

Lucene::FileReader::FileReader ( const String &  fileName)

Creates a new FileReader, given the file name to read from.

◆ ~FileReader()

virtual Lucene::FileReader::~FileReader ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ close()

virtual void Lucene::FileReader::close ( )
virtual

Close the stream.

Implements Lucene::Reader.

◆ getClassName()

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

Reimplemented from Lucene::Reader.

◆ length()

virtual int64_t Lucene::FileReader::length ( )
virtual

The number of bytes in the file.

Reimplemented from Lucene::Reader.

◆ markSupported()

virtual bool Lucene::FileReader::markSupported ( )
virtual

Tell whether this stream supports the mark() operation.

Reimplemented from Lucene::Reader.

◆ read() [1/2]

virtual int32_t Lucene::FileReader::read ( )
virtual

Read a single character.

Reimplemented from Lucene::Reader.

◆ read() [2/2]

virtual int32_t Lucene::FileReader::read ( wchar_t *  buffer,
int32_t  offset,
int32_t  length 
)
virtual

Read characters into a portion of an array.

Implements Lucene::Reader.

◆ reset()

virtual void Lucene::FileReader::reset ( )
virtual

Reset the stream.

Reimplemented from Lucene::Reader.

◆ shared_from_this()

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

Field Documentation

◆ _length

int64_t Lucene::FileReader::_length
protected

◆ file

ifstreamPtr Lucene::FileReader::file
protected

◆ FILE_EOF

const int32_t Lucene::FileReader::FILE_EOF
static

◆ FILE_ERROR

const int32_t Lucene::FileReader::FILE_ERROR
static

◆ fileBuffer

ByteArray Lucene::FileReader::fileBuffer
protected

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

clucene.sourceforge.net