public static class

CheckIndex.Status

extends Object
java.lang.Object
   ↳ org.apache.lucene.index.CheckIndex.Status

Class Overview

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

Summary

Nested Classes
class CheckIndex.Status.FieldNormStatus Status from testing field norms. 
class CheckIndex.Status.SegmentInfoStatus Holds the status of each segment in the index. 
class CheckIndex.Status.StoredFieldStatus Status from testing stored fields. 
class CheckIndex.Status.TermIndexStatus Status from testing term index. 
class CheckIndex.Status.TermVectorStatus Status from testing stored fields. 
Fields
public boolean cantOpenSegments True if we were unable to open the segments_N file.
public boolean clean True if no problems were found with the index.
public Directory dir Directory index is in.
public boolean missingSegmentVersion True if we were unable to read the version number from segments_N file.
public boolean missingSegments True if we were unable to locate and load the segments_N file.
public int numBadSegments How many bad segments were found.
public int numSegments Number of segments in the index.
public boolean partial True if we checked only specific segments (checkIndex(List)) was called with non-null argument).
public String segmentFormat String description of the version of the index.
public List<CheckIndex.Status.SegmentInfoStatus> segmentInfos List of CheckIndex.Status.SegmentInfoStatus instances, detailing status of each segment.
public List<String> segmentsChecked Empty unless you passed specific segments list to check as optional 3rd argument.
public String segmentsFileName Name of latest segments_N file in the index.
public boolean toolOutOfDate True if the index was created with a newer version of Lucene than the CheckIndex tool.
public int totLoseDocCount How many documents will be lost to bad segments.
public Map<String, String> userData Holds the userData of the last commit in the index
Public Constructors
CheckIndex.Status()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public boolean cantOpenSegments

True if we were unable to open the segments_N file.

public boolean clean

True if no problems were found with the index.

public Directory dir

Directory index is in.

public boolean missingSegmentVersion

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

public boolean missingSegments

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

public int numBadSegments

How many bad segments were found.

public int numSegments

Number of segments in the index.

public boolean partial

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

public String segmentFormat

String description of the version of the index.

public List<CheckIndex.Status.SegmentInfoStatus> segmentInfos

List of CheckIndex.Status.SegmentInfoStatus instances, detailing status of each segment.

public List<String> segmentsChecked

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

See Also

public String segmentsFileName

Name of latest segments_N file in the index.

public boolean toolOutOfDate

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

public int totLoseDocCount

How many documents will be lost to bad segments.

public Map<String, String> userData

Holds the userData of the last commit in the index

Public Constructors

public CheckIndex.Status ()