Module org.apache.lucene.core

Package org.apache.lucene.codecs

Class DocValuesConsumer.MergedTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

org.apache.lucene.codecs.DocValuesConsumer.MergedTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

DocValuesConsumer

private static class DocValuesConsumer.MergedTermsEnum
extends BaseTermsEnum

A merged TermsEnum. This helps avoid relying on the default terms enum, which calls SortedDocValues.lookupOrd(int) or SortedSetDocValues.lookupOrd(long) on every call to BytesRefIterator.next().

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
private long	ord
private final OrdinalMap	ordinalMap
private final TermsEnum[]	subs
private BytesRef	term
private final long	valueCount

Fields inherited from class org.apache.lucene.index.TermsEnum

EMPTY

Constructor Summary

Constructors

Constructor	Description
MergedTermsEnum(OrdinalMap ordinalMap, TermsEnum[] subs)

Method Summary

Modifier and Type	Method	Description
AttributeSource	attributes()	Returns the related attributes.
int	docFreq()	Returns the number of documents containing the current term.
ImpactsEnum	impacts(int flags)	Return a ImpactsEnum.
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
long	ord()	Returns ordinal position for current term.
PostingsEnum	postings(PostingsEnum reuse, int flags)	Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required.
TermsEnum.SeekStatus	seekCeil(BytesRef text)	Seeks to the specified term, if it exists, or to the next (ceiling) term.
void	seekExact(long ord)	Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord().
BytesRef	term()	Returns current term.
TermState	termState()	Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.
long	totalTermFreq()	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

prepareSeekExact, seekExact, seekExact

Methods inherited from class org.apache.lucene.index.TermsEnum

postings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

subs

private final TermsEnum[] subs

ordinalMap

private final OrdinalMap ordinalMap

valueCount

private final long valueCount

ord

private long ord

term

private BytesRef term

Constructor Details

MergedTermsEnum

MergedTermsEnum(OrdinalMap ordinalMap,
 TermsEnum[] subs)

Method Details

term

public BytesRef term()
              throws IOException

Description copied from class: TermsEnum

Returns current term. Do not call this when the enum is unpositioned.

Specified by:

term in class TermsEnum

Throws:

IOException

ord

public long ord()
         throws IOException

Description copied from class: TermsEnum

Returns ordinal position for current term. This is an optional method (the codec may throw UnsupportedOperationException). Do not call this when the enum is unpositioned.

Specified by:

ord in class TermsEnum

Throws:

IOException

next

public BytesRef next()
              throws IOException

Description copied from interface: BytesRefIterator

Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if 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 BytesRef in the iterator or null if the end of the iterator is reached.

Throws:

IOException - If there is a low-level I/O error.

attributes

public AttributeSource attributes()

Description copied from class: TermsEnum

Returns the related attributes.

Overrides:

attributes in class BaseTermsEnum

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)
                              throws IOException

Description copied from class: TermsEnum

Seeks 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:

seekCeil in class TermsEnum

Throws:

IOException

seekExact

public void seekExact(long ord)
               throws IOException

Description copied from class: TermsEnum

Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.

Specified by:

seekExact in class TermsEnum

Throws:

IOException

docFreq

public int docFreq()
            throws IOException

Description copied from class: TermsEnum

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. TermsEnum.SeekStatus.END.

Specified by:

docFreq in class TermsEnum

Throws:

IOException

totalTermFreq

public long totalTermFreq()
                   throws IOException

Description copied from class: TermsEnum

Returns 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:

totalTermFreq in class TermsEnum

Throws:

IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
 int flags)
                      throws IOException

Description copied from class: TermsEnum

Get PostingsEnum for 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:

postings in class TermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

Throws:

IOException

impacts

public ImpactsEnum impacts(int flags)
                    throws IOException

Description copied from class: TermsEnum

Return a ImpactsEnum.

Specified by:

impacts in class TermsEnum

Throws:

IOException

See Also:

• TermsEnum.postings(PostingsEnum, int)

termState

public TermState termState()
                    throws IOException

Description copied from class: TermsEnum

Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.

NOTE: A seek by TermState might not capture the AttributeSource's state. Callers must maintain the AttributeSource states separately

Overrides:

termState in class BaseTermsEnum

Throws:

IOException

See Also:

• TermState
• TermsEnum.seekExact(BytesRef, TermState)