FileDocCategorySizeDatePackage
TermPositionVector.javaAPI DocApache Lucene 1.91712Mon Feb 20 09:20:14 GMT 2006org.apache.lucene.index

TermPositionVector

public interface TermPositionVector implements TermFreqVector
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.

Fields Summary
Constructors Summary
Methods Summary
public org.apache.lucene.index.TermVectorOffsetInfo[]getOffsets(int index)
Returns an array of TermVectorOffsetInfo in which the term is found. May return null if offsets have not been stored.

see
org.apache.lucene.analysis.Token
param
index The position in the array to get the offsets from
return
An array of TermVectorOffsetInfo objects or the empty list

public 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.