Package org.apache.lucene.index

Class NumericDocValues

java.lang.Object
org.apache.lucene.index.NumericDocValues
Direct Known Subclasses:
LongValues, PackedInts.Reader
public abstract class NumericDocValues extends Object
A per-document numeric value.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final NumericDocValues
    EMPTY
    An empty NumericDocValues which returns zero for every document

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    NumericDocValues()
    Sole constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract long
    get(int docID)
    Returns the numeric value for the specified document ID.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • EMPTY

      public static final NumericDocValues EMPTY
      An empty NumericDocValues which returns zero for every document

  • Constructor Details

    • NumericDocValues

      protected NumericDocValues()
      Sole constructor. (For invocation by subclass constructors, typically implicit.)

  • Method Details

    • get

      public abstract long get(int docID)
      Returns the numeric value for the specified document ID.
      Parameters:
      docID - document ID to lookup
      Returns:
      numeric value