Class Ranking

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class Ranking
    extends java.lang.Object
    implements java.lang.Cloneable, java.io.Serializable
    The rank settings given in a rank clause in the search definition.
    Author:
    Vegard Havdal
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Ranking()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Ranking clone()  
      boolean equals​(java.lang.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)  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Ranking

        public Ranking()
    • Method Detail

      • 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​(java.lang.Object o)
        Returns true if the given rank settings are the same
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • clone

        public Ranking clone()
        Overrides:
        clone in class java.lang.Object