org.apache.lucene.queries.function.valuesource

## Class MultiValuedLongFieldSource

- java.lang.Object
- - org.apache.lucene.queries.function.ValueSource
  - - org.apache.lucene.queries.function.valuesource.FieldCacheSource
    - - org.apache.lucene.queries.function.valuesource.LongFieldSource
      - - org.apache.lucene.queries.function.valuesource.MultiValuedLongFieldSource

-     public class MultiValuedLongFieldSource
      extends LongFieldSource

  Obtains long field values from `LeafReader.getSortedNumericDocValues(java.lang.String)` and using a `SortedNumericSelector` it gives a single-valued ValueSource view of a field.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected SortedNumericSelector.Type` | `selector`

    - ### Fields inherited from class org.apache.lucene.queries.function.valuesource.FieldCacheSource

      `field`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MultiValuedLongFieldSource(String field, SortedNumericSelector.Type selector)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `description()` description of field, used in explain()
    `boolean` | `equals(Object o)`
    `protected NumericDocValues` | `getNumericDocValues(Map context, LeafReaderContext readerContext)`
    `SortField` | `getSortField(boolean reverse)` EXPERIMENTAL: This method is subject to change.
    `int` | `hashCode()`

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

      `externalToLong, getValues, longToObject, longToString, newMutableValueLong`

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

      `getField`

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

      `asDoubleValuesSource, asLongValuesSource, createWeight, fromDoubleValuesSource, newContext, toString`

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

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

- - ### Field Detail

    - #### selector

          protected final SortedNumericSelector.Type selector

  - ### Constructor Detail

    - #### MultiValuedLongFieldSource

          public MultiValuedLongFieldSource(String field,
                                            SortedNumericSelector.Type selector)

  - ### Method Detail

    - #### getSortField

          public SortField getSortField(boolean reverse)

      Description copied from class: `ValueSource`
      EXPERIMENTAL: This method is subject to change.

      Get the SortField for this ValueSource. Uses the `ValueSource.getValues(java.util.Map, org.apache.lucene.index.LeafReaderContext)` to populate the SortField.

      Overrides:
        `getSortField` in class `LongFieldSource`
      Parameters:
        `reverse` - true if this is a reverse sort.
      Returns:
        The `SortField` for the ValueSource

    - #### description

          public String description()

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

    - #### getNumericDocValues

          protected NumericDocValues getNumericDocValues(Map context,
                                                         LeafReaderContext readerContext)
                                                  throws IOException

      Overrides:
        `getNumericDocValues` in class `LongFieldSource`
      Throws:
        `IOException`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `LongFieldSource`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `LongFieldSource`

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