Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator Class Reference

The enumerator over the terms in an index. More...

Inherits Lucene.Net.Index.FieldEnumerator< T >, and Lucene.Net.Index.FieldEnumerator< T >.

Public Member Functions
	TermEnumerator (TermEnum termEnum, TermDocs termDocs, string field, FieldEnumerator< T > enclosing)
	Ctor.
bool	MoveNext ()
	Advance to the next item.
void	Reset ()
	Reset the enumerator to the beginngin.
void	Dispose ()
IEnumerator< T >	GetEnumerator ()
	Accessor to IEnumerator-T-."/>
Public Member Functions inherited from Lucene.Net.Index.FieldEnumerator< T >
void	Dispose ()
	Dispose of the instance.

Protected Attributes
string	fieldName
	The field name, if any for the enum.
Protected Attributes inherited from Lucene.Net.Index.FieldEnumerator< T >
bool	includeDocs
	Whether the enumerator will include TermDocs.
TermEnumerator	tEnum
	The specialized TermEnum enumerator.

Properties
T	Current [get, set]
	The current item in the enumerator.
Properties inherited from Lucene.Net.Index.FieldEnumerator< T >
TermEnumerator	Terms [get]
	Access the enumerator for the terms.
TermDocEnumerator.TermDocUsingTermsEnumerator	Docs [get]
	Access the enumerator for the TermDocs.

Additional Inherited Members
Protected Member Functions inherited from Lucene.Net.Index.FieldEnumerator< T >
void	Init (IndexReader reader, string field)
	Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor.
void	Init (IndexReader reader, string fieldName, bool includeDocs)
	Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor.
abstract bool	TryParse (string s)
	Method to attempt to parse out the value from the encoded string and sets the value of Current.

Detailed Description

The enumerator over the terms in an index.

Definition at line 172 of file FieldEnumerator.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.TermEnumerator	(	TermEnum	termEnum,
		TermDocs	termDocs,
		string	field,
		FieldEnumerator< T >	enclosing
	)

Ctor.

Parameters

termEnum	The TermEnum to wrap.
termDocs	The TermDocs to wrap.
field
enclosing

Definition at line 211 of file FieldEnumerator.cs.

Member Function Documentation

void Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.Dispose

(

)

Definition at line 290 of file FieldEnumerator.cs.

IEnumerator<T> Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.GetEnumerator

(

)

Accessor to IEnumerator-T-."/>

Returns

Definition at line 303 of file FieldEnumerator.cs.

bool Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.MoveNext

(

)

Advance to the next item.

Returns

Definition at line 246 of file FieldEnumerator.cs.

void Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.Reset

(

)

Reset the enumerator to the beginngin.

Definition at line 281 of file FieldEnumerator.cs.

Member Data Documentation

string Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.fieldName

protected

The field name, if any for the enum.

Definition at line 192 of file FieldEnumerator.cs.

Property Documentation

T Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator.Current

getset

The current item in the enumerator.

Definition at line 225 of file FieldEnumerator.cs.

---

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

• contrib/Core/Index/FieldEnumerator.cs