public class

PrefixTermEnum

extends FilteredTermEnum
java.lang.Object
   ↳ org.apache.lucene.index.TermEnum
     ↳ org.apache.lucene.search.FilteredTermEnum
       ↳ org.apache.lucene.search.PrefixTermEnum

Class Overview

Subclass of FilteredTermEnum for enumerating all terms that match the specified prefix filter term.

Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.search.FilteredTermEnum
Public Constructors
PrefixTermEnum(IndexReader reader, Term prefix)
Public Methods
float difference()
Equality measure on the term
Protected Methods
boolean endEnum()
Indicates the end of the enumeration has been reached
Term getPrefixTerm()
boolean termCompare(Term term)
Equality compare on the term
[Expand]
Inherited Methods
From class org.apache.lucene.search.FilteredTermEnum
From class org.apache.lucene.index.TermEnum
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public PrefixTermEnum (IndexReader reader, Term prefix)

Throws
IOException

Public Methods

public float difference ()

Equality measure on the term

Protected Methods

protected boolean endEnum ()

Indicates the end of the enumeration has been reached

protected Term getPrefixTerm ()

protected boolean termCompare (Term term)

Equality compare on the term