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.
|
Base class for filtering TermPositions implementations. More...
Inherits Lucene.Net.Index.FilterIndexReader.FilterTermDocs, and Lucene.Net.Index.TermPositions.
Public Member Functions | |
FilterTermPositions (TermPositions in_Renamed) | |
virtual int | NextPosition () |
Returns next position in the current document. It is an error to call this more than TermDocs.Freq() times without calling TermDocs.Next()This is invalid until TermDocs.Next() is called for the first time. | |
virtual byte[] | GetPayload (byte[] data, int offset) |
Returns the payload data at the current term position. This is invalid until NextPosition() is called for the first time. This method must not be called more than once after each call of NextPosition(). However, payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. | |
Public Member Functions inherited from Lucene.Net.Index.FilterIndexReader.FilterTermDocs | |
FilterTermDocs (TermDocs in_Renamed) | |
virtual void | Seek (Term term) |
Sets this to the data for a term. The enumeration is reset to the start of the data for this term. | |
virtual void | Seek (TermEnum termEnum) |
Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations. | |
virtual bool | Next () |
Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration. | |
virtual int | Read (int[] docs, int[] freqs) |
Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are stored in docs, and term frequencies are stored in freqs. The freqs array must be as long as the docs array. | |
virtual bool | SkipTo (int i) |
Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns true iff there is such an entry. Behaves as if written: | |
void | Close () |
Frees associated resources. | |
void | Dispose () |
Properties | |
virtual int | PayloadLength [get] |
virtual bool | IsPayloadAvailable [get] |
Properties inherited from Lucene.Net.Index.FilterIndexReader.FilterTermDocs | |
virtual int | Doc [get] |
virtual int | Freq [get] |
Properties inherited from Lucene.Net.Index.TermDocs | |
int | Doc [get] |
Returns the current document number. This is invalid until Next() is called for the first time. | |
int | Freq [get] |
Returns the frequency of the term within the current document. This is invalid until Next() is called for the first time. | |
Properties inherited from Lucene.Net.Index.TermPositions | |
int | PayloadLength [get] |
Returns the length of the payload at the current term position. This is invalid until NextPosition() is called for the first time. | |
bool | IsPayloadAvailable [get] |
Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to NextPosition(). | |
Additional Inherited Members | |
Protected Member Functions inherited from Lucene.Net.Index.FilterIndexReader.FilterTermDocs | |
virtual void | Dispose (bool disposing) |
Base class for filtering TermPositions implementations.
Definition at line 101 of file FilterIndexReader.cs.
Lucene.Net.Index.FilterIndexReader.FilterTermPositions.FilterTermPositions | ( | TermPositions | in_Renamed | ) |
Definition at line 104 of file FilterIndexReader.cs.
|
virtual |
Returns the payload data at the current term position. This is invalid until NextPosition() is called for the first time. This method must not be called more than once after each call of NextPosition(). However, payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons.
data | the array into which the data of this payload is to be stored, if it is big enough; otherwise, a new byte[] array is allocated for this purpose. |
offset | the offset in the array into which the data of this payload is to be stored. |
<throws> IOException </throws>
Implements Lucene.Net.Index.TermPositions.
Definition at line 118 of file FilterIndexReader.cs.
|
virtual |
Returns next position in the current document. It is an error to call this more than TermDocs.Freq() times without calling TermDocs.Next()This is invalid until TermDocs.Next() is called for the first time.
Implements Lucene.Net.Index.TermPositions.
Definition at line 108 of file FilterIndexReader.cs.
|
get |
Definition at line 127 of file FilterIndexReader.cs.
|
get |
Definition at line 114 of file FilterIndexReader.cs.