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

InvertedDocConsumer.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 INVERTEDDOCCONSUMER_H
8 #define INVERTEDDOCCONSUMER_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
14 class InvertedDocConsumer : public LuceneObject {
15 public:
16 virtual ~InvertedDocConsumer();
17
18 LUCENE_CLASS(InvertedDocConsumer);
19
20 public:
21 FieldInfosPtr fieldInfos;
22
23 public:
25 virtual InvertedDocConsumerPerThreadPtr addThread(const DocInverterPerThreadPtr& docInverterPerThread) = 0;
26
28 virtual void abort() = 0;
29
31 virtual void flush(MapInvertedDocConsumerPerThreadCollectionInvertedDocConsumerPerField threadsAndFields, const SegmentWriteStatePtr& state) = 0;
32
34 virtual void closeDocStore(const SegmentWriteStatePtr& state) = 0;
35
37 virtual bool freeRAM() = 0;
38
39 virtual void setFieldInfos(const FieldInfosPtr& fieldInfos);
40 };
41
42 }
43
44 #endif
Lucene::InvertedDocConsumer::flush
virtual void flush(MapInvertedDocConsumerPerThreadCollectionInvertedDocConsumerPerField threadsAndFields, const SegmentWriteStatePtr &state)=0
Flush a new segment.
Lucene::InvertedDocConsumer::fieldInfos
FieldInfosPtr fieldInfos
Definition: InvertedDocConsumer.h:18
Lucene::InvertedDocConsumer::closeDocStore
virtual void closeDocStore(const SegmentWriteStatePtr &state)=0
Close doc stores.
Lucene::DocInverterPerThreadPtr
boost::shared_ptr< DocInverterPerThread > DocInverterPerThreadPtr
Definition: LuceneTypes.h:121
LuceneObject.h
Lucene::InvertedDocConsumer
Definition: InvertedDocConsumer.h:14
Lucene::InvertedDocConsumer::~InvertedDocConsumer
virtual ~InvertedDocConsumer()
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::InvertedDocConsumer::freeRAM
virtual bool freeRAM()=0
Attempt to free RAM, returning true if any RAM was freed.
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::InvertedDocConsumer::setFieldInfos
virtual void setFieldInfos(const FieldInfosPtr &fieldInfos)
Lucene::InvertedDocConsumerPerThreadPtr
boost::shared_ptr< InvertedDocConsumerPerThread > InvertedDocConsumerPerThreadPtr
Definition: LuceneTypes.h:165
Lucene::InvertedDocConsumer::abort
virtual void abort()=0
Abort (called after hitting AbortException)
Lucene::InvertedDocConsumer::addThread
virtual InvertedDocConsumerPerThreadPtr addThread(const DocInverterPerThreadPtr &docInverterPerThread)=0
Add a new thread.
Lucene::SegmentWriteStatePtr
boost::shared_ptr< SegmentWriteState > SegmentWriteStatePtr
Definition: LuceneTypes.h:222
Lucene::FieldInfosPtr
boost::shared_ptr< FieldInfos > FieldInfosPtr
Definition: LuceneTypes.h:127

clucene.sourceforge.net