Lucene.Net.Index.AbstractAllTermDocs Class Reference

Base class for enumerating all but deleted docs. More...

Inherits Lucene.Net.Index.TermDocs.

Inherited by Lucene.Net.Index.AllTermDocs.

Public Member Functions
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.
void	Seek (TermEnum termEnum)
	Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.
bool	Next ()
	Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration.
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.
bool	SkipTo (int target)
	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 ()
abstract bool	IsDeleted (int doc)

Protected Member Functions
	AbstractAllTermDocs (int maxDoc)
abstract void	Dispose (bool disposing)

Protected Attributes
int	maxDoc
int	internalDoc = -1

Properties
int	Doc [get]
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 enumerating all but deleted docs.

NOTE: this class is meant only to be used internally by Lucene; it's only public so it can be shared across packages. This means the API is freely subject to change, and, the class could be removed entirely, in any Lucene release. Use directly at your own risk!

Definition at line 31 of file AbstractAllTermDocs.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.AbstractAllTermDocs.AbstractAllTermDocs ( int  maxDoc )

protected

Definition at line 36 of file AbstractAllTermDocs.cs.

Member Function Documentation

void Lucene.Net.Index.AbstractAllTermDocs.Close

(

)

Frees associated resources.

Implements Lucene.Net.Index.TermDocs.

Definition at line 104 of file AbstractAllTermDocs.cs.

void Lucene.Net.Index.AbstractAllTermDocs.Dispose

(

)

Definition at line 109 of file AbstractAllTermDocs.cs.

abstract void Lucene.Net.Index.AbstractAllTermDocs.Dispose ( bool  disposing )

protectedpure virtual

Implemented in Lucene.Net.Index.AllTermDocs.

abstract bool Lucene.Net.Index.AbstractAllTermDocs.IsDeleted ( int  doc )

pure virtual

Implemented in Lucene.Net.Index.AllTermDocs.

bool Lucene.Net.Index.AbstractAllTermDocs.Next

(

)

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 AbstractAllTermDocs.cs.

int Lucene.Net.Index.AbstractAllTermDocs.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.

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

Implements Lucene.Net.Index.TermDocs.

Definition at line 73 of file AbstractAllTermDocs.cs.

void Lucene.Net.Index.AbstractAllTermDocs.Seek

(

Term

term

)

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 41 of file AbstractAllTermDocs.cs.

void Lucene.Net.Index.AbstractAllTermDocs.Seek

(

TermEnum

termEnum

)

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 AbstractAllTermDocs.cs.

bool Lucene.Net.Index.AbstractAllTermDocs.SkipTo

(

int

target

)

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 90 of file AbstractAllTermDocs.cs.

Member Data Documentation

int Lucene.Net.Index.AbstractAllTermDocs.internalDoc = -1

protected

Definition at line 34 of file AbstractAllTermDocs.cs.

int Lucene.Net.Index.AbstractAllTermDocs.maxDoc

protected

Definition at line 33 of file AbstractAllTermDocs.cs.

Property Documentation

int Lucene.Net.Index.AbstractAllTermDocs.Doc

get

Definition at line 59 of file AbstractAllTermDocs.cs.

int Lucene.Net.Index.AbstractAllTermDocs.Freq

get

Definition at line 64 of file AbstractAllTermDocs.cs.

---

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

• core/Index/AbstractAllTermDocs.cs