Package org.elasticsearch.common.lucene.search.function

Enum Class CombineFunction

<CombineFunction>
org.elasticsearch.common.lucene.search.function.CombineFunction
All Implemented Interfaces:
, <, Writeable
public enum CombineFunction extends <CombineFunction> implements Writeable

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AVG
     
    MAX
     
    MIN
     
    MULTIPLY
     
    REPLACE
     
    SUM
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract float
    combine​(double queryScore, double funcScore, double maxBoost)
     
    abstract org.apache.lucene.search.Explanation
    explain​(org.apache.lucene.search.Explanation queryExpl, org.apache.lucene.search.Explanation funcExpl, float maxBoost)
     
    static CombineFunction
     combineFunction)
     
    static CombineFunction
    readFromStream​(StreamInput in)
     
    static CombineFunction
     name)
    Returns the enum constant of this class with the specified name.
    static CombineFunction[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • 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  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:
      - if this enum class has no constant with the specified name
      - 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
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • readFromStream

      public static CombineFunction readFromStream​(StreamInput in) throws
      Throws:

    • fromString

      public static  combineFunction)