public final class FieldReader extends Terms implements Accountable
Terms
.Modifier and Type | Field and Description |
---|---|
private static long |
BASE_RAM_BYTES_USED |
(package private) int |
docCount |
(package private) FieldInfo |
fieldInfo |
(package private) FST<BytesRef> |
index |
(package private) long |
indexStartFP |
(package private) boolean |
isFSTOffHeap |
(package private) int |
longsSize |
(package private) BytesRef |
maxTerm |
(package private) BytesRef |
minTerm |
(package private) long |
numTerms |
(package private) BlockTreeTermsReader |
parent |
(package private) long |
rootBlockFP |
(package private) BytesRef |
rootCode |
(package private) long |
sumDocFreq |
(package private) long |
sumTotalTermFreq |
EMPTY_ARRAY
Constructor and Description |
---|
FieldReader(BlockTreeTermsReader parent,
FieldInfo fieldInfo,
long numTerms,
BytesRef rootCode,
long sumTotalTermFreq,
long sumDocFreq,
int docCount,
long indexStartFP,
int longsSize,
IndexInput indexIn,
BytesRef minTerm,
BytesRef maxTerm,
boolean openedFromWriter,
BlockTreeTermsReader.FSTLoadMode fstLoadMode) |
Modifier and Type | Method and Description |
---|---|
java.util.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 . |
boolean |
isFstOffHeap()
Returns
true iff the FST is read off-heap. |
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.
|
java.lang.String |
toString() |
private static final long BASE_RAM_BYTES_USED
final long numTerms
final FieldInfo fieldInfo
final long sumTotalTermFreq
final long sumDocFreq
final int docCount
final long indexStartFP
final long rootBlockFP
final BytesRef rootCode
final BytesRef minTerm
final BytesRef maxTerm
final int longsSize
final BlockTreeTermsReader parent
final boolean isFSTOffHeap
FieldReader(BlockTreeTermsReader parent, FieldInfo fieldInfo, long numTerms, BytesRef rootCode, long sumTotalTermFreq, long sumDocFreq, int docCount, long indexStartFP, int longsSize, IndexInput indexIn, BytesRef minTerm, BytesRef maxTerm, boolean openedFromWriter, BlockTreeTermsReader.FSTLoadMode fstLoadMode) throws java.io.IOException
java.io.IOException
public BytesRef getMin() throws java.io.IOException
Terms
public BytesRef getMax() throws java.io.IOException
Terms
public Stats getStats() throws java.io.IOException
public boolean hasFreqs()
Terms
PostingsEnum.freq()
).public boolean hasOffsets()
Terms
hasOffsets
in class Terms
public boolean hasPositions()
Terms
hasPositions
in class Terms
public boolean hasPayloads()
Terms
hasPayloads
in class Terms
public TermsEnum iterator() throws java.io.IOException
Terms
public long size()
Terms
public long getSumTotalTermFreq()
Terms
TermsEnum.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 Terms
public long getSumDocFreq()
Terms
TermsEnum.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 Terms
public int getDocCount()
Terms
getDocCount
in class Terms
public TermsEnum intersect(CompiledAutomaton compiled, BytesRef startTerm) throws java.io.IOException
Terms
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
.public long ramBytesUsed()
Accountable
ramBytesUsed
in interface Accountable
public java.util.Collection<Accountable> getChildResources()
Accountable
getChildResources
in interface Accountable
Accountables
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isFstOffHeap()
true
iff the FST is read off-heap.