Package org.ametys.cms.search.solr

Record Class SearcherFactory.HighlightDefinition

java.lang.Object
java.lang.Record
org.ametys.cms.search.solr.SearcherFactory.HighlightDefinition
Record Components:
query - The highlighting query
snippets - The maximum number of fragments to return
fragSize - The size of fragments in characters
Enclosing class:
SearcherFactory
public static record SearcherFactory.HighlightDefinition(Query query, int snippets, int fragSize) extends Record
Record representing the highlighting parameters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HighlightDefinition(Query query, int snippets, int fragSize)
    Creates an instance of a HighlightDefinition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    fragSize()
    Returns the value of the fragSize record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    Query
    query()
    Returns the value of the query record component.
    int
    snippets()
    Returns the value of the snippets 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

  • Constructor Details

    • HighlightDefinition

      public HighlightDefinition(Query query, int snippets, int fragSize)
      Creates an instance of a HighlightDefinition record class.
      Parameters:
      query - the value for the query record component
      snippets - the value for the snippets record component
      fragSize - the value for the fragSize 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.

    • query

      public Query query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component

    • snippets

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

    • fragSize

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