Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | List of all members
Lucene.Net.Search.PrefixTermEnum Class Reference

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. More...

Inherits Lucene.Net.Search.FilteredTermEnum.

Public Member Functions

 PrefixTermEnum (IndexReader reader, Term prefix)
 
override float Difference ()
 Equality measure on the term
 
override bool EndEnum ()
 Indicates the end of the enumeration has been reached
 
- Public Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
override int DocFreq ()
 Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
 
override bool Next ()
 Increments the enumeration to the next element. True if one exists.
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Search.FilteredTermEnum
 FilteredTermEnum ()
 
override void Dispose (bool disposing)
 
- Properties inherited from Lucene.Net.Search.FilteredTermEnum
override Term Term [get]
 Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
 

Detailed Description

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.

Definition at line 33 of file PrefixTermEnum.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.PrefixTermEnum.PrefixTermEnum ( IndexReader  reader,
Term  prefix 
)

Definition at line 39 of file PrefixTermEnum.cs.

Member Function Documentation

override float Lucene.Net.Search.PrefixTermEnum.Difference ( )
virtual

Equality measure on the term

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 46 of file PrefixTermEnum.cs.

override bool Lucene.Net.Search.PrefixTermEnum.EndEnum ( )
virtual

Indicates the end of the enumeration has been reached

Implements Lucene.Net.Search.FilteredTermEnum.

Definition at line 51 of file PrefixTermEnum.cs.


The documentation for this class was generated from the following file: