org.apache.lucene.queries.function.valuesource

## Class MultiFloatFunction

- java.lang.Object
- - org.apache.lucene.queries.function.ValueSource
  - - org.apache.lucene.queries.function.valuesource.MultiFloatFunction

- Direct Known Subclasses:
    MaxFloatFunction, MinFloatFunction, ProductFloatFunction, SumFloatFunction

      public abstract class MultiFloatFunction
      extends ValueSource

  Abstract `ValueSource` implementation which wraps multiple ValueSources and applies an extendible float function to their values.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected ValueSource[]` | `sources`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MultiFloatFunction(ValueSource[] sources)`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `createWeight(Map context, IndexSearcher searcher)` Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
    `String` | `description()` description of field, used in explain()
    `boolean` | `equals(Object o)`
    `protected boolean` | `exists(int doc, FunctionValues[] valsArr)` Called by `FunctionValues.exists(int)` for each document.
    `protected abstract float` | `func(int doc, FunctionValues[] valsArr)`
    `FunctionValues` | `getValues(Map context, LeafReaderContext readerContext)` Gets the values for this reader and the context that was previously passed to createWeight().
    `int` | `hashCode()`
    `protected abstract String` | `name()`

    - ### Methods inherited from class org.apache.lucene.queries.function.ValueSource

      `asDoubleValuesSource, asLongValuesSource, fromDoubleValuesSource, getSortField, newContext, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### sources

          protected final ValueSource[] sources

  - ### Constructor Detail

    - #### MultiFloatFunction

          public MultiFloatFunction(ValueSource[] sources)

  - ### Method Detail

    - #### name

          protected abstract String name()

    - #### func

          protected abstract float func(int doc,
                                        FunctionValues[] valsArr)
                                 throws IOException

      Throws:
        `IOException`

    - #### exists

          protected boolean exists(int doc,
                                   FunctionValues[] valsArr)
                            throws IOException

      Called by `FunctionValues.exists(int)` for each document. Default impl returns true if all of the specified `values` `FunctionValues.exists(int)` for the specified doc, else false.
      Throws:
        `IOException`
      See Also:
        `FunctionValues.exists(int)`, `MultiFunction.allExists(int, org.apache.lucene.queries.function.FunctionValues[])`

    - #### description

          public String description()

      Description copied from class: `ValueSource`
      description of field, used in explain()
      Specified by:
        `description` in class `ValueSource`

    - #### getValues

          public FunctionValues getValues(Map context,
                                          LeafReaderContext readerContext)
                                   throws IOException

      Description copied from class: `ValueSource`
      Gets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.
      Specified by:
        `getValues` in class `ValueSource`
      Throws:
        `IOException`

    - #### createWeight

          public void createWeight(Map context,
                                   IndexSearcher searcher)
                            throws IOException

      Description copied from class: `ValueSource`
      Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.
      Overrides:
        `createWeight` in class `ValueSource`
      Throws:
        `IOException`

    - #### hashCode

          public int hashCode()

      Specified by:
        `hashCode` in class `ValueSource`

    - #### equals

          public boolean equals(Object o)

      Specified by:
        `equals` in class `ValueSource`

Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.