Module org.elasticsearch.server
Package org.elasticsearch.index.mapper

Record Class TextSearchInfo

java.lang.Object
java.lang.Record
org.elasticsearch.index.mapper.TextSearchInfo
public record TextSearchInfo(org.apache.lucene.document.FieldType luceneFieldType, SimilarityProvider similarity, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuoteAnalyzer) extends Record
Encapsulates information about how to perform text searches over a field

  • Field Details

    • SIMPLE_MATCH_ONLY

      public static final TextSearchInfo SIMPLE_MATCH_ONLY
      Defines indexing information for fields that support only simple match text queries

    • WHITESPACE_MATCH_ONLY

      public static final TextSearchInfo WHITESPACE_MATCH_ONLY
      Defines indexing information for fields that index as keywords, but split query input on whitespace to build disjunctions.

    • SIMPLE_MATCH_WITHOUT_TERMS

      public static final TextSearchInfo SIMPLE_MATCH_WITHOUT_TERMS
      Defines indexing information for fields that support simple match text queries without using the terms index

    • NONE

      public static final TextSearchInfo NONE
      Specifies that this field does not support text searching of any kind

  • Constructor Details

    • TextSearchInfo

      public TextSearchInfo(org.apache.lucene.document.FieldType luceneFieldType, SimilarityProvider similarity, NamedAnalyzer searchAnalyzer, NamedAnalyzer searchQuoteAnalyzer)
      Create a new TextSearchInfo
      Parameters:
      luceneFieldType - the lucene FieldType of the field to be searched
      similarity - defines which Similarity to use when searching. If set to null then the default Similarity will be used.
      searchAnalyzer - the search-time analyzer to use. May not be null
      searchQuoteAnalyzer - the search-time analyzer to use for phrase searches. May not be null

  • Method Details

    • hasPositions

      public boolean hasPositions()
      Returns:
      whether or not this field supports positional queries

    • hasOffsets

      public boolean hasOffsets()
      Returns:
      whether or not this field has indexed offsets for highlighting

    • hasNorms

      public boolean hasNorms()
      Returns:
      whether or not this field has indexed norms

    • isTokenized

      public boolean isTokenized()
      Returns:
      whether or not this field is tokenized

    • termVectors

      public TextSearchInfo.TermVector termVectors()
      Returns:
      the type of term vectors available for this field

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

    • luceneFieldType

      public org.apache.lucene.document.FieldType luceneFieldType()
      Returns the value of the luceneFieldType record component.
      Returns:
      the value of the luceneFieldType record component

    • similarity

      public SimilarityProvider similarity()
      Returns the value of the similarity record component.
      Returns:
      the value of the similarity record component

    • searchAnalyzer

      public NamedAnalyzer searchAnalyzer()
      Returns the value of the searchAnalyzer record component.
      Returns:
      the value of the searchAnalyzer record component

    • searchQuoteAnalyzer

      public NamedAnalyzer searchQuoteAnalyzer()
      Returns the value of the searchQuoteAnalyzer record component.
      Returns:
      the value of the searchQuoteAnalyzer record component