Package org.apache.lucene.index
Class FilterLeafReader.FilterTerms
java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.index.FilterLeafReader.FilterTerms
- Direct Known Subclasses:
ExitableDirectoryReader.ExitableTerms
- Enclosing class:
FilterLeafReader
Base class for filtering
Terms implementations.
NOTE: If the order of terms and documents is not changed, and if these terms are
going to be intersected with automata, you could consider overriding Terms.intersect(org.apache.lucene.util.automaton.CompiledAutomaton, org.apache.lucene.util.BytesRef) for
better performance.
-
Field Summary
FieldsFields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintReturns the number of documents that have at least one term for this field.getStats()Expert: returns additional information about this Terms instance for debugging purposes.longReturns the sum ofTermsEnum.docFreq()for all terms in this field.longReturns the sum ofTermsEnum.totalTermFreq()for all terms in this field.booleanhasFreqs()Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).booleanReturns true if documents in this field store offsets.booleanReturns true if documents in this field store payloads.booleanReturns true if documents in this field store positions.iterator()Returns an iterator that will step through all terms.longsize()Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
-
Field Details
-
in
The underlying Terms instance.
-
-
Constructor Details
-
FilterTerms
Creates a new FilterTerms- Parameters:
in- the underlying Terms instance.
-
-
Method Details
-
iterator
Description copied from class:TermsReturns an iterator that will step through all terms. This method will not return null.- Specified by:
iteratorin classTerms- Throws:
IOException
-
size
Description copied from class:TermsReturns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
sizein classTerms- Throws:
IOException
-
getSumTotalTermFreq
Description copied from class:TermsReturns the sum ofTermsEnum.totalTermFreq()for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getSumTotalTermFreqin classTerms- Throws:
IOException
-
getSumDocFreq
Description copied from class:TermsReturns the sum ofTermsEnum.docFreq()for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getSumDocFreqin classTerms- Throws:
IOException
-
getDocCount
Description copied from class:TermsReturns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.- Specified by:
getDocCountin classTerms- Throws:
IOException
-
hasFreqs
public boolean hasFreqs()Description copied from class:TermsReturns true if documents in this field store per-document term frequency (PostingsEnum.freq()). -
hasOffsets
public boolean hasOffsets()Description copied from class:TermsReturns true if documents in this field store offsets.- Specified by:
hasOffsetsin classTerms
-
hasPositions
public boolean hasPositions()Description copied from class:TermsReturns true if documents in this field store positions.- Specified by:
hasPositionsin classTerms
-
hasPayloads
public boolean hasPayloads()Description copied from class:TermsReturns true if documents in this field store payloads.- Specified by:
hasPayloadsin classTerms
-
getStats
Description copied from class:TermsExpert: returns additional information about this Terms instance for debugging purposes.- Overrides:
getStatsin classTerms- Throws:
IOException
-