Lucene++ - a full-featured, c++ search engine
API Documentation
Returned from checkIndex()
detailing the health and status of the index.
More...
#include <CheckIndex.h>
Public Member Functions | |
IndexStatus () | |
virtual | ~IndexStatus () |
virtual String | getClassName () |
boost::shared_ptr< IndexStatus > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
Data Fields | |
bool | clean |
True if no problems were found with the index. | |
bool | missingSegments |
True if we were unable to locate and load the segments_N file. | |
bool | cantOpenSegments |
True if we were unable to open the segments_N file. | |
bool | missingSegmentVersion |
True if we were unable to read the version number from segments_N file. | |
String | segmentsFileName |
Name of latest segments_N file in the index. | |
int32_t | numSegments |
Number of segments in the index. | |
String | segmentFormat |
String description of the version of the index. | |
Collection< String > | segmentsChecked |
Empty unless you passed specific segments list to check as optional 3rd argument. | |
bool | toolOutOfDate |
True if the index was created with a newer version of Lucene than the CheckIndex tool. | |
Collection< SegmentInfoStatusPtr > | segmentInfos |
List of SegmentInfoStatus instances, detailing status of each segment. | |
DirectoryPtr | dir |
Directory index is in. | |
SegmentInfosPtr | newSegments |
SegmentInfos instance containing only segments that had no problems (this is used with the CheckIndex#fixIndex method to repair the index. | |
int32_t | totLoseDocCount |
How many documents will be lost to bad segments. | |
int32_t | numBadSegments |
How many bad segments were found. | |
bool | partial |
True if we checked only specific segments (checkIndex(List) ) was called with non-null argument). | |
MapStringString | userData |
Holds the userData of the last commit in the index. | |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Returned from checkIndex()
detailing the health and status of the index.
Lucene::IndexStatus::IndexStatus | ( | ) |
|
virtual |
|
inlinestatic |
|
inlinevirtual |
|
inline |
bool Lucene::IndexStatus::cantOpenSegments |
True if we were unable to open the segments_N file.
bool Lucene::IndexStatus::clean |
True if no problems were found with the index.
DirectoryPtr Lucene::IndexStatus::dir |
Directory index is in.
bool Lucene::IndexStatus::missingSegments |
True if we were unable to locate and load the segments_N file.
bool Lucene::IndexStatus::missingSegmentVersion |
True if we were unable to read the version number from segments_N file.
SegmentInfosPtr Lucene::IndexStatus::newSegments |
SegmentInfos instance containing only segments that had no problems (this is used with the CheckIndex#fixIndex
method to repair the index.
int32_t Lucene::IndexStatus::numBadSegments |
How many bad segments were found.
int32_t Lucene::IndexStatus::numSegments |
Number of segments in the index.
bool Lucene::IndexStatus::partial |
True if we checked only specific segments (checkIndex(List)
) was called with non-null argument).
String Lucene::IndexStatus::segmentFormat |
String description of the version of the index.
Collection<SegmentInfoStatusPtr> Lucene::IndexStatus::segmentInfos |
List of SegmentInfoStatus
instances, detailing status of each segment.
Collection<String> Lucene::IndexStatus::segmentsChecked |
Empty unless you passed specific segments list to check as optional 3rd argument.
String Lucene::IndexStatus::segmentsFileName |
Name of latest segments_N file in the index.
bool Lucene::IndexStatus::toolOutOfDate |
True if the index was created with a newer version of Lucene than the CheckIndex tool.
int32_t Lucene::IndexStatus::totLoseDocCount |
How many documents will be lost to bad segments.
MapStringString Lucene::IndexStatus::userData |
Holds the userData of the last commit in the index.