Enum Class CombineFunction

java.lang.Object
java.lang.Enum<CombineFunction>
org.elasticsearch.common.lucene.search.function.CombineFunction
All Implemented Interfaces:
Serializable, Comparable<CombineFunction>, Constable, Writeable

public enum CombineFunction extends Enum<CombineFunction> implements Writeable
  • Enum Constant Details

  • Method Details

    • values

      public static CombineFunction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static CombineFunction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • combine

      public abstract float combine(double queryScore, double funcScore, double maxBoost)
    • explain

      public abstract org.apache.lucene.search.Explanation explain(org.apache.lucene.search.Explanation queryExpl, org.apache.lucene.search.Explanation funcExpl, float maxBoost)
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • readFromStream

      public static CombineFunction readFromStream(StreamInput in) throws IOException
      Throws:
      IOException
    • fromString

      public static CombineFunction fromString(String combineFunction)