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


IndexFileDeleter.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 INDEXFILEDELETER_H
8 #define INDEXFILEDELETER_H
9 
10 #include "IndexCommit.h"
11 
12 namespace Lucene {
13 
35 public:
39  virtual ~IndexFileDeleter();
40 
42 
43 protected:
47 
49  MapStringRefCount refCounts;
50 
55 
58 
61 
66 
69 
71  static bool VERBOSE_REF_COUNTS;
72 
73 public:
75 
76 protected:
77  void message(const String& message);
78 
80  void deleteCommits();
81 
83 
84  RefCountPtr getRefCount(const String& fileName);
85 
86 public:
88 
90 
94  void refresh(const String& segmentName);
95  void refresh();
96 
97  void close();
98 
110  void checkpoint(const SegmentInfosPtr& segmentInfos, bool isCommit);
111 
112  void incRef(const SegmentInfosPtr& segmentInfos, bool isCommit);
113  void incRef(HashSet<String> files);
114  void incRef(const String& fileName);
115  void decRef(HashSet<String> files);
116  void decRef(const String& fileName);
117  void decRef(const SegmentInfosPtr& segmentInfos);
118 
119  bool exists(const String& fileName);
120 
122 
125 
126  void deleteFile(const String& fileName);
127 };
128 
130 class RefCount : public LuceneObject {
131 public:
132  RefCount(const String& fileName);
133  virtual ~RefCount();
134 
136 
137 public:
138  String fileName; // fileName used only for better assert error messages
139  bool initDone;
140  int32_t count;
141 
142 public:
143  int32_t IncRef();
144  int32_t DecRef();
145 };
146 
149 class CommitPoint : public IndexCommit {
150 public:
152  virtual ~CommitPoint();
153 
155 
156 public:
157  int64_t gen;
160  bool deleted;
163  int64_t version;
164  int64_t generation;
166  MapStringString userData;
167 
168 public:
169  virtual String toString();
170 
172  virtual bool isOptimized();
173 
175  virtual String getSegmentsFileName();
176 
179 
182 
184  virtual int64_t getVersion();
185 
187  virtual int64_t getGeneration();
188 
190  virtual MapStringString getUserData();
191 
193  virtual void deleteCommit();
194 
195  virtual bool isDeleted();
196 
197  virtual int32_t compareTo(const LuceneObjectPtr& other);
198 };
199 
200 }
201 
202 #endif
Lucene::IndexFileDeleter::checkpoint
void checkpoint(const SegmentInfosPtr &segmentInfos, bool isCommit)
For definition of "check point" see IndexWriter comments: "Clarification: Check Points (and commits)"...
Lucene::IndexFileDeleter::close
void close()
Lucene::IndexFileDeleter::decRef
void decRef(HashSet< String > files)
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::CommitPoint::gen
int64_t gen
Definition: IndexFileDeleter.h:154
Lucene::Collection< IndexCommitPtr >
Lucene::CommitPoint::userData
MapStringString userData
Definition: IndexFileDeleter.h:166
Lucene::LuceneObjectPtr
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
Lucene::IndexFileDeleter::refresh
void refresh(const String &segmentName)
Writer calls this when it has hit an error and had to roll back, to tell us that there may now be unr...
Lucene::CommitPoint::segmentsFileName
String segmentsFileName
Definition: IndexFileDeleter.h:159
Lucene::IndexFileDeleter::synced
HashSet< String > synced
Definition: IndexFileDeleter.h:68
Lucene::IndexFileDeleter::getLastSegmentInfos
SegmentInfosPtr getLastSegmentInfos()
Lucene::DocumentsWriterPtr
boost::shared_ptr< DocumentsWriter > DocumentsWriterPtr
Definition: LuceneTypes.h:123
Lucene::IndexFileDeleter::deleteNewFiles
void deleteNewFiles(HashSet< String > files)
Deletes the specified files, but only if they are new (have not yet been incref'd).
Lucene::CommitPoint::getUserData
virtual MapStringString getUserData()
Returns userData, previously passed to IndexWriter#commit(Map) for this commit.
Lucene::IndexFileDeleter::docWriter
DocumentsWriterPtr docWriter
Definition: IndexFileDeleter.h:65
Lucene::RefCountPtr
boost::shared_ptr< RefCount > RefCountPtr
Definition: LuceneTypes.h:206
Lucene::IndexFileDeleter::commitsToDelete
Collection< CommitPointPtr > commitsToDelete
Commits that the IndexDeletionPolicy have decided to delete.
Definition: IndexFileDeleter.h:60
Lucene::CommitPoint::commitsToDelete
Collection< CommitPointPtr > commitsToDelete
Definition: IndexFileDeleter.h:162
Lucene::IndexFileDeleter::message
void message(const String &message)
Lucene::IndexFileDeleter::refCounts
MapStringRefCount refCounts
Reference count for all files in the index. Counts how many existing commits reference a file.
Definition: IndexFileDeleter.h:49
Lucene::CommitPoint::version
int64_t version
Definition: IndexFileDeleter.h:163
Lucene::IndexFileDeleter::directory
DirectoryPtr directory
Definition: IndexFileDeleter.h:63
Lucene::IndexFileDeleter::incRef
void incRef(const SegmentInfosPtr &segmentInfos, bool isCommit)
Lucene::IndexFileDeleter::refresh
void refresh()
Lucene::IndexFileDeleter::deletePendingFiles
void deletePendingFiles()
Lucene::CommitPoint::compareTo
virtual int32_t compareTo(const LuceneObjectPtr &other)
Compare two objects.
Lucene::CommitPoint::getFileNames
virtual HashSet< String > getFileNames()
Returns all index files referenced by this commit point.
Lucene::CommitPoint::_isOptimized
bool _isOptimized
Definition: IndexFileDeleter.h:165
Lucene::CommitPoint::getVersion
virtual int64_t getVersion()
Returns the version for this IndexCommit.
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::CommitPoint::generation
int64_t generation
Definition: IndexFileDeleter.h:164
Lucene::RefCount
Tracks the reference count for a single index file.
Definition: IndexFileDeleter.h:130
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::IndexFileDeleter
This class keeps track of each SegmentInfos instance that is still "live", either because it correspo...
Definition: IndexFileDeleter.h:34
Lucene::RefCount::fileName
String fileName
Definition: IndexFileDeleter.h:135
Lucene::RefCount::DecRef
int32_t DecRef()
Lucene::IndexFileDeleter::deleteCommits
void deleteCommits()
Remove the CommitPoints in the commitsToDelete List by DecRef'ing all files from each SegmentInfos.
Lucene::IndexFileDeleter::decRef
void decRef(const String &fileName)
Lucene::IndexFileDeleter::infoStream
InfoStreamPtr infoStream
Definition: IndexFileDeleter.h:62
Lucene::CommitPoint::files
HashSet< String > files
Definition: IndexFileDeleter.h:158
Lucene::RefCount::~RefCount
virtual ~RefCount()
Lucene::HashSet< String >
Lucene::CommitPoint::isDeleted
virtual bool isDeleted()
Lucene::CommitPoint::~CommitPoint
virtual ~CommitPoint()
Lucene::RefCount::initDone
bool initDone
Definition: IndexFileDeleter.h:139
Lucene::CommitPoint::isOptimized
virtual bool isOptimized()
Returns true if this commit is an optimized index.
Lucene::CommitPoint::getSegmentsFileName
virtual String getSegmentsFileName()
Get the segments file (segments_N) associated with this commit point.
Lucene::CommitPoint::getDirectory
virtual DirectoryPtr getDirectory()
Returns the Directory for the index.
Lucene::CommitPoint::deleteCommit
virtual void deleteCommit()
Called only be the deletion policy, to remove this commit point from the index.
Lucene::IndexFileDeleter::lastSegmentInfos
SegmentInfosPtr lastSegmentInfos
Definition: IndexFileDeleter.h:67
Lucene::IndexFileDeleter::incRef
void incRef(HashSet< String > files)
Lucene::IndexCommit
Represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
Definition: IndexCommit.h:22
Lucene::IndexDeletionPolicyPtr
boost::shared_ptr< IndexDeletionPolicy > IndexDeletionPolicyPtr
Definition: LuceneTypes.h:153
Lucene::CommitPoint::toString
virtual String toString()
Returns a string representation of the object.
Lucene::CommitPoint::deleted
bool deleted
Definition: IndexFileDeleter.h:160
Lucene::IndexFileDeleter::commits
Collection< IndexCommitPtr > commits
Holds all commits (segments_N) currently in the index. This will have just 1 commit if you are using ...
Definition: IndexFileDeleter.h:54
Lucene::SegmentInfosPtr
boost::shared_ptr< SegmentInfos > SegmentInfosPtr
Definition: LuceneTypes.h:210
Lucene::CommitPoint::directory
DirectoryPtr directory
Definition: IndexFileDeleter.h:161
Lucene::RefCount::RefCount
RefCount(const String &fileName)
Lucene::IndexFileDeleter::~IndexFileDeleter
virtual ~IndexFileDeleter()
Lucene::DirectoryPtr
boost::shared_ptr< Directory > DirectoryPtr
Definition: LuceneTypes.h:489
Lucene::IndexFileDeleter::incRef
void incRef(const String &fileName)
IndexCommit.h
Lucene::IndexFileDeleter::setInfoStream
void setInfoStream(const InfoStreamPtr &infoStream)
Lucene::IndexFileDeleter::deletable
HashSet< String > deletable
Files that we tried to delete but failed (likely because they are open and we are running on Windows)...
Definition: IndexFileDeleter.h:41
Lucene::InfoStreamPtr
boost::shared_ptr< InfoStream > InfoStreamPtr
Definition: LuceneTypes.h:532
Lucene::IndexFileDeleter::VERBOSE_REF_COUNTS
static bool VERBOSE_REF_COUNTS
Change to true to see details of reference counts when infoStream != null.
Definition: IndexFileDeleter.h:71
Lucene::IndexFileDeleter::startingCommitDeleted
bool startingCommitDeleted
Definition: IndexFileDeleter.h:74
Lucene::IndexFileDeleter::policy
IndexDeletionPolicyPtr policy
Definition: IndexFileDeleter.h:64
Lucene::CommitPoint::CommitPoint
CommitPoint(Collection< CommitPointPtr > commitsToDelete, const DirectoryPtr &directory, const SegmentInfosPtr &segmentInfos)
Lucene::RefCount::count
int32_t count
Definition: IndexFileDeleter.h:140
Lucene::IndexFileDeleter::decRef
void decRef(const SegmentInfosPtr &segmentInfos)
Lucene::IndexFileDeleter::deleteFiles
void deleteFiles(HashSet< String > files)
Lucene::IndexFileDeleter::deleteFile
void deleteFile(const String &fileName)
Lucene::CommitPoint
Holds details for each commit point. This class is also passed to the deletion policy....
Definition: IndexFileDeleter.h:149
Lucene::IndexFileDeleter::getRefCount
RefCountPtr getRefCount(const String &fileName)
Lucene::IndexFileDeleter::exists
bool exists(const String &fileName)
Lucene::RefCount::IncRef
int32_t IncRef()
Lucene::CommitPoint::getGeneration
virtual int64_t getGeneration()
Returns the generation (the _N in segments_N) for this IndexCommit.
Lucene::IndexFileDeleter::IndexFileDeleter
IndexFileDeleter(const DirectoryPtr &directory, const IndexDeletionPolicyPtr &policy, const SegmentInfosPtr &segmentInfos, const InfoStreamPtr &infoStream, const DocumentsWriterPtr &docWriter, HashSet< String > synced)
Initialize the deleter: find all previous commits in the Directory, incref the files they reference,...
Lucene::IndexFileDeleter::lastFiles
Collection< HashSet< String > > lastFiles
Holds files we had incref'd from the previous non-commit checkpoint.
Definition: IndexFileDeleter.h:57

clucene.sourceforge.net