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 | Protected Member Functions | Properties | List of all members
Lucene.Net.Index.TermEnum Class Referenceabstract

Abstract class for enumerating terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...

Inherits IDisposable.

Inherited by Lucene.Net.Index.DirectoryReader.MultiTermEnum, Lucene.Net.Index.FilterIndexReader.FilterTermEnum, Lucene.Net.Index.Memory.MemoryIndex.MemoryIndexReader.MemoryTermEnum, Lucene.Net.Index.ParallelReader.ParallelTermEnum, and Lucene.Net.Index.SegmentTermEnum.

Public Member Functions

abstract bool Next ()
 Increments the enumeration to the next element. True if one exists.
 
abstract int DocFreq ()
 Returns the docFreq of the current Term in the enumeration.
 
void Close ()
 Closes the enumeration to further activity, freeing resources.
 
void Dispose ()
 Closes the enumeration to further activity, freeing resources.
 

Protected Member Functions

abstract void Dispose (bool disposing)
 

Properties

abstract Term Term [get]
 Returns the current Term in the enumeration.
 

Detailed Description

Abstract class for enumerating terms.

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

Definition at line 27 of file TermEnum.cs.

Member Function Documentation

void Lucene.Net.Index.TermEnum.Close ( )

Closes the enumeration to further activity, freeing resources.

Definition at line 40 of file TermEnum.cs.

void Lucene.Net.Index.TermEnum.Dispose ( )

Closes the enumeration to further activity, freeing resources.

Definition at line 46 of file TermEnum.cs.

abstract void Lucene.Net.Index.TermEnum.Dispose ( bool  disposing)
protectedpure virtual
abstract int Lucene.Net.Index.TermEnum.DocFreq ( )
pure virtual

Returns the docFreq of the current Term in the enumeration.

Implemented in Lucene.Net.Index.FilterIndexReader.FilterTermEnum.

abstract bool Lucene.Net.Index.TermEnum.Next ( )
pure virtual

Increments the enumeration to the next element. True if one exists.

Implemented in Lucene.Net.Index.FilterIndexReader.FilterTermEnum.

Property Documentation

abstract Term Lucene.Net.Index.TermEnum.Term
get

Returns the current Term in the enumeration.

Definition at line 33 of file TermEnum.cs.


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