public abstract class Terms extends Object
Fields
.Modifier and Type | Field and Description |
---|---|
static Terms[] |
EMPTY_ARRAY
Zero-length array of
Terms . |
Modifier | Constructor and Description |
---|---|
protected |
Terms()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
abstract 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.
|
Object |
getStats()
Expert: returns additional information about this Terms instance
for debugging purposes.
|
abstract long |
getSumDocFreq()
Returns the sum of
TermsEnum.docFreq() for
all terms in this field, or -1 if this measure isn't
stored by the codec. |
abstract long |
getSumTotalTermFreq()
Returns the sum of
TermsEnum.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). |
abstract boolean |
hasFreqs()
Returns true if documents in this field store
per-document term frequency (
PostingsEnum.freq() ). |
abstract boolean |
hasOffsets()
Returns true if documents in this field store offsets.
|
abstract boolean |
hasPayloads()
Returns true if documents in this field store payloads.
|
abstract 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 . |
abstract TermsEnum |
iterator()
Returns an iterator that will step through all
terms.
|
abstract long |
size()
Returns the number of terms for this field, or -1 if this
measure isn't stored by the codec.
|
protected Terms()
public abstract TermsEnum iterator() throws IOException
IOException
public TermsEnum intersect(CompiledAutomaton compiled, BytesRef startTerm) throws IOException
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
.NOTE: the terms dictionary is free to
return arbitrary terms as long as the resulted visited
docs is the same. E.g., BlockTreeTermsWriter
creates auto-prefix terms during indexing to reduce the
number of terms visited.
IOException
public abstract long size() throws IOException
IOException
public abstract long getSumTotalTermFreq() throws IOException
TermsEnum.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.IOException
public abstract long getSumDocFreq() throws IOException
TermsEnum.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.IOException
public abstract int getDocCount() throws IOException
IOException
public abstract boolean hasFreqs()
PostingsEnum.freq()
).public abstract boolean hasOffsets()
public abstract boolean hasPositions()
public abstract boolean hasPayloads()
public BytesRef getMin() throws IOException
IOException
public BytesRef getMax() throws IOException
IOException
public Object getStats() throws IOException
IOException
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.