org.apache.lucene.index
Class DocsEnum

java.lang.Object
  extended by org.apache.lucene.search.DocIdSetIterator
      extended by 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
 
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
 
Constructor Summary
DocsEnum()
           
 
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
 

Constructor Detail

DocsEnum

public DocsEnum()
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.



Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.