Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.memory

Class FSTTermsReader.TermsReader

java.lang.Object

org.apache.lucene.index.Terms

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

Enclosing class:

FSTTermsReader

final class FSTTermsReader.TermsReader
extends Terms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	FSTTermsReader.TermsReader.BaseTermsEnum
private final class	FSTTermsReader.TermsReader.IntersectTermsEnum
private final class	FSTTermsReader.TermsReader.SegmentTermsEnum

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final FST<FSTTermOutputs.TermData>	dict
(package private) final int	docCount
(package private) final FieldInfo	fieldInfo
(package private) final long	numTerms
(package private) final long	sumDocFreq
(package private) final long	sumTotalTermFreq

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
TermsReader(FieldInfo fieldInfo, IndexInput in, long numTerms, long sumTotalTermFreq, long sumDocFreq, int docCount)

Method Summary

Modifier and Type	Method	Description
int	getDocCount()	Returns the number of documents that have at least one term for this field.
long	getSumDocFreq()	Returns the sum of TermsEnum.docFreq() for all terms in this field.
long	getSumTotalTermFreq()	Returns the sum of TermsEnum.totalTermFreq() for all terms in this field.
boolean	hasFreqs()	Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
boolean	hasOffsets()	Returns true if documents in this field store offsets.
boolean	hasPayloads()	Returns true if documents in this field store payloads.
boolean	hasPositions()	Returns true if documents in this field store positions.
TermsEnum	intersect(CompiledAutomaton compiled, BytesRef startTerm)	Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton.
TermsEnum	iterator()	Returns an iterator that will step through all terms.
long	size()	Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
String	toString()

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

getMax, getMin, getStats, getTerms

Methods inherited from class java.lang.Object

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

Field Details

fieldInfo

final FieldInfo fieldInfo

numTerms

final long numTerms

sumTotalTermFreq

final long sumTotalTermFreq

sumDocFreq

final long sumDocFreq

docCount

final int docCount

dict

final FST<FSTTermOutputs.TermData> dict

Constructor Details

TermsReader

TermsReader(FieldInfo fieldInfo,
 IndexInput in,
 long numTerms,
 long sumTotalTermFreq,
 long sumDocFreq,
 int docCount)
     throws IOException

Throws:

IOException

Method Details

toString

public String toString()

Overrides:

toString in class Object

hasFreqs

public boolean hasFreqs()

Description copied from class: Terms

Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).

Specified by:

hasFreqs in class Terms

hasOffsets

public boolean hasOffsets()

Description copied from class: Terms

Returns true if documents in this field store offsets.

Specified by:

hasOffsets in class Terms

hasPositions

public boolean hasPositions()

Description copied from class: Terms

Returns true if documents in this field store positions.

Specified by:

hasPositions in class Terms

hasPayloads

public boolean hasPayloads()

Description copied from class: Terms

Returns true if documents in this field store payloads.

Specified by:

hasPayloads in class Terms

size

public long size()

Description copied from class: Terms

Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

size in class Terms

getSumTotalTermFreq

public long getSumTotalTermFreq()

Description copied from class: Terms

Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getSumTotalTermFreq in class Terms

getSumDocFreq

public long getSumDocFreq()
                   throws IOException

Description copied from class: Terms

Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getSumDocFreq in class Terms

Throws:

IOException

getDocCount

public int getDocCount()
                throws IOException

Description copied from class: Terms

Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getDocCount in class Terms

Throws:

IOException

iterator

public TermsEnum iterator()
                   throws IOException

Description copied from class: Terms

Returns an iterator that will step through all terms. This method will not return null.

Specified by:

iterator in class Terms

Throws:

IOException

intersect

public TermsEnum intersect(CompiledAutomaton compiled,
 BytesRef startTerm)
                    throws IOException

Description copied from class: Terms

Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

This is an expert low-level API and will only work for NORMAL compiled automata. To handle any compiled automata you should instead use CompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms) instead.

NOTE: the returned TermsEnum cannot seek.

Overrides:

intersect in class Terms

Throws:

IOException