Class SegmentCommitInfo

java.lang.Object
org.apache.lucene.index.SegmentCommitInfo

public class SegmentCommitInfo extends Object
Embeds a [read-only] SegmentInfo and adds per-commit fields.
  • Field Details

  • Constructor Details

    • SegmentCommitInfo

      public SegmentCommitInfo(SegmentInfo info, int delCount, long delGen, long fieldInfosGen)
      Sole constructor.
      Parameters:
      info - SegmentInfo that we wrap
      delCount - number of deleted documents in this segment
      delGen - deletion generation number (used to name deletion files)
      fieldInfosGen - FieldInfos generation number (used to name field-infos files)
  • Method Details

    • getUpdatesFiles

      public Map<Long,Set<String>> getUpdatesFiles()
      Returns the per generation updates files.
    • setGenUpdatesFiles

      public void setGenUpdatesFiles(Map<Long,Set<String>> genUpdatesFiles)
      Sets the updates file names per generation. Does not deep clone the map.
    • sizeInBytes

      public long sizeInBytes() throws IOException
      Returns total size in bytes of all files for this segment.

      NOTE: This value is not correct for 3.0 segments that have shared docstores. To get the correct value, upgrade!

      Throws:
      IOException
    • files

      public Collection<String> files() throws IOException
      Returns all files in use by this segment.
      Throws:
      IOException
    • hasDeletions

      public boolean hasDeletions()
      Returns true if there are any deletions for the segment at this commit.
    • hasFieldUpdates

      public boolean hasFieldUpdates()
      Returns true if there are any field updates for the segment in this commit.
    • getNextFieldInfosGen

      public long getNextFieldInfosGen()
      Returns the next available generation number of the FieldInfos files.
    • getFieldInfosGen

      public long getFieldInfosGen()
      Returns the generation number of the field infos file or -1 if there are no field updates yet.
    • getNextDelGen

      public long getNextDelGen()
      Returns the next available generation number of the live docs file.
    • getDelGen

      public long getDelGen()
      Returns generation number of the live docs file or -1 if there are no deletes yet.
    • getDelCount

      public int getDelCount()
      Returns the number of deleted docs in the segment.
    • toString

      public String toString(Directory dir, int pendingDelCount)
      Returns a description of this segment.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • clone

      public SegmentCommitInfo clone()
      Overrides:
      clone in class Object