org.apache.lucene.index: public interface: TermPositionVector

org.apache.lucene.index
public interface: TermPositionVector [javadoc | source]

All Implemented Interfaces:
TermFreqVector

All Known Implementing Classes:
SegmentTermPositionVector

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.

Method from org.apache.lucene.index.TermPositionVector Summary:
getOffsets, getTermPositions

Method from org.apache.lucene.index.TermPositionVector Detail:
public 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 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.

Method from org.apache.lucene.index.TermPositionVector Detail:

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