Package com.attivio.sdk.search.relevancy

Enum ScoreMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScoreMode>
    public enum ScoreMode
extends java.lang.Enum<ScoreMode>
    Scoring mode for PhraseQuery relevancy.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BM11
      BM25 scoring with b coefficient of 1.0
      BM15
      BM25 scoring with b coefficient of 0.0
      CONSTANT
      Constant scoring.
      POSITION
      Position based scoring.
      TFIDF
      BM25 based scoring (default).

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ScoreMode valueOf​(Query query)
      Get the scoring mode set for query.
      static ScoreMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ScoreMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • TFIDF

        public static final ScoreMode TFIDF
        BM25 based scoring (default).

      • CONSTANT

        public static final ScoreMode CONSTANT
        Constant scoring.

      • POSITION

        public static final ScoreMode POSITION
        Position based scoring.

      • BM11

        public static final ScoreMode BM11
        BM25 scoring with b coefficient of 1.0

      • BM15

        public static final ScoreMode BM15
        BM25 scoring with b coefficient of 0.0

    • Method Detail

      • values

        public static ScoreMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ScoreMode c : ScoreMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ScoreMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • valueOf

        public static ScoreMode valueOf​(Query query)
        Get the scoring mode set for query.