Package org.apache.lucene.search

Class FieldComparator.ShortComparator

java.lang.Object
org.apache.lucene.search.FieldComparator<T>
org.apache.lucene.search.FieldComparator.NumericComparator<Short>
org.apache.lucene.search.FieldComparator.ShortComparator
Enclosing class:
FieldComparator<T>
@Deprecated public static final class FieldComparator.ShortComparator extends FieldComparator.NumericComparator<Short>
Deprecated.
Parses field's values as short (using FieldCache.getShorts(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and sorts by ascending value

  • Method Details

    • compare

      public int compare(int slot1, int slot2)
      Deprecated.
      Description copied from class: FieldComparator
      Compare hit at slot1 with hit at slot2.
      Specified by:
      compare in class FieldComparator<Short>
      Parameters:
      slot1 - first slot to compare
      slot2 - second slot to compare
      Returns:
      any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal

    • compareBottom

      public int compareBottom(int doc)
      Deprecated.
      Description copied from class: FieldComparator
      Compare the bottom of the queue with this doc. This will only invoked after setBottom has been called. This should return the same result as FieldComparator.compare(int,int)} as if bottom were slot1 and the new document were slot 2.

      For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).

      Specified by:
      compareBottom in class FieldComparator<Short>
      Parameters:
      doc - that was hit
      Returns:
      any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.

    • copy

      public void copy(int slot, int doc)
      Deprecated.
      Description copied from class: FieldComparator
      This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.
      Specified by:
      copy in class FieldComparator<Short>
      Parameters:
      slot - which slot to copy the hit to
      doc - docID relative to current reader

    • setNextReader

      public FieldComparator<Short> setNextReader(AtomicReaderContext context) throws IOException
      Deprecated.
      Description copied from class: FieldComparator
      Set a new AtomicReaderContext. All subsequent docIDs are relative to the current reader (you must add docBase if you need to map it to a top-level docID).
      Overrides:
      setNextReader in class FieldComparator.NumericComparator<Short>
      Parameters:
      context - current reader context
      Returns:
      the comparator to use for this segment; most comparators can just return "this" to reuse the same comparator across segments
      Throws:
      IOException - if there is a low-level IO error

    • setBottom

      public void setBottom(int bottom)
      Deprecated.
      Description copied from class: FieldComparator
      Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When FieldComparator.compareBottom(int) is called, you should compare against this slot. This will always be called before FieldComparator.compareBottom(int).
      Specified by:
      setBottom in class FieldComparator<Short>
      Parameters:
      bottom - the currently weakest (sorted last) slot in the queue

    • setTopValue

      public void setTopValue(Short value)
      Deprecated.
      Description copied from class: FieldComparator
      Record the top value, for future calls to FieldComparator.compareTop(int). This is only called for searches that use searchAfter (deep paging), and is called before any calls to FieldComparator.setNextReader(org.apache.lucene.index.AtomicReaderContext).
      Specified by:
      setTopValue in class FieldComparator<Short>

    • value

      public Short value(int slot)
      Deprecated.
      Description copied from class: FieldComparator
      Return the actual value in the slot.
      Specified by:
      value in class FieldComparator<Short>
      Parameters:
      slot - the value
      Returns:
      value in this slot

    • compareTop

      public int compareTop(int doc)
      Deprecated.
      Description copied from class: FieldComparator
      Compare the top value with this doc. This will only invoked after setTopValue has been called. This should return the same result as FieldComparator.compare(int,int)} as if topValue were slot1 and the new document were slot 2. This is only called for searches that use searchAfter (deep paging).
      Specified by:
      compareTop in class FieldComparator<Short>
      Parameters:
      doc - that was hit
      Returns:
      any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.