Class FieldReader
 java.lang.Object

 org.apache.lucene.index.Terms

 org.apache.lucene.codecs.blocktree.FieldReader

 All Implemented Interfaces:
Accountable
public final class FieldReader extends Terms implements Accountable
BlockTree's implementation ofTerms
. NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.


Field Summary

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


Method Summary
All Methods Instance Methods Concrete Methods 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, or 1 if this measure isn't stored by the codec.BytesRef
getMax()
Returns the largest term (in lexicographic order) in the field.BytesRef
getMin()
Returns the smallest term (in lexicographic order) in the field.Stats
getStats()
For debugging  used by CheckIndex toolong
getSumDocFreq()
Returns the sum ofTermsEnum.docFreq()
for all terms in this field, or 1 if this measure isn't stored by the codec.long
getSumTotalTermFreq()
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field, or 1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).boolean
hasFreqs()
Returns true if documents in this field store perdocument 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 providedCompiledAutomaton
.TermsEnum
iterator()
Returns an iterator that will step through all terms.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()



Method Detail

getMin
public BytesRef getMin() throws IOException
Description copied from class:Terms
Returns the smallest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms. Overrides:
getMin
in classTerms
 Throws:
IOException

getMax
public BytesRef getMax() throws IOException
Description copied from class:Terms
Returns the largest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms. Overrides:
getMax
in classTerms
 Throws:
IOException

getStats
public Stats getStats() throws IOException
For debugging  used by CheckIndex too Overrides:
getStats
in classTerms
 Throws:
IOException

hasFreqs
public boolean hasFreqs()
Description copied from class:Terms
Returns true if documents in this field store perdocument term frequency (PostingsEnum.freq()
).

hasOffsets
public boolean hasOffsets()
Description copied from class:Terms
Returns true if documents in this field store offsets. Specified by:
hasOffsets
in classTerms

hasPositions
public boolean hasPositions()
Description copied from class:Terms
Returns true if documents in this field store positions. Specified by:
hasPositions
in classTerms

hasPayloads
public boolean hasPayloads()
Description copied from class:Terms
Returns true if documents in this field store payloads. Specified by:
hasPayloads
in classTerms

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

getSumTotalTermFreq
public long getSumTotalTermFreq()
Description copied from class:Terms
Returns the sum ofTermsEnum.totalTermFreq()
for all terms in this field, or 1 if this measure isn't stored by the codec (or if this fields omits term freq and positions). Note that, just like other term measures, this measure does not take deleted documents into account. Specified by:
getSumTotalTermFreq
in classTerms

getSumDocFreq
public long getSumDocFreq()
Description copied from class:Terms
Returns the sum ofTermsEnum.docFreq()
for all terms in 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:
getSumDocFreq
in classTerms

getDocCount
public int getDocCount()
Description copied from class:Terms
Returns the number of documents that have at least one term 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:
getDocCount
in classTerms

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 providedCompiledAutomaton
. If thestartTerm
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 providedstartTerm
must be accepted by the automaton.This is an expert lowlevel API and will only work for
NORMAL
compiled automata. To handle any compiled automata you should instead useCompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms)
instead.NOTE: the returned TermsEnum cannot seek
.NOTE: the terms dictionary is free to return arbitrary terms as long as the resulted visited docs is the same. E.g.,
BlockTreeTermsWriter
creates autoprefix terms during indexing to reduce the number of terms visited. Overrides:
intersect
in classTerms
 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 interfaceAccountable

getChildResources
public Collection<Accountable> getChildResources()
Description copied from interface:Accountable
Returns nested resources of this class. The result should be a pointintime snapshot (to avoid race conditions). Specified by:
getChildResources
in interfaceAccountable
 See Also:
Accountables

