org.cdlib.xtf.textEngine
Class BoostSet.DocIter

Object
  extended by BoostSet.DocIter
Enclosing class:
BoostSet

private class BoostSet.DocIter
extends Object

Iterates all the document keys in an index


Field Summary
(package private)  String docKey
           
(package private)  boolean done
           
(package private)  String field
           
(package private)  TermEnum termEnum
           
(package private)  TermPositions termPositions
           
 
Constructor Summary
BoostSet.DocIter(IndexReader indexReader, String field)
          Construct from an index reader
 
Method Summary
(package private)  void close()
          Clean up
(package private)  int docId()
          Gets the Lucene document ID of the current document
(package private)  boolean done()
          Return true if there are no more documents to read
(package private)  String key()
          Gets the key of the current document
(package private)  void next()
          Advances to the next document in the index
private  void readDocKey()
          Fetch the current document key; update done
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

done

boolean done

docKey

String docKey

field

String field

termPositions

TermPositions termPositions

termEnum

TermEnum termEnum
Constructor Detail

BoostSet.DocIter

BoostSet.DocIter(IndexReader indexReader,
                 String field)
           throws IOException
Construct from an index reader

Throws:
IOException
Method Detail

done

boolean done()
Return true if there are no more documents to read


key

String key()
Gets the key of the current document


docId

int docId()
    throws IOException
Gets the Lucene document ID of the current document

Throws:
IOException

next

void next()
    throws IOException
Advances to the next document in the index

Throws:
IOException

close

void close()
     throws IOException
Clean up

Throws:
IOException

readDocKey

private void readDocKey()
Fetch the current document key; update done