Lucene.Net.Index.FilterIndexReader.FilterTermDocs Class Reference

Base class for filtering Lucene.Net.Index.TermDocs implementations. More...

Inherits Lucene.Net.Index.TermDocs.

Inherited by Lucene.Net.Index.FilterIndexReader.FilterTermPositions.

Public Member Functions
	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 ()

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
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.

Detailed Description

Base class for filtering Lucene.Net.Index.TermDocs implementations.

Definition at line 40 of file FilterIndexReader.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.FilterIndexReader.FilterTermDocs.FilterTermDocs

(

TermDocs

in_Renamed

)

Definition at line 44 of file FilterIndexReader.cs.

Member Function Documentation

void Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Close

(

)

Frees associated resources.

Implements Lucene.Net.Index.TermDocs.

Definition at line 81 of file FilterIndexReader.cs.

void Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Dispose

(

)

Definition at line 86 of file FilterIndexReader.cs.

virtual void Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Dispose ( bool  disposing )

protectedvirtual

Definition at line 91 of file FilterIndexReader.cs.

virtual bool Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Next ( )

virtual

Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration.

Implements Lucene.Net.Index.TermDocs.

Definition at line 68 of file FilterIndexReader.cs.

virtual int Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Read ( int[]  docs, int[]  freqs  )

virtual

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.

Returns the number of entries read. Zero is only returned when the stream has been exhausted.

Implements Lucene.Net.Index.TermDocs.

Definition at line 72 of file FilterIndexReader.cs.

virtual void Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Seek ( Term  term )

virtual

Sets this to the data for a term. The enumeration is reset to the start of the data for this term.

Implements Lucene.Net.Index.TermDocs.

Definition at line 49 of file FilterIndexReader.cs.

virtual void Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Seek ( TermEnum  termEnum )

virtual

Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.

Implements Lucene.Net.Index.TermDocs.

Definition at line 53 of file FilterIndexReader.cs.

virtual bool Lucene.Net.Index.FilterIndexReader.FilterTermDocs.SkipTo ( int  target )

virtual

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:

boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; } Some implementations are considerably more efficient than that.

Implements Lucene.Net.Index.TermDocs.

Definition at line 76 of file FilterIndexReader.cs.

Property Documentation

virtual int Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Doc

get

Definition at line 59 of file FilterIndexReader.cs.

virtual int Lucene.Net.Index.FilterIndexReader.FilterTermDocs.Freq

get

Definition at line 64 of file FilterIndexReader.cs.

---

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

• core/Index/FilterIndexReader.cs