org.apache.lucene.index
Class DocsEnum

java.lang.Object
  org.apache.lucene.search.DocIdSetIterator
      org.apache.lucene.index.DocsEnum

Direct Known Subclasses:

DocsAndPositionsEnum, FilterAtomicReader.FilterDocsEnum, MappingMultiDocsEnum, MultiDocsEnum

public abstract class DocsEnum
extends DocIdSetIterator

Iterates through the documents and term freqs. NOTE: you must first call DocIdSetIterator.nextDoc() before using any of the per-doc methods.

Field Summary

static int

FLAG_FREQS Flag to pass to TermsEnum.docs(Bits,DocsEnum,int) if you require term frequencies in the returned enum.

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

protected

DocsEnum() Sole constructor.

Method Summary

AttributeSource	attributes() Returns the related attributes.
abstract int	freq() Returns term frequency in the current document.

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

advance, docID, nextDoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_FREQS

public static final int FLAG_FREQS

Flag to pass to TermsEnum.docs(Bits,DocsEnum,int) if you require term frequencies in the returned enum.

See Also:

Constant Field Values

Constructor Detail

DocsEnum

protected DocsEnum()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

freq

public abstract int freq()
                  throws IOException

Returns term frequency in the current document. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns NO_MORE_DOCS.

Throws:

IOException

attributes

public AttributeSource attributes()

Returns the related attributes.