Package org.apache.lucene.index
Class Terms
java.lang.Object
org.apache.lucene.index.Terms
- Direct Known Subclasses:
FieldReader,FilterLeafReader.FilterTerms,MultiTerms
Access to the terms in a specific field. See
Fields.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract intReturns the number of documents that have at least one term for this field.getMax()Returns the largest term (in lexicographic order) in the field.getMin()Returns the smallest term (in lexicographic order) in the field.getStats()Expert: returns additional information about this Terms instance for debugging purposes.abstract longReturns the sum ofTermsEnum.docFreq()for all terms in this field.abstract longReturns the sum ofTermsEnum.totalTermFreq()for all terms in this field.static TermsgetTerms(LeafReader reader, String field) Returns theTermsindex for this field, orEMPTYif it has none.abstract booleanhasFreqs()Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).abstract booleanReturns true if documents in this field store offsets.abstract booleanReturns true if documents in this field store payloads.abstract booleanReturns true if documents in this field store positions.intersect(CompiledAutomaton compiled, BytesRef startTerm) Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton.abstract TermsEnumiterator()Returns an iterator that will step through all terms.abstract longsize()Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
-
Field Details
-
EMPTY_ARRAY
Zero-length array ofTerms.
-
-
Constructor Details
-
Terms
protected Terms()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
getTerms
Returns theTermsindex for this field, orEMPTYif it has none.- Returns:
- terms instance, or an empty instance if
fielddoes not exist in this reader - Throws:
IOException- if an I/O error occurs.
-
iterator
Returns an iterator that will step through all terms. This method will not return null.- Throws:
IOException
-
intersect
Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton. If thestartTermis provided then the returned enum will only return terms> startTerm, but you still must call next() first to get to the first term. Note that the providedstartTermmust be accepted by the automaton.This is an expert low-level API and will only work for
NORMALcompiled automata. To handle any compiled automata you should instead useCompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms)instead.NOTE: the returned TermsEnum cannot seek.
- Throws:
IOException
-
size
Returns 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.- Throws:
IOException
-
getSumTotalTermFreq
Returns 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.- Throws:
IOException
-
getSumDocFreq
Returns 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.- Throws:
IOException
-
getDocCount
Returns 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.- Throws:
IOException
-
hasFreqs
public abstract boolean hasFreqs()Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()). -
hasOffsets
public abstract boolean hasOffsets()Returns true if documents in this field store offsets. -
hasPositions
public abstract boolean hasPositions()Returns true if documents in this field store positions. -
hasPayloads
public abstract boolean hasPayloads()Returns true if documents in this field store payloads. -
getMin
Returns the smallest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Throws:
IOException
-
getMax
Returns the largest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Throws:
IOException
-
getStats
Expert: returns additional information about this Terms instance for debugging purposes.- Throws:
IOException
-