Package org.apache.lucene.index
Class MultiTerms
java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.index.MultiTerms
Exposes flex API, merged from flex API of sub-segments.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields 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.getMax()Returns the largest term (in lexicographic order) in the field.getMin()Returns the smallest term (in lexicographic order) in the field.Expert: returns pointers to the sub-readers corresponding to the Terms being merged.Terms[]Expert: returns the Terms being merged.longReturns the sum ofTermsEnum.docFreq()for all terms in this field.longReturns the sum ofTermsEnum.totalTermFreq()for all terms in this field.static PostingsEnumgetTermPostingsEnum(IndexReader r, String field, BytesRef term) ReturnsPostingsEnumfor the specified field and term.static PostingsEnumgetTermPostingsEnum(IndexReader r, String field, BytesRef term, int flags) ReturnsPostingsEnumfor the specified field and term, with control over whether freqs, positions, offsets or payloads are required.static TermsgetTerms(IndexReader r, String field) This method may return null if the field does not exist or if it has no terms.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.intersect(CompiledAutomaton compiled, BytesRef startTerm) Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton.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.
-
Constructor Details
-
MultiTerms
Sole constructor. UsegetTerms(IndexReader, String)instead if possible.- Parameters:
subs- TheTermsinstances of all sub-readers.subSlices- A parallel array (matchingsubs) describing the sub-reader slices.- Throws:
IOException- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Method Details
-
getTerms
This method may return null if the field does not exist or if it has no terms.- Throws:
IOException
-
getTermPostingsEnum
public static PostingsEnum getTermPostingsEnum(IndexReader r, String field, BytesRef term) throws IOException ReturnsPostingsEnumfor the specified field and term. This will return null if the field or term does not exist or positions were not indexed.- Throws:
IOException- See Also:
-
getTermPostingsEnum
public static PostingsEnum getTermPostingsEnum(IndexReader r, String field, BytesRef term, int flags) throws IOException ReturnsPostingsEnumfor the specified field and term, with control over whether freqs, positions, offsets or payloads are required. Some codecs may be able to optimize their implementation when offsets and/or payloads are not required. This will return null if the field or term does not exist. SeeTermsEnum.postings(PostingsEnum,int).- Throws:
IOException
-
getSubTerms
Expert: returns the Terms being merged. -
getSubSlices
Expert: returns pointers to the sub-readers corresponding to the Terms being merged. -
intersect
Description copied from class:TermsReturns 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.
- Overrides:
intersectin classTerms- Throws:
IOException
-
getMin
Description copied from class:TermsReturns 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.- Overrides:
getMinin classTerms- Throws:
IOException
-
getMax
Description copied from class:TermsReturns 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.- Overrides:
getMaxin classTerms- Throws:
IOException
-
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
public long 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. -
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
-