Package org.apache.lucene.index
Class CheckIndex.Status
java.lang.Object
org.apache.lucene.index.CheckIndex.Status
- Enclosing class:
CheckIndex
Returned from
CheckIndex.checkIndex() detailing the health and status of the index.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classStatus from testing DocValuesstatic final classStatus from testing field infos.static final classStatus from testing field norms.static final classStatus from testing index sortstatic final classStatus from testing livedocsstatic final classStatus from testing PointValuesstatic classHolds the status of each segment in the index.static final classStatus from testing soft deletesstatic final classStatus from testing stored fields.static final classStatus from testing term index.static final classStatus from testing stored fields.static final classStatus from testing vector values -
Field Summary
FieldsModifier and TypeFieldDescriptionbooleanTrue if no problems were found with the index.Directory index is in.longThe greatest segment name.booleanTrue if we were unable to locate and load the segments_N file.intHow many bad segments were found.intNumber of segments in the index.booleanTrue if we checked only specific segments (CheckIndex.checkIndex(List)was called with non-null argument).List ofCheckIndex.Status.SegmentInfoStatusinstances, detailing status of each segment.Empty unless you passed specific segments list to check as optional 3rd argument.Name of latest segments_N file in the index.booleanTrue if the index was created with a newer version of Lucene than the CheckIndex tool.intHow many documents will be lost to bad segments.Holds the userData of the last commit in the indexbooleanWhether the SegmentInfos.counter is greater than any of the segments' names. -
Method Summary
-
Field Details
-
clean
public boolean cleanTrue if no problems were found with the index. -
missingSegments
public boolean missingSegmentsTrue if we were unable to locate and load the segments_N file. -
segmentsFileName
Name of latest segments_N file in the index. -
numSegments
public int numSegmentsNumber of segments in the index. -
segmentsChecked
Empty unless you passed specific segments list to check as optional 3rd argument.- See Also:
-
toolOutOfDate
public boolean toolOutOfDateTrue if the index was created with a newer version of Lucene than the CheckIndex tool. -
segmentInfos
List ofCheckIndex.Status.SegmentInfoStatusinstances, detailing status of each segment. -
dir
Directory index is in. -
totLoseDocCount
public int totLoseDocCountHow many documents will be lost to bad segments. -
numBadSegments
public int numBadSegmentsHow many bad segments were found. -
partial
public boolean partialTrue if we checked only specific segments (CheckIndex.checkIndex(List)was called with non-null argument). -
maxSegmentName
public long maxSegmentNameThe greatest segment name. -
validCounter
public boolean validCounterWhether the SegmentInfos.counter is greater than any of the segments' names. -
userData
Holds the userData of the last commit in the index
-