Package org.apache.lucene.index
Class CheckIndex.Status
- java.lang.Object
 - 
- org.apache.lucene.index.CheckIndex.Status
 
 
- 
- Enclosing class:
 - CheckIndex
 
public static class CheckIndex.Status extends java.lang.ObjectReturned fromCheckIndex.checkIndex()detailing the health and status of the index. 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCheckIndex.Status.DocValuesStatusStatus from testing DocValuesstatic classCheckIndex.Status.FieldNormStatusStatus from testing field norms.static classCheckIndex.Status.SegmentInfoStatusHolds the status of each segment in the index.static classCheckIndex.Status.StoredFieldStatusStatus from testing stored fields.static classCheckIndex.Status.TermIndexStatusStatus from testing term index.static classCheckIndex.Status.TermVectorStatusStatus from testing stored fields. 
- 
Field Summary
Fields Modifier and Type Field Description booleancantOpenSegmentsTrue if we were unable to open the segments_N file.booleancleanTrue if no problems were found with the index.DirectorydirDirectory index is in.intmaxSegmentNameThe greatest segment name.booleanmissingSegmentsTrue if we were unable to locate and load the segments_N file.booleanmissingSegmentVersionTrue if we were unable to read the version number from segments_N file.intnumBadSegmentsHow many bad segments were found.intnumSegmentsNumber of segments in the index.booleanpartialTrue if we checked only specific segments (CheckIndex.checkIndex(List)) was called with non-null argument).java.util.List<CheckIndex.Status.SegmentInfoStatus>segmentInfosList ofCheckIndex.Status.SegmentInfoStatusinstances, detailing status of each segment.java.util.List<java.lang.String>segmentsCheckedEmpty unless you passed specific segments list to check as optional 3rd argument.java.lang.StringsegmentsFileNameName of latest segments_N file in the index.booleantoolOutOfDateTrue if the index was created with a newer version of Lucene than the CheckIndex tool.inttotLoseDocCountHow many documents will be lost to bad segments.java.util.Map<java.lang.String,java.lang.String>userDataHolds the userData of the last commit in the indexbooleanvalidCounterWhether the SegmentInfos.counter is greater than any of the segments' names. 
 - 
 
- 
- 
Field Detail
- 
clean
public boolean clean
True if no problems were found with the index. 
- 
missingSegments
public boolean missingSegments
True if we were unable to locate and load the segments_N file. 
- 
cantOpenSegments
public boolean cantOpenSegments
True if we were unable to open the segments_N file. 
- 
missingSegmentVersion
public boolean missingSegmentVersion
True if we were unable to read the version number from segments_N file. 
- 
segmentsFileName
public java.lang.String segmentsFileName
Name of latest segments_N file in the index. 
- 
numSegments
public int numSegments
Number of segments in the index. 
- 
segmentsChecked
public java.util.List<java.lang.String> segmentsChecked
Empty unless you passed specific segments list to check as optional 3rd argument.- See Also:
 CheckIndex.checkIndex(List)
 
- 
toolOutOfDate
public boolean toolOutOfDate
True if the index was created with a newer version of Lucene than the CheckIndex tool. 
- 
segmentInfos
public java.util.List<CheckIndex.Status.SegmentInfoStatus> segmentInfos
List ofCheckIndex.Status.SegmentInfoStatusinstances, detailing status of each segment. 
- 
dir
public Directory dir
Directory index is in. 
- 
totLoseDocCount
public int totLoseDocCount
How many documents will be lost to bad segments. 
- 
numBadSegments
public int numBadSegments
How many bad segments were found. 
- 
partial
public boolean partial
True if we checked only specific segments (CheckIndex.checkIndex(List)) was called with non-null argument). 
- 
maxSegmentName
public int maxSegmentName
The greatest segment name. 
- 
validCounter
public boolean validCounter
Whether the SegmentInfos.counter is greater than any of the segments' names. 
- 
userData
public java.util.Map<java.lang.String,java.lang.String> userData
Holds the userData of the last commit in the index 
 - 
 
 -