Package org.apache.lucene.index

Class SegmentCommitInfo

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

    • Constructor Summary

      Constructors 
      Constructor Description
      SegmentCommitInfo​(SegmentInfo info, int delCount, long delGen, long fieldInfosGen)
      Sole constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SegmentCommitInfo clone()  
      java.util.Collection<java.lang.String> files()
      Returns all files in use by this segment.
      int getDelCount()
      Returns the number of deleted docs in the segment.
      long getDelGen()
      Returns generation number of the live docs file or -1 if there are no deletes yet.
      long getFieldInfosGen()
      Returns the generation number of the field infos file or -1 if there are no field updates yet.
      long getNextDelGen()
      Returns the next available generation number of the live docs file.
      long getNextFieldInfosGen()
      Returns the next available generation number of the FieldInfos files.
      java.util.Map<java.lang.Long,​java.util.Set<java.lang.String>> getUpdatesFiles()
      Returns the per generation updates files.
      boolean hasDeletions()
      Returns true if there are any deletions for the segment at this commit.
      boolean hasFieldUpdates()
      Returns true if there are any field updates for the segment in this commit.
      void setGenUpdatesFiles​(java.util.Map<java.lang.Long,​java.util.Set<java.lang.String>> genUpdatesFiles)
      Sets the updates file names per generation.
      long sizeInBytes()
      Returns total size in bytes of all files for this segment.
      java.lang.String toString()  
      java.lang.String toString​(Directory dir, int pendingDelCount)
      Returns a description of this segment.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • 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 Detail

      • getUpdatesFiles

        public java.util.Map<java.lang.Long,​java.util.Set<java.lang.String>> getUpdatesFiles()
        Returns the per generation updates files.

      • setGenUpdatesFiles

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

      • sizeInBytes

        public long sizeInBytes()
                 throws java.io.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:
        java.io.IOException

      • files

        public java.util.Collection<java.lang.String> files()
                                             throws java.io.IOException
        Returns all files in use by this segment.
        Throws:
        java.io.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 java.lang.String toString​(Directory dir,
                                 int pendingDelCount)
        Returns a description of this segment.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object