org.apache.lucene.index

Interface TermFreqVector

Known Subinterfaces:
TermPositionVector
Known Implementing Classes:
QueryTermVector, SegmentTermPositionVector

public interface TermFreqVector

Provides access to stored term vector of a document field.

Method Summary

String
getField()
int[]
getTermFrequencies()
Array of term frequencies.
String[]
getTerms()
int
indexOf(String term)
Return an index in the term numbers array returned from getTerms at which the term with the specified term appears.
int[]
indexesOf(String[] terms, int start, int len)
Just like indexOf(int) but searches for a number of terms at the same time.
int
size()

Method Details

getField

public String getField()
Returns:
The field this vector is associated with.

getTermFrequencies

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.

getTerms

public String[] getTerms()
Returns:
An Array of term texts in ascending order.

indexOf

public int indexOf(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.

indexesOf

public int[] indexesOf(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:
terms - array containing terms to look for
start - index in the array where the list of terms starts
len - the number of terms in the list

size

public int size()
Returns:
The number of terms in the term vector.

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.