Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextFieldsReader.SimpleTextTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.codecs.simpletext.SimpleTextFieldsReader.SimpleTextTerms

All Implemented Interfaces:

Accountable

Enclosing class:

SimpleTextFieldsReader

private class SimpleTextFieldsReader.SimpleTextTerms
extends Terms
implements Accountable

Field Summary

Fields

Modifier and Type	Field	Description
private int	docCount
private final FieldInfo	fieldInfo
private FST<PairOutputs.Pair<PairOutputs.Pair<Long,Long>,PairOutputs.Pair<Long,Long>>>	fst
private final int	maxDoc
private final BytesRefBuilder	scratch
private final CharsRefBuilder	scratchUTF16
private long	sumDocFreq
private long	sumTotalTermFreq
private int	termCount
private final long	termsStart

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

EMPTY_ARRAY

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
SimpleTextTerms(String field, long termsStart, int maxDoc)

Method Summary

Modifier and Type	Method	Description
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
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	iterator()	Returns an iterator that will step through all terms.
private void	loadTerms()
long	ramBytesUsed()	Return the memory usage of this object in bytes.
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, intersect

Methods inherited from class java.lang.Object

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

Field Details

termsStart

private final long termsStart

fieldInfo

private final FieldInfo fieldInfo

maxDoc

private final int maxDoc

sumTotalTermFreq

private long sumTotalTermFreq

sumDocFreq

private long sumDocFreq

docCount

private int docCount

fst

private FST<PairOutputs.Pair<PairOutputs.Pair<Long,Long>,PairOutputs.Pair<Long,Long>>> fst

termCount

private int termCount

scratch

private final BytesRefBuilder scratch

scratchUTF16

private final CharsRefBuilder scratchUTF16

Constructor Details

SimpleTextTerms

public SimpleTextTerms(String field,
 long termsStart,
 int maxDoc)
                throws IOException

Throws:

IOException

Method Details

loadTerms

private void loadTerms()
                throws IOException

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Specified by:

getChildResources in interface Accountable

See Also:

• Accountables

toString

public String toString()

Overrides:

toString in class Object

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

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

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