Package com.yahoo.schema.document

Class Ranking

java.lang.Object
com.yahoo.schema.document.Ranking
All Implemented Interfaces:
Serializable, Cloneable
public class Ranking extends Object implements Cloneable, Serializable
The rank settings given in a rank clause in the search definition.
Author:
Vegard Havdal
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Ranking()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Ranking
    clone()
     
    boolean
    equals(Object o)
    Returns true if the given rank settings are the same
    int
    hashCode()
     
    boolean
    isFilter()
    Returns whether this is a filter.
    boolean
    isLiteral()
    Returns whether literal (non-stemmed, non-normalized) forms of the words should be indexed in a separate index which is searched by a automatically added rank term during searches.
    boolean
    isNormal()
    Whether user has explicitly requested normal (non-filter) behavior
    void
    setFilter(boolean filter)
     
    void
    setLiteral(boolean literal)
     
    void
    setNormal(boolean n)
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Ranking

      public Ranking()

  • Method Details

    • isLiteral

      public boolean isLiteral()

      Returns whether literal (non-stemmed, non-normalized) forms of the words should be indexed in a separate index which is searched by a automatically added rank term during searches.

      Default is false.

    • setLiteral

      public void setLiteral(boolean literal)

    • isFilter

      public boolean isFilter()

      Returns whether this is a filter. Filters will only tell if they are matched or not, no detailed relevance information will be available about the match.

      Matching a filter is much cheaper for the search engine than matching a regular field.

      Default is false.

    • setFilter

      public void setFilter(boolean filter)

    • isNormal

      public boolean isNormal()
      Whether user has explicitly requested normal (non-filter) behavior

    • setNormal

      public void setNormal(boolean n)

    • equals

      public boolean equals(Object o)
      Returns true if the given rank settings are the same
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • clone

      public Ranking clone()
      Overrides:
      clone in class Object