Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.memory

Class FSTTermsReader.TermsReader.SegmentTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

org.apache.lucene.codecs.memory.FSTTermsReader.TermsReader.BaseTermsEnum

org.apache.lucene.codecs.memory.FSTTermsReader.TermsReader.SegmentTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

FSTTermsReader.TermsReader

private final class FSTTermsReader.TermsReader.SegmentTermsEnum
extends FSTTermsReader.TermsReader.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
(package private) boolean	decoded
(package private) final BytesRefFSTEnum<FSTTermOutputs.TermData>	fstEnum
(package private) boolean	seekPending
(package private) BytesRef	term

Fields inherited from class org.apache.lucene.codecs.memory.FSTTermsReader.TermsReader.BaseTermsEnum

bytesReader, meta, state

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SegmentTermsEnum()

Method Summary

Modifier and Type	Method	Description
(package private) void	decodeMetaData()	Decodes metadata into customized term state
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
TermsEnum.SeekStatus	seekCeil(BytesRef target)	Seeks to the specified term, if it exists, or to the next (ceiling) term.
boolean	seekExact(BytesRef target)	Attempts to seek to the exact term, returning true if the term is found.
void	seekExact(BytesRef target, TermState otherState)	Expert: Seeks a specific position by TermState previously obtained from TermsEnum.termState().
BytesRef	term()	Returns current term.
(package private) void	updateEnum(BytesRefFSTEnum.InputOutput<FSTTermOutputs.TermData> pair)

Methods inherited from class org.apache.lucene.codecs.memory.FSTTermsReader.TermsReader.BaseTermsEnum

docFreq, impacts, ord, postings, seekExact, termState, totalTermFreq

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

attributes

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

term

BytesRef term

fstEnum

final BytesRefFSTEnum<FSTTermOutputs.TermData> fstEnum

decoded

boolean decoded

seekPending

boolean seekPending

Constructor Details

SegmentTermsEnum

SegmentTermsEnum()
          throws IOException

Throws:

IOException

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

decodeMetaData

void decodeMetaData()
             throws IOException

Description copied from class: FSTTermsReader.TermsReader.BaseTermsEnum

Decodes metadata into customized term state

Specified by:

decodeMetaData in class FSTTermsReader.TermsReader.BaseTermsEnum

Throws:

IOException

updateEnum

void updateEnum(BytesRefFSTEnum.InputOutput<FSTTermOutputs.TermData> pair)

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.

seekExact

public boolean seekExact(BytesRef target)
                  throws IOException

Description copied from class: TermsEnum

Attempts 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 than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Overrides:

seekExact in class BaseTermsEnum

Returns:

true if the term is found; return false if the enum is unpositioned.

Throws:

IOException

seekCeil

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