Class FieldInvertState

  • public final class FieldInvertState
    extends Object
    This class tracks the number and position / offset parameters of terms being added to the index. The information collected in this class is also used to calculate the normalization factor for a field.
    WARNING: This API is experimental and might change in incompatible ways in the next release.
    • Constructor Detail

      • FieldInvertState

        public FieldInvertState​(int indexCreatedVersionMajor,
                                String name,
                                IndexOptions indexOptions)
        Creates {code FieldInvertState} for the specified field name.
      • FieldInvertState

        public FieldInvertState​(int indexCreatedVersionMajor,
                                String name,
                                IndexOptions indexOptions,
                                int position,
                                int length,
                                int numOverlap,
                                int offset,
                                int maxTermFrequency,
                                int uniqueTermCount)
        Creates {code FieldInvertState} for the specified field name and values for all fields.
    • Method Detail

      • getPosition

        public int getPosition()
        Get the last processed term position.
        the position
      • getLength

        public int getLength()
        Get total number of terms in this field.
        the length
      • setLength

        public void setLength​(int length)
        Set length value.
      • getNumOverlap

        public int getNumOverlap()
        Get the number of terms with positionIncrement == 0.
        the numOverlap
      • setNumOverlap

        public void setNumOverlap​(int numOverlap)
        Set number of terms with positionIncrement == 0.
      • getOffset

        public int getOffset()
        Get end offset of the last processed term.
        the offset
      • getMaxTermFrequency

        public int getMaxTermFrequency()
        Get the maximum term-frequency encountered for any term in the field. A field containing "the quick brown fox jumps over the lazy dog" would have a value of 2, because "the" appears twice.
      • getUniqueTermCount

        public int getUniqueTermCount()
        Return the number of unique terms encountered in this field.
      • getName

        public String getName()
        Return the field's name
      • getIndexCreatedVersionMajor

        public int getIndexCreatedVersionMajor()
        Return the version that was used to create the index, or 6 if it was created before 7.0.
      • getIndexOptions

        public IndexOptions getIndexOptions()
        Get the index options for this field