Package org.apache.lucene.codecs.memory

Class LegacySortedDocValues

java.lang.Object
org.apache.lucene.codecs.memory.LegacyBinaryDocValues
org.apache.lucene.codecs.memory.LegacySortedDocValues
@Deprecated abstract class LegacySortedDocValues extends LegacyBinaryDocValues
Deprecated.
Use SortedDocValues instead.
A per-document byte[] with presorted values.

Per-Document values in a SortedDocValues are deduplicated, dereferenced, and sorted into a dictionary of unique values. A pointer to the dictionary value (ordinal) can be retrieved for each document. Ordinals are dense and in increasing sorted order.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final BytesRef
    empty
    Deprecated.
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    LegacySortedDocValues()
    Deprecated.
    Sole constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    BytesRef
    get(int docID)
    Deprecated.
    Lookup the value for document.
    abstract int
    getOrd(int docID)
    Deprecated.
    Returns the ordinal for the specified docID.
    abstract int
    getValueCount()
    Deprecated.
    Returns the number of unique values.
    abstract BytesRef
    lookupOrd(int ord)
    Deprecated.
    Retrieves the value for the specified ordinal.
    int
    lookupTerm(BytesRef key)
    Deprecated.
    If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.
    TermsEnum
    termsEnum()
    Deprecated.
    Returns a TermsEnum over the values.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • empty

      private final BytesRef empty
      Deprecated.

  • Constructor Details

    • LegacySortedDocValues

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

  • Method Details

    • getOrd

      public abstract int getOrd(int docID)
      Deprecated.
      Returns the ordinal for the specified docID.
      Parameters:
      docID - document ID to lookup
      Returns:
      ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order. Note that missing values are indicated by -1.

    • lookupOrd

      public abstract BytesRef lookupOrd(int ord)
      Deprecated.
      Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to lookupOrd(int) so make sure to copy it if you want to keep it around.
      Parameters:
      ord - ordinal to lookup (must be >= 0 and < getValueCount())
      See Also:

    • getValueCount

      public abstract int getValueCount()
      Deprecated.
      Returns the number of unique values.
      Returns:
      number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

    • get

      public BytesRef get(int docID)
      Deprecated.
      Description copied from class: LegacyBinaryDocValues
      Lookup the value for document. The returned BytesRef may be re-used across calls to LegacyBinaryDocValues.get(int) so make sure to copy it if you want to keep it around.
      Specified by:
      get in class LegacyBinaryDocValues

    • lookupTerm

      public int lookupTerm(BytesRef key)
      Deprecated.
      If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.
      Parameters:
      key - Key to look up

    • termsEnum

      public TermsEnum termsEnum()
      Deprecated.
      Returns a TermsEnum over the values. The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).