org.apache.lucene.search
Class WildcardTermEnum

java.lang.Object
  extended by org.apache.lucene.index.TermEnum
      extended by org.apache.lucene.search.FilteredTermEnum
          extended by org.apache.lucene.search.WildcardTermEnum
All Implemented Interfaces:
Closeable

public class WildcardTermEnum
extends FilteredTermEnum

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

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


Field Summary
static char WILDCARD_CHAR
           
static char WILDCARD_STRING
          String equality with support for wildcards
 
Fields inherited from class org.apache.lucene.search.FilteredTermEnum
actualEnum, currentTerm
 
Constructor Summary
WildcardTermEnum(IndexReader reader, Term term)
          Creates a new WildcardTermEnum.
 
Method Summary
 float difference()
          Equality measure on the term
 boolean endEnum()
          Indicates the end of the enumeration has been reached
protected  boolean termCompare(Term term)
          Equality compare on the term
static boolean wildcardEquals(String pattern, int patternIdx, String string, int stringIdx)
          Determines if a word matches a wildcard pattern.
 
Methods inherited from class org.apache.lucene.search.FilteredTermEnum
close, docFreq, next, setEnum, term
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WILDCARD_STRING

public static final char WILDCARD_STRING
String equality with support for wildcards

See Also:
Constant Field Values

WILDCARD_CHAR

public static final char WILDCARD_CHAR
See Also:
Constant Field Values
Constructor Detail

WildcardTermEnum

public WildcardTermEnum(IndexReader reader,
                        Term term)
                 throws IOException
Creates a new WildcardTermEnum.

After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Throws:
IOException
Method Detail

termCompare

protected final boolean termCompare(Term term)
Description copied from class: FilteredTermEnum
Equality compare on the term

Specified by:
termCompare in class FilteredTermEnum

difference

public float difference()
Description copied from class: FilteredTermEnum
Equality measure on the term

Specified by:
difference in class FilteredTermEnum

endEnum

public final boolean endEnum()
Description copied from class: FilteredTermEnum
Indicates the end of the enumeration has been reached

Specified by:
endEnum in class FilteredTermEnum

wildcardEquals

public static final boolean wildcardEquals(String pattern,
                                           int patternIdx,
                                           String string,
                                           int stringIdx)
Determines if a word matches a wildcard pattern. Work released by Granta Design Ltd after originally being done on company time.