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


Reader.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6 
7 #ifndef READER_H
8 #define READER_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
15 class LPPAPI Reader : public LuceneObject {
16 protected:
17  Reader();
18 
19 public:
20  virtual ~Reader();
22 
23 public:
24  static const int32_t READER_EOF;
25 
27  virtual int32_t read();
28 
30  virtual int32_t read(wchar_t* buffer, int32_t offset, int32_t length) = 0;
31 
33  virtual int64_t skip(int64_t n);
34 
36  virtual void close() = 0;
37 
39  virtual bool markSupported();
40 
43  virtual void mark(int32_t readAheadLimit);
44 
48  virtual void reset();
49 
51  virtual int64_t length();
52 };
53 
54 }
55 
56 #endif
Lucene::Reader::close
virtual void close()=0
Close the stream.
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::Reader::READER_EOF
static const int32_t READER_EOF
Definition: Reader.h:21
Lucene::Reader::reset
virtual void reset()
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark....
Lucene::Reader::mark
virtual void mark(int32_t readAheadLimit)
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the s...
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::Reader::length
virtual int64_t length()
The number of bytes in the stream.
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::Reader
Abstract class for reading character streams.
Definition: Reader.h:15
Lucene::Reader::Reader
Reader()
Lucene::Reader::markSupported
virtual bool markSupported()
Tell whether this stream supports the mark() operation.
Lucene::Reader::~Reader
virtual ~Reader()
Lucene::Reader::skip
virtual int64_t skip(int64_t n)
Skip characters.
LuceneObject.h

clucene.sourceforge.net