Lucene.Net.Index.TermPositionVector Interface Reference

Extends TermFreqVector to provide additional information about positions in which each of the terms is found. A TermPositionVector not necessarily contains both positions and offsets, but at least one of these arrays exists. More...

Inherits Lucene.Net.Index.ITermFreqVector.

Inherited by Lucene.Net.Index.Memory.MemoryIndex.MemoryIndexReader.MemoryTermPositionVector, and Lucene.Net.Index.SegmentTermPositionVector.

Public Member Functions
int[]	GetTermPositions (int index)
	Returns an array of positions in which the term is found. Terms are identified by the index at which its number appears in the term String array obtained from the indexOf method. May return null if positions have not been stored.
TermVectorOffsetInfo[]	GetOffsets (int index)
	Returns an array of TermVectorOffsetInfo in which the term is found. May return null if offsets have not been stored.
Public Member Functions inherited from Lucene.Net.Index.ITermFreqVector
System.String[]	GetTerms ()
int[]	GetTermFrequencies ()
	Array of term frequencies. Locations of the array correspond one to one to the terms in the array obtained from getTerms method. Each location in the array contains the number of times this term occurs in the document or the document field.
int	IndexOf (System.String term)
	Return an index in the term numbers array returned from getTerms at which the term with the specified term appears. If this term does not appear in the array, return -1.
int[]	IndexesOf (System.String[] terms, int start, int len)
	Just like indexOf(int) but searches for a number of terms at the same time. Returns an array that has the same size as the number of terms searched for, each slot containing the result of searching for that term number.

Additional Inherited Members
Properties inherited from Lucene.Net.Index.ITermFreqVector
string	Field [get]
	The IFieldable name.
int	Size [get]
	The number of terms in the term vector.

Detailed Description

Extends TermFreqVector to provide additional information about positions in which each of the terms is found. A TermPositionVector not necessarily contains both positions and offsets, but at least one of these arrays exists.

Definition at line 27 of file TermPositionVector.cs.

Member Function Documentation

TermVectorOffsetInfo [] Lucene.Net.Index.TermPositionVector.GetOffsets

(

int

index

)

Returns an array of TermVectorOffsetInfo in which the term is found. May return null if offsets have not been stored.

See Also

Lucene.Net.Analysis.Token

Parameters

index

The position in the array to get the offsets from

Returns

An array of TermVectorOffsetInfo objects or the empty list

Implemented in Lucene.Net.Index.SegmentTermPositionVector.

int [] Lucene.Net.Index.TermPositionVector.GetTermPositions

(

int

index

)

Returns an array of positions in which the term is found. Terms are identified by the index at which its number appears in the term String array obtained from the indexOf method. May return null if positions have not been stored.

Implemented in Lucene.Net.Index.SegmentTermPositionVector.

---

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

• core/Index/TermPositionVector.cs