Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Classes | Public Attributes | List of all members
Lucene.Net.Index.CheckIndex.Status Class Reference

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

Classes

class  FieldNormStatus
 Status from testing field norms. More...
 
class  SegmentInfoStatus
 Holds the status of each segment in the index. See SegmentInfos. More...
 
class  StoredFieldStatus
 Status from testing stored fields. More...
 
class  TermIndexStatus
 Status from testing term index. More...
 
class  TermVectorStatus
 Status from testing stored fields. More...
 

Public Attributes

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.
 
System.String segmentsFileName
 Name of latest segments_N file in the index.
 
int numSegments
 Number of segments in the index.
 
System.String segmentFormat
 String description of the version of the index.
 
List< string > segmentsChecked = new List<string>()
 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.
 
IList< SegmentInfoStatussegmentInfos = new List<SegmentInfoStatus>()
 List of SegmentInfoStatus instances, detailing status of each segment.
 
Directory dir
 Directory index is in.
 
int totLoseDocCount
 How many documents will be lost to bad segments.
 
int numBadSegments
 How many bad segments were found.
 
bool partial
 True if we checked only specific segments (CheckIndex.CheckIndex_Renamed_Method(List{string})) was called with non-null argument).
 
IDictionary< string, string > userData
 Holds the userData of the last commit in the index
 

Detailed Description

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

WARNING: this API is new and experimental and is subject to suddenly change in the next release.

Definition at line 55 of file CheckIndex.cs.

Member Data Documentation

bool Lucene.Net.Index.CheckIndex.Status.cantOpenSegments

True if we were unable to open the segments_N file.

Definition at line 65 of file CheckIndex.cs.

bool Lucene.Net.Index.CheckIndex.Status.clean

True if no problems were found with the index.

Definition at line 59 of file CheckIndex.cs.

Directory Lucene.Net.Index.CheckIndex.Status.dir

Directory index is in.

Definition at line 92 of file CheckIndex.cs.

bool Lucene.Net.Index.CheckIndex.Status.missingSegments

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

Definition at line 62 of file CheckIndex.cs.

bool Lucene.Net.Index.CheckIndex.Status.missingSegmentVersion

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

Definition at line 68 of file CheckIndex.cs.

int Lucene.Net.Index.CheckIndex.Status.numBadSegments

How many bad segments were found.

Definition at line 104 of file CheckIndex.cs.

int Lucene.Net.Index.CheckIndex.Status.numSegments

Number of segments in the index.

Definition at line 74 of file CheckIndex.cs.

bool Lucene.Net.Index.CheckIndex.Status.partial

True if we checked only specific segments (CheckIndex.CheckIndex_Renamed_Method(List{string})) was called with non-null argument).

Definition at line 110 of file CheckIndex.cs.

System.String Lucene.Net.Index.CheckIndex.Status.segmentFormat

String description of the version of the index.

Definition at line 77 of file CheckIndex.cs.

IList<SegmentInfoStatus> Lucene.Net.Index.CheckIndex.Status.segmentInfos = new List<SegmentInfoStatus>()

List of SegmentInfoStatus instances, detailing status of each segment.

Definition at line 89 of file CheckIndex.cs.

List<string> Lucene.Net.Index.CheckIndex.Status.segmentsChecked = new List<string>()

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

<cref>CheckIndex.CheckIndex_Renamed_Method(System.Collections.IList)</cref>

Definition at line 83 of file CheckIndex.cs.

System.String Lucene.Net.Index.CheckIndex.Status.segmentsFileName

Name of latest segments_N file in the index.

Definition at line 71 of file CheckIndex.cs.

bool Lucene.Net.Index.CheckIndex.Status.toolOutOfDate

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

Definition at line 86 of file CheckIndex.cs.

int Lucene.Net.Index.CheckIndex.Status.totLoseDocCount

How many documents will be lost to bad segments.

Definition at line 101 of file CheckIndex.cs.

IDictionary<string, string> Lucene.Net.Index.CheckIndex.Status.userData

Holds the userData of the last commit in the index

Definition at line 113 of file CheckIndex.cs.


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