Package org.apache.lucene.codecs.memory

Class FSTTermsReader.TermsReader.BaseTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.BaseTermsEnum

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

All Implemented Interfaces:

BytesRefIterator

Direct Known Subclasses:

FSTTermsReader.TermsReader.IntersectTermsEnum, FSTTermsReader.TermsReader.SegmentTermsEnum

Enclosing class:

FSTTermsReader.TermsReader

abstract class FSTTermsReader.TermsReader.BaseTermsEnum
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
(package private) ByteArrayDataInput	bytesReader
(package private) FSTTermOutputs.TermData	meta
(package private) BlockTermState	state

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
BaseTermsEnum()

Method Summary

Modifier and Type	Method	Description
(package private) abstract void	decodeMetaData()	Decodes metadata into customized term state
int	docFreq()	Returns the number of documents containing the current term.
ImpactsEnum	impacts(int flags)	Return a ImpactsEnum.
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.
void	seekExact(long ord)	Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord().
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, seekExact

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

postings, seekCeil, term

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.BytesRefIterator

next

Field Detail

state

final BlockTermState state

meta

FSTTermOutputs.TermData meta

bytesReader

ByteArrayDataInput bytesReader

Constructor Detail

BaseTermsEnum

BaseTermsEnum()
       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

decodeMetaData

abstract void decodeMetaData()
                      throws java.io.IOException

Decodes metadata into customized term state

Throws:

java.io.IOException

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)

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