org.apache.lucene.search.regex

Class RegexTermEnum


public class RegexTermEnum
extends FilteredTermEnum

Subclass of FilteredTermEnum for enumerating all terms that match the specified regular expression term using the specified regular expression implementation.

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

Constructor Summary

RegexTermEnum(IndexReader reader, Term term, org.apache.lucene.search.regex.RegexCapabilities regexImpl)

Method Summary

void
close()
Closes the enumeration to further activity, freeing resources.
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

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

close, difference, docFreq, endEnum, next, setEnum, term, termCompare

Methods inherited from class org.apache.lucene.index.TermEnum

close, docFreq, next, skipTo, term

Constructor Details

RegexTermEnum

public RegexTermEnum(IndexReader reader,
                     Term term,
                     org.apache.lucene.search.regex.RegexCapabilities regexImpl)
            throws IOException

Method Details

close

public void close()
            throws IOException
Closes the enumeration to further activity, freeing resources.
Overrides:
close in interface FilteredTermEnum

difference

public final float difference()
Equality measure on the term
Overrides:
difference in interface FilteredTermEnum

endEnum

public final boolean endEnum()
Indicates the end of the enumeration has been reached
Overrides:
endEnum in interface FilteredTermEnum

termCompare

protected final boolean termCompare(Term term)
Equality compare on the term
Overrides:
termCompare in interface FilteredTermEnum

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.