Lucene.Net.Index.MultipleTermPositions Class Reference

Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions. More...

Inherits Lucene.Net.Index.TermPositions.

Public Member Functions
	MultipleTermPositions (IndexReader indexReader, Term[] terms)
	Creates a new MultipleTermPositions instance.
bool	Next ()
	Moves to the next pair in the enumeration. Returns true iff there is such a next pair in the enumeration.
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.
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 ()
virtual void	Seek (Term arg0)
	Not implemented.
virtual void	Seek (TermEnum termEnum)
	Not implemented.
virtual int	Read (int[] arg0, int[] arg1)
	Not implemented.
virtual byte[]	GetPayload (byte[] data, int offset)
	Not implemented.

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
int	Doc [get]
int	Freq [get]
virtual int	PayloadLength [get]
	Not implemented.
virtual bool	IsPayloadAvailable [get]
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().
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

Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions.

Definition at line 29 of file MultipleTermPositions.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.MultipleTermPositions.MultipleTermPositions	(	IndexReader	indexReader,
		Term[]	terms
	)

Creates a new MultipleTermPositions instance.

Exceptions

System.IO.IOException

Definition at line 117 of file MultipleTermPositions.cs.

Member Function Documentation

void Lucene.Net.Index.MultipleTermPositions.Close

(

)

Frees associated resources.

Implements Lucene.Net.Index.TermDocs.

Definition at line 189 of file MultipleTermPositions.cs.

void Lucene.Net.Index.MultipleTermPositions.Dispose

(

)

Definition at line 194 of file MultipleTermPositions.cs.

virtual void Lucene.Net.Index.MultipleTermPositions.Dispose ( bool  disposing )

protectedvirtual

Definition at line 199 of file MultipleTermPositions.cs.

virtual byte [] Lucene.Net.Index.MultipleTermPositions.GetPayload ( byte[]  data, int  offset  )

virtual

Not implemented.

<throws> UnsupportedOperationException </throws>

Implements Lucene.Net.Index.TermPositions.

Definition at line 243 of file MultipleTermPositions.cs.

bool Lucene.Net.Index.MultipleTermPositions.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 128 of file MultipleTermPositions.cs.

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

Implements Lucene.Net.Index.TermPositions.

Definition at line 160 of file MultipleTermPositions.cs.

virtual int Lucene.Net.Index.MultipleTermPositions.Read ( int[]  arg0, int[]  arg1  )

virtual

Not implemented.

<throws> UnsupportedOperationException </throws>

Implements Lucene.Net.Index.TermDocs.

Definition at line 228 of file MultipleTermPositions.cs.

virtual void Lucene.Net.Index.MultipleTermPositions.Seek ( Term  arg0 )

virtual

Not implemented.

<throws> UnsupportedOperationException </throws>

Implements Lucene.Net.Index.TermDocs.

Definition at line 214 of file MultipleTermPositions.cs.

virtual void Lucene.Net.Index.MultipleTermPositions.Seek ( TermEnum  termEnum )

virtual

Not implemented.

<throws> UnsupportedOperationException </throws>

Implements Lucene.Net.Index.TermDocs.

Definition at line 221 of file MultipleTermPositions.cs.

bool Lucene.Net.Index.MultipleTermPositions.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 165 of file MultipleTermPositions.cs.

Property Documentation

int Lucene.Net.Index.MultipleTermPositions.Doc

get

Definition at line 179 of file MultipleTermPositions.cs.

int Lucene.Net.Index.MultipleTermPositions.Freq

get

Definition at line 184 of file MultipleTermPositions.cs.

virtual bool Lucene.Net.Index.MultipleTermPositions.IsPayloadAvailable

get

false

Definition at line 252 of file MultipleTermPositions.cs.

virtual int Lucene.Net.Index.MultipleTermPositions.PayloadLength

get

Not implemented.

<throws> UnsupportedOperationException </throws>

Definition at line 237 of file MultipleTermPositions.cs.

---

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

• core/Index/MultipleTermPositions.cs