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

DocFieldConsumer.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 DOCFIELDCONSUMER_H
8 #define DOCFIELDCONSUMER_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
14 class DocFieldConsumer : public LuceneObject {
15 public:
16 virtual ~DocFieldConsumer();
17
18 LUCENE_CLASS(DocFieldConsumer);
19
20 protected:
21 FieldInfosPtr fieldInfos;
22
23 public:
25 virtual void flush(MapDocFieldConsumerPerThreadCollectionDocFieldConsumerPerField threadsAndFields, const SegmentWriteStatePtr& state) = 0;
26
28 virtual void closeDocStore(const SegmentWriteStatePtr& state) = 0;
29
31 virtual void abort() = 0;
32
34 virtual DocFieldConsumerPerThreadPtr addThread(const DocFieldProcessorPerThreadPtr& docFieldProcessorPerThread) = 0;
35
38 virtual bool freeRAM() = 0;
39
40 virtual void setFieldInfos(const FieldInfosPtr& fieldInfos);
41 };
42
43 }
44
45 #endif
Lucene::DocFieldConsumer::setFieldInfos
virtual void setFieldInfos(const FieldInfosPtr &fieldInfos)
Lucene::DocFieldProcessorPerThreadPtr
boost::shared_ptr< DocFieldProcessorPerThread > DocFieldProcessorPerThreadPtr
Definition: LuceneTypes.h:117
Lucene::DocFieldConsumerPerThreadPtr
boost::shared_ptr< DocFieldConsumerPerThread > DocFieldConsumerPerThreadPtr
Definition: LuceneTypes.h:110
Lucene::DocFieldConsumer
Definition: DocFieldConsumer.h:14
Lucene::DocFieldConsumer::closeDocStore
virtual void closeDocStore(const SegmentWriteStatePtr &state)=0
Called when DocumentsWriter decides to close the doc stores.
LuceneObject.h
Lucene::DocFieldConsumer::abort
virtual void abort()=0
Called when an aborting exception is hit.
Lucene::DocFieldConsumer::~DocFieldConsumer
virtual ~DocFieldConsumer()
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::DocFieldConsumer::fieldInfos
FieldInfosPtr fieldInfos
Definition: DocFieldConsumer.h:18
Lucene::DocFieldConsumer::flush
virtual void flush(MapDocFieldConsumerPerThreadCollectionDocFieldConsumerPerField threadsAndFields, const SegmentWriteStatePtr &state)=0
Called when DocumentsWriter decides to create a new segment.
Lucene::DocFieldConsumer::addThread
virtual DocFieldConsumerPerThreadPtr addThread(const DocFieldProcessorPerThreadPtr &docFieldProcessorPerThread)=0
Add a new thread.
Lucene::DocFieldConsumer::freeRAM
virtual bool freeRAM()=0
Called when DocumentsWriter is using too much RAM. The consumer should free RAM, if possible...
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