Package com.attivio.sdk.search.query

Enum BoostQuery.Method

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BoostQuery.Method>
    Enclosing class:
    BoostQuery
    public static enum BoostQuery.Method
extends java.lang.Enum<BoostQuery.Method>
    Enum for specifying the method to use for applying boosts to the score for a search query.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PRODUCT
      Boost scores are multiplied into a document's score.
      SUM
      The default method, boost scores are added to a document's score.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BoostQuery.Method valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BoostQuery.Method[] 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

      • SUM

        public static final BoostQuery.Method SUM
        The default method, boost scores are added to a document's score.

      • PRODUCT

        public static final BoostQuery.Method PRODUCT
        Boost scores are multiplied into a document's score.

    • Method Detail

      • values

        public static BoostQuery.Method[] 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 (BoostQuery.Method c : BoostQuery.Method.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BoostQuery.Method 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