FileDocCategorySizeDatePackage
TermFreqVector.javaAPI DocApache Lucene 2.2.02723Sat Jun 16 22:20:36 BST 2007org.apache.lucene.index

TermFreqVector

public interface TermFreqVector
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 {@link org.apache.lucene.document.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.

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetField()
The {@link org.apache.lucene.document.Fieldable} name.

return
The name of the field this vector is associated with.

public 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.
public java.lang.String[]getTerms()
return
An Array of term texts in ascending order.
public intindexOf(java.lang.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.
public int[]indexesOf(java.lang.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.
param
terms array containing terms to look for
param
start index in the array where the list of terms starts
param
len the number of terms in the list
public intsize()
return
The number of terms in the term vector.