Package org.apache.lucene.codecs.blockterms

Class BlockTermsReader.FieldReader.SegmentTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

org.apache.lucene.codecs.blockterms.BlockTermsReader.FieldReader.SegmentTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

BlockTermsReader.FieldReader

private final class BlockTermsReader.FieldReader.SegmentTermsEnum
extends BaseTermsEnum

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 int	blockTermCount
private byte[]	bytes
private ByteArrayDataInput	bytesReader
private boolean	didIndexNext
private byte[]	docFreqBytes
private boolean	doOrd
private BlockTermsReader.FieldAndTerm	fieldTerm
private ByteArrayDataInput	freqReader
private IndexInput	in
private TermsIndexReaderBase.FieldIndexEnum	indexEnum
private boolean	indexIsCurrent
private int	metaDataUpto
private BytesRef	nextIndexTerm
private boolean	seekPending
private BlockTermState	state
private BytesRefBuilder	term
private int	termBlockPrefix
private byte[]	termSuffixes
private ByteArrayDataInput	termSuffixesReader

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SegmentTermsEnum()

Method Summary

Modifier and Type	Method	Description
private BytesRef	_next()
private void	decodeMetaData()
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.
private boolean	nextBlock()
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 target)	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().
void	seekExact(BytesRef target, TermState otherState)	Expert: Seeks a specific position by TermState previously obtained from TermsEnum.termState().
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

attributes, 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 Detail

in

private final IndexInput in

state

private final BlockTermState state

doOrd

private final boolean doOrd

fieldTerm

private final BlockTermsReader.FieldAndTerm fieldTerm

indexEnum

private final TermsIndexReaderBase.FieldIndexEnum indexEnum

term

private final BytesRefBuilder term

indexIsCurrent

private boolean indexIsCurrent

didIndexNext

private boolean didIndexNext

nextIndexTerm

private BytesRef nextIndexTerm

seekPending

private boolean seekPending

termSuffixes

private byte[] termSuffixes

termSuffixesReader

private ByteArrayDataInput termSuffixesReader

termBlockPrefix

private int termBlockPrefix

blockTermCount

private int blockTermCount

docFreqBytes

private byte[] docFreqBytes

freqReader

private final ByteArrayDataInput freqReader

metaDataUpto

private int metaDataUpto

bytes

private byte[] bytes

bytesReader

private ByteArrayDataInput bytesReader

Constructor Detail

SegmentTermsEnum

public SegmentTermsEnum()
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef target)
                              throws java.io.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:

java.io.IOException

next

public BytesRef next()
              throws java.io.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:

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

_next

private BytesRef _next()
                throws java.io.IOException

Throws:

java.io.IOException

term

public BytesRef term()

Description copied from class: TermsEnum

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

Specified by:

term in class TermsEnum

docFreq

public int docFreq()
            throws java.io.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:

java.io.IOException

totalTermFreq

public long totalTermFreq()
                   throws java.io.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:

java.io.IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)
                      throws java.io.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:

java.io.IOException

impacts

public ImpactsEnum impacts(int flags)
                    throws java.io.IOException

Description copied from class: TermsEnum

Return a ImpactsEnum.

Specified by:

impacts in class TermsEnum

Throws:

java.io.IOException

See Also:

TermsEnum.postings(PostingsEnum, int)

seekExact

public void seekExact(BytesRef target,
                      TermState otherState)

Description copied from class: TermsEnum

Expert: Seeks a specific position by TermState previously obtained from TermsEnum.termState(). Callers should maintain the TermState to use this method. Low-level implementations may position the TermsEnum without re-seeking the term dictionary.

Seeking by TermState should only be used iff the state was obtained from the same TermsEnum instance.

NOTE: Using this method with an incompatible TermState might leave this TermsEnum in undefined state. On a segment level TermState instances are compatible only iff the source and the target TermsEnum operate on the same field. If operating on segment level, TermState instances must not be used across segments.

NOTE: A seek by TermState might not restore the AttributeSource's state. AttributeSource states must be maintained separately if this method is used.

Overrides:

seekExact in class BaseTermsEnum

Parameters:

target - the term the TermState corresponds to

otherState - the TermState

termState

public TermState termState()
                    throws java.io.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:

java.io.IOException

See Also:

TermState, TermsEnum.seekExact(BytesRef, TermState)

seekExact

public void seekExact(long ord)
               throws java.io.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:

java.io.IOException

ord

public long ord()

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

nextBlock

private boolean nextBlock()
                   throws java.io.IOException

Throws:

java.io.IOException

decodeMetaData

private void decodeMetaData()
                     throws java.io.IOException

Throws:

java.io.IOException