Module org.elasticsearch.server
Package org.elasticsearch.search.aggregations.support

Record Class FieldContext

java.lang.Object
java.lang.Record
org.elasticsearch.search.aggregations.support.FieldContext
public record FieldContext(String field, IndexFieldData<?> indexFieldData, MappedFieldType fieldType) extends Record
Used by all field data based aggregators. This determine the context of the field data the aggregators are operating in. It holds both the field names and the index field datas that are associated with them.

  • Constructor Details

    • FieldContext

      public FieldContext(String field, IndexFieldData<?> indexFieldData, MappedFieldType fieldType)
      Constructs a field data context for the given field and its index field data
      Parameters:
      field - The name of the field
      indexFieldData - The index field data of the field

  • Method Details

    • indexFieldData

      public IndexFieldData<?> indexFieldData()
      Returns the value of the indexFieldData record component.
      Returns:
      the value of the indexFieldData record component

    • getTypeName

      public String getTypeName()

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • field

      public String field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • fieldType

      public MappedFieldType fieldType()
      Returns the value of the fieldType record component.
      Returns:
      the value of the fieldType record component