Class CheckIndex.Status

Enclosing class:

public static class CheckIndex.Status extends Object
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.
  • Field Details

    • 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.
    • segmentsFileName

      public String segmentsFileName
      Name of latest segments_N file in the index.
    • numSegments

      public int numSegments
      Number of segments in the index.
    • segmentsChecked

      public List<String> segmentsChecked
      Empty unless you passed specific segments list to check as optional 3rd argument.
      See Also:
    • toolOutOfDate

      public boolean toolOutOfDate
      True if the index was created with a newer version of Lucene than the CheckIndex tool.
    • segmentInfos

      List of CheckIndex.Status.SegmentInfoStatus instances, 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 long maxSegmentName
      The greatest segment name.
    • validCounter

      public boolean validCounter
      Whether the SegmentInfos.counter is greater than any of the segments' names.
    • userData

      public Map<String,String> userData
      Holds the userData of the last commit in the index