FieldComparator.StringOrdValComparator (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.search.FieldComparator
- - org.apache.lucene.search.FieldComparator.StringOrdValComparator

Enclosing class:

FieldComparator
```
public static final class FieldComparator.StringOrdValComparator
extends FieldComparator
```
Sorts by field's natural String sort order, using ordinals. This is functionally equivalent to FieldComparator.StringValComparator, but it first resolves the string to their relative ordinal positions (using the index returned by FieldCache.getStringIndex(org.apache.lucene.index.IndexReader, java.lang.String)), and does most comparisons using the ordinals. For medium to large results, this comparator will be much faster than FieldComparator.StringValComparator. For very small result sets it may be slower.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
  FieldComparator.ByteComparator, FieldComparator.DocComparator, FieldComparator.DoubleComparator, FieldComparator.FloatComparator, FieldComparator.IntComparator, FieldComparator.LongComparator, FieldComparator.RelevanceComparator, FieldComparator.ShortComparator, FieldComparator.StringComparatorLocale, FieldComparator.StringOrdValComparator, FieldComparator.StringValComparator

Constructor Summary

Constructors
Constructor and Description
`StringOrdValComparator(int numHits, java.lang.String field, int sortPos, boolean reversed)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compare(int slot1, int slot2)` Compare hit at slot1 with hit at slot2.
`int`	`compareBottom(int doc)` Compare the bottom of the queue with doc.
`void`	`copy(int slot, int doc)` This method is called when a new hit is competitive.
`int`	`getBottomSlot()`
`java.lang.String`	`getField()`
`java.lang.String[]`	`getValues()`
`void`	`setBottom(int bottom)` Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.
`void`	`setNextReader(IndexReader reader, int docBase)` Set a new Reader.
`java.lang.Comparable`	`value(int slot)` Return the actual value in the slot.

Methods inherited from class org.apache.lucene.search.FieldComparator
binarySearch, binarySearch, setScorer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringOrdValComparator
```
public StringOrdValComparator(int numHits,
                              java.lang.String field,
                              int sortPos,
                              boolean reversed)
```
- Method Detail
  - compare
```
public int compare(int slot1,
                   int slot2)
```
    Description copied from class: FieldComparator
    
    Compare hit at slot1 with hit at slot2.
    
    Specified by:
    
    compare in class FieldComparator
    
    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)
```
    Description copied from class: FieldComparator
    
    Compare the bottom of the queue with 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
    
    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)
```
    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
    
    Parameters:
    
    slot - which slot to copy the hit to
    
    doc - docID relative to current reader
  - setNextReader
```
public void setNextReader(IndexReader reader,
                          int docBase)
                   throws java.io.IOException
```
    Description copied from class: FieldComparator
    
    Set a new Reader. All doc correspond to the current Reader.
    
    Specified by:
    
    setNextReader in class FieldComparator
    
    Parameters:
    
    reader - current reader
    
    docBase - docBase of this reader
    
    Throws:
    
    java.io.IOException
  - setBottom
```
public void setBottom(int bottom)
```
    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
    
    Parameters:
    
    bottom - the currently weakest (sorted last) slot in the queue
  - value
```
public java.lang.Comparable value(int slot)
```
    Description copied from class: FieldComparator
    
    Return the actual value in the slot.
    
    Specified by:
    
    value in class FieldComparator
    
    Parameters:
    
    slot - the value
    
    Returns:
    
    value in this slot upgraded to Comparable
  - getValues
```
public java.lang.String[] getValues()
```
  - getBottomSlot
```
public int getBottomSlot()
```
  - getField
```
public java.lang.String getField()
```

Class FieldComparator.StringOrdValComparator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.search.FieldComparator

Methods inherited from class java.lang.Object

Constructor Detail

StringOrdValComparator

Method Detail

compare

compareBottom

copy

setNextReader

setBottom

value

getValues

getBottomSlot

getField