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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::IndexStatus Class Reference

Returned from checkIndex() detailing the health and status of the index. More...

#include <CheckIndex.h>

+ Inheritance diagram for Lucene::IndexStatus:

Public Member Functions

 IndexStatus ()
 
virtual ~IndexStatus ()
 
virtual String getClassName ()
 
boost::shared_ptr< IndexStatusshared_from_this ()
 
- Public Member Functions inherited from Lucene::LuceneObject
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.
 
- Public Member Functions inherited from Lucene::LuceneSync
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< SegmentInfoStatusPtrsegmentInfos
 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

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

Returned from checkIndex() detailing the health and status of the index.

Constructor & Destructor Documentation

◆ IndexStatus()

Lucene::IndexStatus::IndexStatus ( )

◆ ~IndexStatus()

virtual Lucene::IndexStatus::~IndexStatus ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::IndexStatus::_getClassName ( )
inlinestatic

◆ getClassName()

virtual String Lucene::IndexStatus::getClassName ( )
inlinevirtual

◆ shared_from_this()

boost::shared_ptr< IndexStatus > Lucene::IndexStatus::shared_from_this ( )
inline

Field Documentation

◆ cantOpenSegments

bool Lucene::IndexStatus::cantOpenSegments

True if we were unable to open the segments_N file.

◆ clean

bool Lucene::IndexStatus::clean

True if no problems were found with the index.

◆ dir

DirectoryPtr Lucene::IndexStatus::dir

Directory index is in.

◆ missingSegments

bool Lucene::IndexStatus::missingSegments

True if we were unable to locate and load the segments_N file.

◆ missingSegmentVersion

bool Lucene::IndexStatus::missingSegmentVersion

True if we were unable to read the version number from segments_N file.

◆ newSegments

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.

◆ numBadSegments

int32_t Lucene::IndexStatus::numBadSegments

How many bad segments were found.

◆ numSegments

int32_t Lucene::IndexStatus::numSegments

Number of segments in the index.

◆ partial

bool Lucene::IndexStatus::partial

True if we checked only specific segments (checkIndex(List)) was called with non-null argument).

◆ segmentFormat

String Lucene::IndexStatus::segmentFormat

String description of the version of the index.

◆ segmentInfos

Collection<SegmentInfoStatusPtr> Lucene::IndexStatus::segmentInfos

List of SegmentInfoStatus instances, detailing status of each segment.

◆ segmentsChecked

Collection<String> Lucene::IndexStatus::segmentsChecked

Empty unless you passed specific segments list to check as optional 3rd argument.

See also
CheckIndex::checkIndex(List)

◆ segmentsFileName

String Lucene::IndexStatus::segmentsFileName

Name of latest segments_N file in the index.

◆ toolOutOfDate

bool Lucene::IndexStatus::toolOutOfDate

True if the index was created with a newer version of Lucene than the CheckIndex tool.

◆ totLoseDocCount

int32_t Lucene::IndexStatus::totLoseDocCount

How many documents will be lost to bad segments.

◆ userData

MapStringString Lucene::IndexStatus::userData

Holds the userData of the last commit in the index.


The documentation for this class was generated from the following file:

clucene.sourceforge.net