SuggestWordQueue

java.lang.Object

org.apache.lucene.util.PriorityQueue<SuggestWord>

org.apache.lucene.search.spell.SuggestWordQueue

All Implemented Interfaces:: Iterable<SuggestWord>

public final class SuggestWordQueue extends PriorityQueue<SuggestWord>

Sorts SuggestWord instances

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

private Comparator<SuggestWord>

comparator

static final Comparator<SuggestWord>

DEFAULT_COMPARATOR

Default comparator: score then frequency.
Constructor Summary

Constructors

Constructor

Description

SuggestWordQueue(int size)

Use the DEFAULT_COMPARATOR

SuggestWordQueue(int size, Comparator<SuggestWord> comparator)

Specify the size of the queue and the comparator to use for sorting.
Method Summary

Modifier and Type

Method

Description

protected final boolean

lessThan(SuggestWord wa, SuggestWord wb)

Determines the ordering of objects in this priority queue.

Methods inherited from class org.apache.lucene.util.PriorityQueue
add, addAll, clear, getHeapArray, insertWithOverflow, iterator, pop, remove, size, top, updateTop, updateTop

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Field Details
- DEFAULT_COMPARATOR
  
  public static final Comparator<SuggestWord> DEFAULT_COMPARATOR
  
  Default comparator: score then frequency.
  See Also:
  
  SuggestWordScoreComparator
- comparator
  
  private Comparator<SuggestWord> comparator
Constructor Details
- SuggestWordQueue
  
  public SuggestWordQueue(int size)
  
  Use the DEFAULT_COMPARATOR
  
  Parameters:
  
  size - The size of the queue
- SuggestWordQueue
  
  public SuggestWordQueue(int size, Comparator<SuggestWord> comparator)
  
  Specify the size of the queue and the comparator to use for sorting.
  
  Parameters:
  
  size - The size
  
  comparator - The comparator.
Method Details
- lessThan
  
  protected final boolean lessThan(SuggestWord wa, SuggestWord wb)
  
  Description copied from class: PriorityQueue
  
  Determines the ordering of objects in this priority queue. Subclasses must define this one method.
  
  Specified by:
  
  lessThan in class PriorityQueue<SuggestWord>
  
  Returns:
  
  true iff parameter a is less than parameter b.