Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | List of all members
Lucene.Net.Index.TermDocEnumerator Class Reference

Class to handle creating a TermDocs and allowing for seeking and enumeration. Used when you have a set of one or moreterms for which you want to enumerate over the documents that contain those terms. More...

Inherits IEnumerable< int >, and IDisposable.

Classes

class  TermDocUsingTermsEnumerator
 Class to handle enumeration over the TermDocs that does NOT close them on a call to Dispose! More...
 

Public Member Functions

 TermDocEnumerator (TermDocs termDocs)
 Ctor.
 
void Seek (Term t)
 Seek to a specific term.
 
IEnumerator< int > GetEnumerator ()
 
void Dispose ()
 Dispose of the instance, closing the termdocs.
 

Detailed Description

Class to handle creating a TermDocs and allowing for seeking and enumeration. Used when you have a set of one or moreterms for which you want to enumerate over the documents that contain those terms.

Definition at line 330 of file FieldEnumerator.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.TermDocEnumerator.TermDocEnumerator ( TermDocs  termDocs)

Ctor.

Parameters
termDocsThe TermDocs to wrap.

Definition at line 341 of file FieldEnumerator.cs.

Member Function Documentation

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

Dispose of the instance, closing the termdocs.

Definition at line 378 of file FieldEnumerator.cs.

IEnumerator<int> Lucene.Net.Index.TermDocEnumerator.GetEnumerator ( )

Definition at line 357 of file FieldEnumerator.cs.

void Lucene.Net.Index.TermDocEnumerator.Seek ( Term  t)

Seek to a specific term.

Parameters
t

Definition at line 350 of file FieldEnumerator.cs.


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