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.
|
Inherits IDisposable.
Inherited by Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator, Lucene.Net.Index.FieldEnumerator< T >.TermEnumerator, Lucene.Net.Index.NumericFieldEnum< T >, and Lucene.Net.Index.StringFieldEnumerator.
Classes | |
class | TermEnumerator |
The enumerator over the terms in an index. More... | |
Public Member Functions | |
void | Dispose () |
Dispose of the instance. | |
Protected Member Functions | |
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. | |
Protected Attributes | |
bool | includeDocs |
Whether the enumerator will include TermDocs. | |
TermEnumerator | tEnum |
The specialized TermEnum enumerator. | |
Properties | |
TermEnumerator | Terms [get] |
Access the enumerator for the terms. | |
TermDocEnumerator.TermDocUsingTermsEnumerator | Docs [get] |
Access the enumerator for the TermDocs. | |
Base class for the typed enumerators.
There are five implementations of FieldEnumeratorT for strings, integers, longs, floats, and doubles. The numeric enumerators support both standard Field and NumericField implementations. The string and numeric enumerators have slightly different options, but both should be used within a using statment to close the underlying TermEnum/TermDocs. Refer to the unit tests for usage examples.
T | The type of data being enumerated. |
Definition at line 49 of file FieldEnumerator.cs.
void Lucene.Net.Index.FieldEnumerator< T >.Dispose | ( | ) |
Dispose of the instance.
Definition at line 150 of file FieldEnumerator.cs.
|
protected |
Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor.
reader | The index reader to read from. |
field | The field to enumerate. |
Definition at line 87 of file FieldEnumerator.cs.
|
protected |
Initialization method called by subclasses to simulate a shared base constructor as generic classes cannot have a parameterized ctor.
reader | The index reader to read from. |
fieldName | The field to enumerate. |
includeDocs | Whether this enumerator will support TermDocs. |
Definition at line 99 of file FieldEnumerator.cs.
|
protectedpure virtual |
Method to attempt to parse out the value from the encoded string and sets the value of Current.
s | The encoded string. |
Implemented in Lucene.Net.Index.NumericFieldEnum< T >, and Lucene.Net.Index.StringFieldEnumerator.
|
protected |
Whether the enumerator will include TermDocs.
Definition at line 54 of file FieldEnumerator.cs.
|
protected |
The specialized TermEnum enumerator.
Definition at line 69 of file FieldEnumerator.cs.
|
get |
Access the enumerator for the TermDocs.
Definition at line 131 of file FieldEnumerator.cs.
|
get |
Access the enumerator for the terms.
Definition at line 123 of file FieldEnumerator.cs.