Record Class NumericWriteContext

java.lang.Object
java.lang.Record
org.elasticsearch.index.codec.tsdb.NumericWriteContext
Record Components:
meta - the metadata output stream
data - the data output stream
dir - the segment directory
ioContext - the I/O context for temporary files
maxDoc - the maximum document count in the segment
blockSize - the number of values per numeric block
primarySortFieldNumber - the field number of the primary sort field
formatConfig - the format configuration for this codec version

public record NumericWriteContext(org.apache.lucene.store.IndexOutput meta, org.apache.lucene.store.IndexOutput data, org.apache.lucene.store.Directory dir, org.apache.lucene.store.IOContext ioContext, int maxDoc, int blockSize, int primarySortFieldNumber, TSDBDocValuesFormatConfig formatConfig) extends Record
Shared write-path state for numeric field writers. Created once per segment by the consumer and passed to NumericFieldWriter instances.
  • Constructor Summary

    Constructors
    Constructor
    Description
    NumericWriteContext(org.apache.lucene.store.IndexOutput meta, org.apache.lucene.store.IndexOutput data, org.apache.lucene.store.Directory dir, org.apache.lucene.store.IOContext ioContext, int maxDoc, int blockSize, int primarySortFieldNumber, TSDBDocValuesFormatConfig formatConfig)
    Creates an instance of a NumericWriteContext record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the value of the blockSize record component.
    org.apache.lucene.store.IndexOutput
    Returns the value of the data record component.
    org.apache.lucene.store.Directory
    dir()
    Returns the value of the dir record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    Returns the value of the formatConfig record component.
    final int
    Returns a hash code value for this object.
    org.apache.lucene.store.IOContext
    Returns the value of the ioContext record component.
    int
    Returns the value of the maxDoc record component.
    org.apache.lucene.store.IndexOutput
    Returns the value of the meta record component.
    int
    Returns the value of the primarySortFieldNumber record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • NumericWriteContext

      public NumericWriteContext(org.apache.lucene.store.IndexOutput meta, org.apache.lucene.store.IndexOutput data, org.apache.lucene.store.Directory dir, org.apache.lucene.store.IOContext ioContext, int maxDoc, int blockSize, int primarySortFieldNumber, TSDBDocValuesFormatConfig formatConfig)
      Creates an instance of a NumericWriteContext record class.
      Parameters:
      meta - the value for the meta record component
      data - the value for the data record component
      dir - the value for the dir record component
      ioContext - the value for the ioContext record component
      maxDoc - the value for the maxDoc record component
      blockSize - the value for the blockSize record component
      primarySortFieldNumber - the value for the primarySortFieldNumber record component
      formatConfig - the value for the formatConfig 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.
    • meta

      public org.apache.lucene.store.IndexOutput meta()
      Returns the value of the meta record component.
      Returns:
      the value of the meta record component
    • data

      public org.apache.lucene.store.IndexOutput data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component
    • dir

      public org.apache.lucene.store.Directory dir()
      Returns the value of the dir record component.
      Returns:
      the value of the dir record component
    • ioContext

      public org.apache.lucene.store.IOContext ioContext()
      Returns the value of the ioContext record component.
      Returns:
      the value of the ioContext record component
    • maxDoc

      public int maxDoc()
      Returns the value of the maxDoc record component.
      Returns:
      the value of the maxDoc record component
    • blockSize

      public int blockSize()
      Returns the value of the blockSize record component.
      Returns:
      the value of the blockSize record component
    • primarySortFieldNumber

      public int primarySortFieldNumber()
      Returns the value of the primarySortFieldNumber record component.
      Returns:
      the value of the primarySortFieldNumber record component
    • formatConfig

      public TSDBDocValuesFormatConfig formatConfig()
      Returns the value of the formatConfig record component.
      Returns:
      the value of the formatConfig record component