Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Index.ITermFreqVector Interface Reference

Provides access to stored term vector of a document field. The vector consists of the name of the field, an array of the terms tha occur in the field of the Lucene.Net.Documents.Document and a parallel array of frequencies. Thus, getTermFrequencies()[5] corresponds with the frequency of getTerms()[5], assuming there are at least 5 terms in the Document. More...

Inherited by Lucene.Net.Index.EmptyVector, Lucene.Net.Index.SegmentTermVector, Lucene.Net.Index.TermPositionVector, and Lucene.Net.Search.QueryTermVector.

Public Member Functions

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.
 

Properties

string Field [get]
 The IFieldable name.
 
int Size [get]
 The number of terms in the term vector.
 

Detailed Description

Provides access to stored term vector of a document field. The vector consists of the name of the field, an array of the terms tha occur in the field of the Lucene.Net.Documents.Document and a parallel array of frequencies. Thus, getTermFrequencies()[5] corresponds with the frequency of getTerms()[5], assuming there are at least 5 terms in the Document.

Definition at line 29 of file TermFreqVector.cs.

Member Function Documentation

int [] Lucene.Net.Index.ITermFreqVector.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.

Implemented in Lucene.Net.Index.EmptyVector, Lucene.Net.Search.QueryTermVector, and Lucene.Net.Index.SegmentTermVector.

System.String [] Lucene.Net.Index.ITermFreqVector.GetTerms ( )
Returns
An Array of term texts in ascending order.

Implemented in Lucene.Net.Index.EmptyVector, Lucene.Net.Search.QueryTermVector, and Lucene.Net.Index.SegmentTermVector.

int [] Lucene.Net.Index.ITermFreqVector.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.

Parameters
termsarray containing terms to look for
startindex in the array where the list of terms starts
lenthe number of terms in the list

Implemented in Lucene.Net.Search.QueryTermVector, and Lucene.Net.Index.SegmentTermVector.

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

Implemented in Lucene.Net.Search.QueryTermVector, and Lucene.Net.Index.SegmentTermVector.

Property Documentation

string Lucene.Net.Index.ITermFreqVector.Field
get

The IFieldable name.

The name of the field this vector is associated with.

Definition at line 33 of file TermFreqVector.cs.

int Lucene.Net.Index.ITermFreqVector.Size
get

The number of terms in the term vector.

Definition at line 36 of file TermFreqVector.cs.


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