Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.memory

Class FSTTermsReader.TermsReader.IntersectTermsEnum

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.IntersectTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

FSTTermsReader.TermsReader

private final class FSTTermsReader.TermsReader.IntersectTermsEnum
extends FSTTermsReader.TermsReader.BaseTermsEnum

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	FSTTermsReader.TermsReader.IntersectTermsEnum.Frame

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 ByteRunAutomaton	fsa
(package private) final FST<FSTTermOutputs.TermData>	fst
(package private) final Outputs<FSTTermOutputs.TermData>	fstOutputs
(package private) final FST.BytesReader	fstReader
(package private) int	level
(package private) int	metaUpto
(package private) boolean	pending
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame[]	stack
(package private) BytesRefBuilder	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
IntersectTermsEnum(CompiledAutomaton compiled, BytesRef startTerm)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	canGrow(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
(package private) boolean	canRewind(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
(package private) void	decodeMetaData()	Decodes metadata into customized term state
private BytesRef	doSeekCeil(BytesRef target)
(package private) BytesRefBuilder	grow(int label)
(package private) boolean	isAccept(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
(package private) boolean	isValid(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	loadCeilFrame(int label, FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top, FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)	Load frame for target arc(node) on fst, so that arc.label >= label and !fsa.reject(arc.label)
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	loadExpandFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top, FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)	Load frame for target arc(node) on fst
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	loadFirstFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)	Load frame for start arc(node) on fst
(package private) void	loadMetaData()	Lazily accumulate meta data, when we got a accepted term
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	loadNextFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top, FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)	Load frame for sibling arc(node) on fst
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	loadVirtualFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)	Virtual frame, never pop
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	newFrame()
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	popFrame()
(package private) void	pushFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
TermsEnum.SeekStatus	seekCeil(BytesRef target)	Seeks to the specified term, if it exists, or to the next (ceiling) term.
(package private) BytesRefBuilder	shrink()
BytesRef	term()	Returns current term.
(package private) FSTTermsReader.TermsReader.IntersectTermsEnum.Frame	topFrame()

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

term

BytesRefBuilder term

decoded

boolean decoded

pending

boolean pending

stack

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame[] stack

level

int level

metaUpto

int metaUpto

fst

final FST<FSTTermOutputs.TermData> fst

fstReader

final FST.BytesReader fstReader

fstOutputs

final Outputs<FSTTermOutputs.TermData> fstOutputs

fsa

final ByteRunAutomaton fsa

Constructor Details

IntersectTermsEnum

IntersectTermsEnum(CompiledAutomaton compiled,
 BytesRef startTerm)
            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

loadMetaData

void loadMetaData()

Lazily accumulate meta data, when we got a accepted term

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

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.

doSeekCeil

private BytesRef doSeekCeil(BytesRef target)
                     throws IOException

Throws:

IOException

loadVirtualFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame loadVirtualFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

Virtual frame, never pop

loadFirstFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame loadFirstFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
                                                            throws IOException

Load frame for start arc(node) on fst

Throws:

IOException

loadExpandFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame loadExpandFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top,
 FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
                                                             throws IOException

Load frame for target arc(node) on fst

Throws:

IOException

loadNextFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame loadNextFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top,
 FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
                                                           throws IOException

Load frame for sibling arc(node) on fst

Throws:

IOException

loadCeilFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame loadCeilFrame(int label,
 FSTTermsReader.TermsReader.IntersectTermsEnum.Frame top,
 FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)
                                                           throws IOException

Load frame for target arc(node) on fst, so that arc.label >= label and !fsa.reject(arc.label)

Throws:

IOException

isAccept

boolean isAccept(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

isValid

boolean isValid(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

canGrow

boolean canGrow(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

canRewind

boolean canRewind(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

pushFrame

void pushFrame(FSTTermsReader.TermsReader.IntersectTermsEnum.Frame frame)

popFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame popFrame()

newFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame newFrame()

topFrame

FSTTermsReader.TermsReader.IntersectTermsEnum.Frame topFrame()

grow

BytesRefBuilder grow(int label)

shrink

BytesRefBuilder shrink()