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


Loading...
Searching...
No Matches
IndexFileDeleter.h
Go to the documentation of this file.
1
2// 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
12namespace Lucene {
13
34class LPPAPI IndexFileDeleter : public LuceneObject {
35public:
38 IndexFileDeleter(const DirectoryPtr& directory, const IndexDeletionPolicyPtr& policy, const SegmentInfosPtr& segmentInfos, const InfoStreamPtr& infoStream, const DocumentsWriterPtr& docWriter, HashSet<String> synced);
40
42
43protected:
47
49 MapStringRefCount refCounts;
50
55
58
61
66
69
71 static bool VERBOSE_REF_COUNTS;
72
73public:
75
76protected:
77 void message(const String& message);
78
81
83
84 RefCountPtr getRefCount(const String& fileName);
85
86public:
87 void setInfoStream(const InfoStreamPtr& infoStream);
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);
114 void incRef(const String& fileName);
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
130class RefCount : public LuceneObject {
131public:
132 RefCount(const String& fileName);
133 virtual ~RefCount();
134
136
137public:
138 String fileName; // fileName used only for better assert error messages
140 int32_t count;
141
142public:
143 int32_t IncRef();
144 int32_t DecRef();
145};
146
149class CommitPoint : public IndexCommit {
150public:
152 virtual ~CommitPoint();
153
155
156public:
157 int64_t gen;
163 int64_t version;
164 int64_t generation;
166 MapStringString userData;
167
168public:
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
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Utility template class to handle collections that can be safely copied and shared.
Definition Collection.h:17
Holds details for each commit point. This class is also passed to the deletion policy....
Definition IndexFileDeleter.h:149
Collection< CommitPointPtr > commitsToDelete
Definition IndexFileDeleter.h:162
bool _isOptimized
Definition IndexFileDeleter.h:165
bool deleted
Definition IndexFileDeleter.h:160
HashSet< String > files
Definition IndexFileDeleter.h:158
int64_t generation
Definition IndexFileDeleter.h:164
virtual bool isOptimized()
Returns true if this commit is an optimized index.
DirectoryPtr directory
Definition IndexFileDeleter.h:161
int64_t version
Definition IndexFileDeleter.h:163
CommitPoint(Collection< CommitPointPtr > commitsToDelete, const DirectoryPtr &directory, const SegmentInfosPtr &segmentInfos)
virtual int64_t getVersion()
Returns the version for this IndexCommit.
String segmentsFileName
Definition IndexFileDeleter.h:159
virtual String toString()
Returns a string representation of the object.
virtual bool isDeleted()
MapStringString userData
Definition IndexFileDeleter.h:166
virtual void deleteCommit()
Called only be the deletion policy, to remove this commit point from the index.
virtual MapStringString getUserData()
Returns userData, previously passed to IndexWriter#commit(Map) for this commit.
virtual DirectoryPtr getDirectory()
Returns the Directory for the index.
virtual HashSet< String > getFileNames()
Returns all index files referenced by this commit point.
int64_t gen
Definition IndexFileDeleter.h:157
virtual String getSegmentsFileName()
Get the segments file (segments_N) associated with this commit point.
virtual int64_t getGeneration()
Returns the generation (the _N in segments_N) for this IndexCommit.
virtual ~CommitPoint()
virtual int32_t compareTo(const LuceneObjectPtr &other)
Compare two objects.
Utility template class to handle hash set collections that can be safely copied and shared.
Definition HashSet.h:17
Represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
Definition IndexCommit.h:22
This class keeps track of each SegmentInfos instance that is still "live", either because it correspo...
Definition IndexFileDeleter.h:34
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...
RefCountPtr getRefCount(const String &fileName)
void incRef(const String &fileName)
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,...
bool exists(const String &fileName)
Collection< HashSet< String > > lastFiles
Holds files we had incref'd from the previous non-commit checkpoint.
Definition IndexFileDeleter.h:57
DirectoryPtr directory
Definition IndexFileDeleter.h:63
void message(const String &message)
SegmentInfosPtr getLastSegmentInfos()
HashSet< String > synced
Definition IndexFileDeleter.h:68
void incRef(HashSet< String > files)
void setInfoStream(const InfoStreamPtr &infoStream)
IndexDeletionPolicyPtr policy
Definition IndexFileDeleter.h:64
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
void deleteFile(const String &fileName)
Collection< CommitPointPtr > commitsToDelete
Commits that the IndexDeletionPolicy have decided to delete.
Definition IndexFileDeleter.h:60
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:46
void decRef(const String &fileName)
void deleteNewFiles(HashSet< String > files)
Deletes the specified files, but only if they are new (have not yet been incref'd).
void decRef(HashSet< String > files)
void deleteFiles(HashSet< String > files)
InfoStreamPtr infoStream
Definition IndexFileDeleter.h:62
void deleteCommits()
Remove the CommitPoints in the commitsToDelete List by DecRef'ing all files from each SegmentInfos.
static bool VERBOSE_REF_COUNTS
Change to true to see details of reference counts when infoStream != null.
Definition IndexFileDeleter.h:71
void incRef(const SegmentInfosPtr &segmentInfos, bool isCommit)
void decRef(const SegmentInfosPtr &segmentInfos)
void checkpoint(const SegmentInfosPtr &segmentInfos, bool isCommit)
For definition of "check point" see IndexWriter comments: "Clarification: Check Points (and commits)"...
SegmentInfosPtr lastSegmentInfos
Definition IndexFileDeleter.h:67
bool startingCommitDeleted
Definition IndexFileDeleter.h:74
DocumentsWriterPtr docWriter
Definition IndexFileDeleter.h:65
MapStringRefCount refCounts
Reference count for all files in the index. Counts how many existing commits reference a file.
Definition IndexFileDeleter.h:49
Base class for all Lucene classes.
Definition LuceneObject.h:31
Tracks the reference count for a single index file.
Definition IndexFileDeleter.h:130
int32_t count
Definition IndexFileDeleter.h:140
bool initDone
Definition IndexFileDeleter.h:139
String fileName
Definition IndexFileDeleter.h:138
RefCount(const String &fileName)
int32_t IncRef()
virtual ~RefCount()
int32_t DecRef()
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< InfoStream > InfoStreamPtr
Definition LuceneTypes.h:532
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition LuceneTypes.h:539
boost::shared_ptr< DocumentsWriter > DocumentsWriterPtr
Definition LuceneTypes.h:123
boost::shared_ptr< RefCount > RefCountPtr
Definition LuceneTypes.h:206
boost::shared_ptr< Directory > DirectoryPtr
Definition LuceneTypes.h:489
boost::shared_ptr< IndexDeletionPolicy > IndexDeletionPolicyPtr
Definition LuceneTypes.h:153
boost::shared_ptr< SegmentInfos > SegmentInfosPtr
Definition LuceneTypes.h:210

clucene.sourceforge.net