Module org.apache.lucene.codecs
Package org.apache.lucene.codecs.blocktreeords

Record Class OrdsBlockTreeTermsWriter.FieldMetaData

java.lang.Object
java.lang.Record
org.apache.lucene.codecs.blocktreeords.OrdsBlockTreeTermsWriter.FieldMetaData
Enclosing class:
OrdsBlockTreeTermsWriter
private static record OrdsBlockTreeTermsWriter.FieldMetaData(FieldInfo fieldInfo, FSTOrdsOutputs.Output rootCode, long numTerms, long indexStartFP, long sumTotalTermFreq, long sumDocFreq, int docCount, BytesRef minTerm, BytesRef maxTerm) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    docCount
    The field for the docCount record component.
    private final FieldInfo
    fieldInfo
    The field for the fieldInfo record component.
    private final long
    indexStartFP
    The field for the indexStartFP record component.
    private final BytesRef
    maxTerm
    The field for the maxTerm record component.
    private final BytesRef
    minTerm
    The field for the minTerm record component.
    private final long
    numTerms
    The field for the numTerms record component.
    private final FSTOrdsOutputs.Output
    rootCode
    The field for the rootCode record component.
    private final long
    sumDocFreq
    The field for the sumDocFreq record component.
    private final long
    sumTotalTermFreq
    The field for the sumTotalTermFreq record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    FieldMetaData(FieldInfo fieldInfo, FSTOrdsOutputs.Output rootCode, long numTerms, long indexStartFP, long sumTotalTermFreq, long sumDocFreq, int docCount, BytesRef minTerm, BytesRef maxTerm)
    Creates an instance of a FieldMetaData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    docCount()
    Returns the value of the docCount record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    FieldInfo
    fieldInfo()
    Returns the value of the fieldInfo record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    indexStartFP()
    Returns the value of the indexStartFP record component.
    BytesRef
    maxTerm()
    Returns the value of the maxTerm record component.
    BytesRef
    minTerm()
    Returns the value of the minTerm record component.
    long
    numTerms()
    Returns the value of the numTerms record component.
    FSTOrdsOutputs.Output
    rootCode()
    Returns the value of the rootCode record component.
    long
    sumDocFreq()
    Returns the value of the sumDocFreq record component.
    long
    sumTotalTermFreq()
    Returns the value of the sumTotalTermFreq record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • fieldInfo

      private final FieldInfo fieldInfo
      The field for the fieldInfo record component.

    • rootCode

      private final FSTOrdsOutputs.Output rootCode
      The field for the rootCode record component.

    • numTerms

      private final long numTerms
      The field for the numTerms record component.

    • indexStartFP

      private final long indexStartFP
      The field for the indexStartFP record component.

    • sumTotalTermFreq

      private final long sumTotalTermFreq
      The field for the sumTotalTermFreq record component.

    • sumDocFreq

      private final long sumDocFreq
      The field for the sumDocFreq record component.

    • docCount

      private final int docCount
      The field for the docCount record component.

    • minTerm

      private final BytesRef minTerm
      The field for the minTerm record component.

    • maxTerm

      private final BytesRef maxTerm
      The field for the maxTerm record component.

  • Constructor Details

    • FieldMetaData

      private FieldMetaData(FieldInfo fieldInfo, FSTOrdsOutputs.Output rootCode, long numTerms, long indexStartFP, long sumTotalTermFreq, long sumDocFreq, int docCount, BytesRef minTerm, BytesRef maxTerm)
      Creates an instance of a FieldMetaData record class.
      Parameters:
      fieldInfo - the value for the fieldInfo record component
      rootCode - the value for the rootCode record component
      numTerms - the value for the numTerms record component
      indexStartFP - the value for the indexStartFP record component
      sumTotalTermFreq - the value for the sumTotalTermFreq record component
      sumDocFreq - the value for the sumDocFreq record component
      docCount - the value for the docCount record component
      minTerm - the value for the minTerm record component
      maxTerm - the value for the maxTerm record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • fieldInfo

      public FieldInfo fieldInfo()
      Returns the value of the fieldInfo record component.
      Returns:
      the value of the fieldInfo record component

    • rootCode

      public FSTOrdsOutputs.Output rootCode()
      Returns the value of the rootCode record component.
      Returns:
      the value of the rootCode record component

    • numTerms

      public long numTerms()
      Returns the value of the numTerms record component.
      Returns:
      the value of the numTerms record component

    • indexStartFP

      public long indexStartFP()
      Returns the value of the indexStartFP record component.
      Returns:
      the value of the indexStartFP record component

    • sumTotalTermFreq

      public long sumTotalTermFreq()
      Returns the value of the sumTotalTermFreq record component.
      Returns:
      the value of the sumTotalTermFreq record component

    • sumDocFreq

      public long sumDocFreq()
      Returns the value of the sumDocFreq record component.
      Returns:
      the value of the sumDocFreq record component

    • docCount

      public int docCount()
      Returns the value of the docCount record component.
      Returns:
      the value of the docCount record component

    • minTerm

      public BytesRef minTerm()
      Returns the value of the minTerm record component.
      Returns:
      the value of the minTerm record component

    • maxTerm

      public BytesRef maxTerm()
      Returns the value of the maxTerm record component.
      Returns:
      the value of the maxTerm record component