public final class FieldReader extends Terms implements Accountable
Terms.EMPTY_ARRAYNULL_ACCOUNTABLE| Modifier and Type | Method and 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.
|
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 too
|
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 |
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() |
public BytesRef getMin() throws IOException
TermsgetMin in class TermsIOExceptionpublic BytesRef getMax() throws IOException
TermsgetMax in class TermsIOExceptionpublic Stats getStats() throws IOException
getStats in class TermsIOExceptionpublic boolean hasFreqs()
TermsPostingsEnum.freq()).public boolean hasOffsets()
TermshasOffsets in class Termspublic boolean hasPositions()
TermshasPositions in class Termspublic boolean hasPayloads()
TermshasPayloads in class Termspublic TermsEnum iterator() throws IOException
Termsiterator in class TermsIOExceptionpublic long size()
Termspublic long getSumTotalTermFreq()
TermsTermsEnum.totalTermFreq() for
all terms in this field. Note that, just like other term
measures, this measure does not take deleted documents
into account.getSumTotalTermFreq in class Termspublic long getSumDocFreq()
TermsTermsEnum.docFreq() for
all terms in this field. Note that, just like other term
measures, this measure does not take deleted documents
into account.getSumDocFreq in class Termspublic int getDocCount()
TermsgetDocCount in class Termspublic TermsEnum intersect(CompiledAutomaton compiled, BytesRef startTerm) throws IOException
TermsCompiledAutomaton. 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
.intersect in class TermsIOExceptionpublic long ramBytesUsed()
AccountableramBytesUsed in interface Accountablepublic Collection<Accountable> getChildResources()
AccountablegetChildResources in interface AccountableAccountablesCopyright © 2000-2024 Apache Software Foundation. All Rights Reserved.