public abstract class DocsEnum extends DocIdSetIterator
DocIdSetIterator.nextDoc()
before using
any of the per-doc methods.Modifier and Type | Field and Description |
---|---|
static int |
FLAG_FREQS
Flag to pass to
TermsEnum.docs(Bits,DocsEnum,int)
if you require term frequencies in the returned enum. |
static int |
FLAG_NONE
Flag to pass to
TermsEnum.docs(Bits,DocsEnum,int) if you don't
require term frequencies in the returned enum. |
NO_MORE_DOCS
Modifier | Constructor and Description |
---|---|
protected |
DocsEnum()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
AttributeSource |
attributes()
Returns the related attributes.
|
abstract int |
freq()
Returns term frequency in the current document, or 1 if the field was
indexed with
FieldInfo.IndexOptions.DOCS_ONLY . |
advance, cost, docID, empty, nextDoc, slowAdvance
public static final int FLAG_NONE
TermsEnum.docs(Bits,DocsEnum,int)
if you don't
require term frequencies in the returned enum. When passed to
TermsEnum.docsAndPositions(Bits,DocsAndPositionsEnum,int)
means
that no offsets and payloads will be returned.public static final int FLAG_FREQS
TermsEnum.docs(Bits,DocsEnum,int)
if you require term frequencies in the returned enum.protected DocsEnum()
public abstract int freq() throws IOException
FieldInfo.IndexOptions.DOCS_ONLY
. Do not call this before
DocIdSetIterator.nextDoc()
is first called, nor after DocIdSetIterator.nextDoc()
returns
DocIdSetIterator.NO_MORE_DOCS
.
NOTE: if the DocsEnum
was obtain with FLAG_NONE
,
the result of this method is undefined.
IOException
public AttributeSource attributes()
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.