Class FilterLeafReader.FilterTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.FilterLeafReader.FilterTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
- Direct Known Subclasses:
ExitableDirectoryReader.ExitableTermsEnum
- Enclosing class:
- FilterLeafReader
public abstract static class FilterLeafReader.FilterTermsEnum extends TermsEnum
Base class for filteringTermsEnumimplementations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterTermsEnum(TermsEnum in)Creates a new FilterTermsEnum
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeSourceattributes()Returns the related attributes.intdocFreq()Returns the number of documents containing the current term.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 text)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().booleanseekExact(BytesRef text)Attempts to seek to the exact term, returning true if the term is found.voidseekExact(BytesRef term, TermState state)Expert: Seeks a specific position byTermStatepreviously obtained fromTermsEnum.termState().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).
-
-
-
Field Detail
-
in
protected final TermsEnum in
The underlying TermsEnum instance.
-
-
Constructor Detail
-
FilterTermsEnum
protected FilterTermsEnum(TermsEnum in)
Creates a new FilterTermsEnum- Parameters:
in- the underlying TermsEnum instance.
-
-
Method Detail
-
attributes
public AttributeSource attributes()
Description copied from class:TermsEnumReturns the related attributes.- Specified by:
attributesin classTermsEnum
-
seekCeil
public TermsEnum.SeekStatus seekCeil(BytesRef text) throws IOException
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.- Specified by:
seekCeilin classTermsEnum- Throws:
IOException
-
seekExact
public boolean seekExact(BytesRef text) throws IOException
Description copied from class:TermsEnumAttempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster thanTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).- Specified by:
seekExactin classTermsEnum- Returns:
- true if the term is found; return false if the enum is unpositioned.
- Throws:
IOException
-
seekExact
public void seekExact(long ord) throws IOExceptionDescription 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.- Specified by:
seekExactin classTermsEnum- Throws:
IOException
-
next
public BytesRef next() throws IOException
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. - Throws:
IOException- If there is a low-level I/O error.
-
term
public BytesRef term() throws IOException
Description copied from class:TermsEnumReturns current term. Do not call this when the enum is unpositioned.- Specified by:
termin classTermsEnum- Throws:
IOException
-
ord
public long ord() throws IOExceptionDescription 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.- Specified by:
ordin classTermsEnum- Throws:
IOException
-
docFreq
public int docFreq() throws IOExceptionDescription copied from class:TermsEnumReturns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END.- Specified by:
docFreqin classTermsEnum- Throws:
IOException
-
totalTermFreq
public long totalTermFreq() throws IOExceptionDescription 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- Throws:
IOException
-
postings
public PostingsEnum postings(PostingsEnum reuse, int flags) throws IOException
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- Throws:
IOException
-
impacts
public ImpactsEnum impacts(int flags) throws IOException
Description copied from class:TermsEnumReturn aImpactsEnum.- Specified by:
impactsin classTermsEnum- Throws:
IOException- See Also:
TermsEnum.postings(PostingsEnum, int)
-
seekExact
public void seekExact(BytesRef term, TermState state) throws IOException
Description copied from class:TermsEnumExpert: Seeks a specific position byTermStatepreviously obtained fromTermsEnum.termState(). Callers should maintain theTermStateto use this method. Low-level implementations may position the TermsEnum without re-seeking the term dictionary.Seeking by
TermStateshould only be used iff the state was obtained from the sameTermsEnuminstance.NOTE: Using this method with an incompatible
TermStatemight leave thisTermsEnumin undefined state. On a segment levelTermStateinstances are compatible only iff the source and the targetTermsEnumoperate on the same field. If operating on segment level, TermState instances must not be used across segments.NOTE: A seek by
TermStatemight not restore theAttributeSource's state.AttributeSourcestates must be maintained separately if this method is used.- Specified by:
seekExactin classTermsEnum- Parameters:
term- the term the TermState corresponds tostate- theTermState- Throws:
IOException
-
termState
public TermState termState() throws IOException
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- Specified by:
termStatein classTermsEnum- Throws:
IOException- See Also:
TermState,TermsEnum.seekExact(BytesRef, TermState)
-
-