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
public abstract static class FilterLeafReader.FilterTerms extends Terms
Base class for filteringTermsimplementations.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
Fields Modifier and Type Field Description protected TermsinThe underlying Terms instance.-
Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterTerms(Terms in)Creates a new FilterTerms
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetDocCount()Returns the number of documents that have at least one term for this field.ObjectgetStats()Expert: returns additional information about this Terms instance for debugging purposes.longgetSumDocFreq()Returns the sum ofTermsEnum.docFreq()for all terms in this field.longgetSumTotalTermFreq()Returns 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()).booleanhasOffsets()Returns true if documents in this field store offsets.booleanhasPayloads()Returns true if documents in this field store payloads.booleanhasPositions()Returns true if documents in this field store positions.TermsEnumiterator()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 Detail
-
in
protected final Terms in
The underlying Terms instance.
-
-
Constructor Detail
-
FilterTerms
protected FilterTerms(Terms in)
Creates a new FilterTerms- Parameters:
in- the underlying Terms instance.
-
-
Method Detail
-
iterator
public TermsEnum iterator() throws IOException
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
public long size() throws IOExceptionDescription 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
public long getSumTotalTermFreq() throws IOExceptionDescription 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
public long getSumDocFreq() throws IOExceptionDescription 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
public int getDocCount() throws IOExceptionDescription 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
public Object getStats() throws IOException
Description copied from class:TermsExpert: returns additional information about this Terms instance for debugging purposes.- Overrides:
getStatsin classTerms- Throws:
IOException
-
-