Package org.apache.lucene.codecs.memory
Class DirectPostingsFormat.DirectField.DirectIntersectTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.codecs.memory.DirectPostingsFormat.DirectField.DirectIntersectTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
- Enclosing class:
- DirectPostingsFormat.DirectField
private final class DirectPostingsFormat.DirectField.DirectIntersectTermsEnum extends BaseTermsEnum
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private classDirectPostingsFormat.DirectField.DirectIntersectTermsEnum.State-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Field Summary
Fields Modifier and Type Field Description private CompiledAutomatoncompiledAutomatonprivate RunAutomatonrunAutomatonprivate BytesRefscratchprivate DirectPostingsFormat.DirectField.DirectIntersectTermsEnum.State[]statesprivate intstateUptoprivate inttermOrd
-
Constructor Summary
Constructors Constructor Description DirectIntersectTermsEnum(CompiledAutomaton compiled, BytesRef startTerm)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdocFreq()Returns the number of documents containing the current term.private voidgrow()ImpactsEnumimpacts(int flags)Return aImpactsEnum.BytesRefnext()Increments the iteration to the nextBytesRefin the iterator.longord()Returns ordinal position for current term.PostingsEnumpostings(PostingsEnum reuse, int flags)GetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required.TermsEnum.SeekStatusseekCeil(BytesRef term)Seeks to the specified term, if it exists, or to the next (ceiling) term.voidseekExact(long ord)Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord().BytesRefterm()Returns current term.TermStatetermState()Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.longtotalTermFreq()Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).-
Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes, seekExact, seekExact
-
-
-
-
Field Detail
-
runAutomaton
private final RunAutomaton runAutomaton
-
compiledAutomaton
private final CompiledAutomaton compiledAutomaton
-
termOrd
private int termOrd
-
scratch
private final BytesRef scratch
-
states
private DirectPostingsFormat.DirectField.DirectIntersectTermsEnum.State[] states
-
stateUpto
private int stateUpto
-
-
Constructor Detail
-
DirectIntersectTermsEnum
public DirectIntersectTermsEnum(CompiledAutomaton compiled, BytesRef startTerm)
-
-
Method Detail
-
grow
private void grow()
-
next
public BytesRef next()
Description copied from interface:BytesRefIteratorIncrements the iteration to the nextBytesRefin the iterator. Returns the resultingBytesRefornullif the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.- Returns:
- the next
BytesRefin the iterator ornullif the end of the iterator is reached.
-
termState
public TermState termState()
Description copied from class:TermsEnumExpert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.NOTE: A seek by
TermStatemight not capture theAttributeSource's state. Callers must maintain theAttributeSourcestates separately- Overrides:
termStatein classBaseTermsEnum- See Also:
TermState,TermsEnum.seekExact(BytesRef, TermState)
-
term
public BytesRef term()
Description copied from class:TermsEnumReturns current term. Do not call this when the enum is unpositioned.
-
ord
public long ord()
Description copied from class:TermsEnumReturns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException). Do not call this when the enum is unpositioned.
-
docFreq
public int docFreq()
Description copied from class:TermsEnumReturns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END.
-
totalTermFreq
public long totalTermFreq()
Description copied from class:TermsEnumReturns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.- Specified by:
totalTermFreqin classTermsEnum
-
postings
public PostingsEnum postings(PostingsEnum reuse, int flags)
Description copied from class:TermsEnumGetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method will not return null.NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the
PostingsEnum.- Specified by:
postingsin classTermsEnum- Parameters:
reuse- pass a prior PostingsEnum for possible reuseflags- specifies which optional per-document values you require; seePostingsEnum.FREQS
-
impacts
public ImpactsEnum impacts(int flags) throws java.io.IOException
Description copied from class:TermsEnumReturn aImpactsEnum.- Specified by:
impactsin classTermsEnum- Throws:
java.io.IOException- See Also:
TermsEnum.postings(PostingsEnum, int)
-
seekCeil
public TermsEnum.SeekStatus seekCeil(BytesRef term)
Description copied from class:TermsEnumSeeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.
-
seekExact
public void seekExact(long ord)
Description copied from class:TermsEnumSeeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.
-
-