org.apache.lucene.index
Class SortedTermVectorMapper
java.lang.Object
org.apache.lucene.index.TermVectorMapper
org.apache.lucene.index.SortedTermVectorMapper
public class SortedTermVectorMapper
- extends TermVectorMapper
Store a sorted collection of TermVectorEntry
s. Collects all term information
into a single, SortedSet.
NOTE: This Mapper ignores all Field information for the Document. This means that if you are using offset/positions you will not
know what Fields they correlate with.
This is not thread-safe
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ALL
public static final String ALL
- Stand-in name for the field in
TermVectorEntry
.
- See Also:
- Constant Field Values
SortedTermVectorMapper
public SortedTermVectorMapper(Comparator<TermVectorEntry> comparator)
- Parameters:
comparator
- A Comparator for sorting TermVectorEntry
s
SortedTermVectorMapper
public SortedTermVectorMapper(boolean ignoringPositions,
boolean ignoringOffsets,
Comparator<TermVectorEntry> comparator)
map
public void map(String term,
int frequency,
TermVectorOffsetInfo[] offsets,
int[] positions)
- Description copied from class:
TermVectorMapper
- Map the Term Vector information into your own structure
- Specified by:
map
in class TermVectorMapper
- Parameters:
term
- The term to mapfrequency
- The frequency of the termoffsets
- Offset information, may be nullpositions
- Position information, may be null
setExpectations
public void setExpectations(String field,
int numTerms,
boolean storeOffsets,
boolean storePositions)
- Description copied from class:
TermVectorMapper
- Tell the mapper what to expect in regards to field, number of terms, offset and position storage.
This method will be called once before retrieving the vector for a field.
This method will be called before
TermVectorMapper.map(String,int,TermVectorOffsetInfo[],int[])
.
- Specified by:
setExpectations
in class TermVectorMapper
- Parameters:
field
- The field the vector is fornumTerms
- The number of terms that need to be mappedstoreOffsets
- true if the mapper should expect offset informationstorePositions
- true if the mapper should expect positions info
getTermVectorEntrySet
public SortedSet<TermVectorEntry> getTermVectorEntrySet()
- The TermVectorEntrySet. A SortedSet of
TermVectorEntry
objects. Sort is by the comparator passed into the constructor.
This set will be empty until after the mapping process takes place.
- Returns:
- The SortedSet of
TermVectorEntry
.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.