Lucene.Net.Index.StringFieldEnumerator Class Reference

Implementation for enumerating over terms with a string value. More...

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

Public Member Functions
	StringFieldEnumerator (IndexReader reader, string fieldName)
	Construct an enumerator over one field.
	StringFieldEnumerator (IndexReader reader, string fieldName, bool includeDocs)
	Construct an enumerator over one field.
Public Member Functions inherited from Lucene.Net.Index.FieldEnumerator< T >
void	Dispose ()
	Dispose of the instance.

Protected Member Functions
override bool	TryParse (string s)
	Sets the value of current.
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.

Additional Inherited Members
Protected Attributes inherited from Lucene.Net.Index.FieldEnumerator< T >
bool	includeDocs
	Whether the enumerator will include TermDocs.
TermEnumerator	tEnum
	The specialized TermEnum 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.

Detailed Description

Implementation for enumerating over terms with a string value.

Definition at line 519 of file FieldEnumerator.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.StringFieldEnumerator.StringFieldEnumerator	(	IndexReader	reader,
		string	fieldName
	)

Construct an enumerator over one field.

Parameters

reader	Index reader.
fieldName	The field to read.

Definition at line 526 of file FieldEnumerator.cs.

Lucene.Net.Index.StringFieldEnumerator.StringFieldEnumerator	(	IndexReader	reader,
		string	fieldName,
		bool	includeDocs
	)

Construct an enumerator over one field.

Parameters

reader	Index reader.
fieldName	The field to read.
includeDocs	Whether the TermDocs will also be enumerated.

Definition at line 537 of file FieldEnumerator.cs.

Member Function Documentation

override bool Lucene.Net.Index.StringFieldEnumerator.TryParse ( string  s )

protectedvirtual

Sets the value of current.

Parameters

s	The string.

Returns

Always true.

Implements Lucene.Net.Index.FieldEnumerator< T >.

Definition at line 547 of file FieldEnumerator.cs.

---

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

• contrib/Core/Index/FieldEnumerator.cs