Lucene++ - a full-featured, c++ search engine
API Documentation
Convenience class for reading character files. More...
#include <FileReader.h>
Public Member Functions | |
FileReader (const String &fileName) | |
Creates a new FileReader, given the file name to read from. More... | |
virtual | ~FileReader () |
virtual String | getClassName () |
boost::shared_ptr< FileReader > | shared_from_this () |
virtual int32_t | read () |
Read a single character. More... | |
virtual int32_t | read (wchar_t *buffer, int32_t offset, int32_t length) |
Read characters into a portion of an array. More... | |
virtual void | close () |
Close the stream. More... | |
virtual bool | markSupported () |
Tell whether this stream supports the mark() operation. More... | |
virtual void | reset () |
Reset the stream. More... | |
virtual int64_t | length () |
The number of bytes in the file. More... | |
![]() | |
virtual | ~Reader () |
virtual String | getClassName () |
boost::shared_ptr< Reader > | shared_from_this () |
virtual int32_t | read () |
Read a single character. More... | |
virtual int32_t | read (wchar_t *buffer, int32_t offset, int32_t length)=0 |
Read characters into a portion of an array. More... | |
virtual int64_t | skip (int64_t n) |
Skip characters. More... | |
virtual void | close ()=0 |
Close the stream. More... | |
virtual bool | markSupported () |
Tell whether this stream supports the mark() operation. More... | |
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. More... | |
virtual void | reset () |
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point. More... | |
virtual int64_t | length () |
The number of bytes in the stream. More... | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
virtual String | toString () |
Returns a string representation of the object. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Static Public Attributes | |
static const int32_t | FILE_EOF |
static const int32_t | FILE_ERROR |
![]() | |
static const int32_t | READER_EOF |
Protected Attributes | |
ifstreamPtr | file |
int64_t | _length |
ByteArray | fileBuffer |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
Reader () | |
![]() | |
LuceneObject () | |
Convenience class for reading character files.
Lucene::FileReader::FileReader | ( | const String & | fileName | ) |
Creates a new FileReader, given the file name to read from.
|
virtual |
|
inlinestatic |
|
virtual |
Close the stream.
Implements Lucene::Reader.
|
inlinevirtual |
Reimplemented from Lucene::Reader.
|
virtual |
The number of bytes in the file.
Reimplemented from Lucene::Reader.
|
virtual |
Tell whether this stream supports the mark() operation.
Reimplemented from Lucene::Reader.
|
virtual |
Read a single character.
Reimplemented from Lucene::Reader.
|
virtual |
Read characters into a portion of an array.
Implements Lucene::Reader.
|
virtual |
Reset the stream.
Reimplemented from Lucene::Reader.
|
inline |
|
protected |
|
protected |
|
static |
|
static |
|
protected |