org.galagosearch.core.index
Class PositionIndexReader.Iterator

java.lang.Object
  org.galagosearch.core.retrieval.structured.CountIterator
      org.galagosearch.core.retrieval.structured.ExtentIterator
          org.galagosearch.core.index.PositionIndexReader.Iterator

All Implemented Interfaces:

java.lang.Comparable<CountIterator>, IndexIterator, StructuredIterator

Enclosing class:

PositionIndexReader

public class PositionIndexReader.Iterator
extends ExtentIterator
implements IndexIterator

Method Summary

int	count() Returns the number of occurrences of this iterator's term in the current document.
int	document() Returns the current document.
ExtentArray	extents()
long	getByteLength()
java.lang.String	getCurrentTerm()
java.lang.String	getRecordString()
boolean	isDone() Returns true if there is no data left in the list and false otherwise.
void	nextDocument() Moves the iterator to the next document in the list.
boolean	nextRecord()
void	reset() Resets the position of this iterator to the start of the list.

Methods inherited from class org.galagosearch.core.retrieval.structured.ExtentIterator

skipToDocument

Methods inherited from class org.galagosearch.core.retrieval.structured.CountIterator

compareTo

Methods inherited from class java.lang.Object

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

Method Detail

getRecordString

public java.lang.String getRecordString()

Specified by:

getRecordString in interface IndexIterator

reset

public void reset()
           throws java.io.IOException

Description copied from class: CountIterator

Resets the position of this iterator to the start of the list.

Specified by:

reset in interface StructuredIterator

Specified by:

reset in class ExtentIterator

Throws:

java.io.IOException

getByteLength

public long getByteLength()
                   throws java.io.IOException

Throws:

java.io.IOException

getCurrentTerm

public java.lang.String getCurrentTerm()
                                throws java.io.IOException

Throws:

java.io.IOException

nextDocument

public void nextDocument()
                  throws java.io.IOException

Description copied from class: CountIterator

Moves the iterator to the next document in the list. If no such document is available, isDone() will return true after this method is called.

Specified by:

nextDocument in class ExtentIterator

Throws:

java.io.IOException

nextRecord

public boolean nextRecord()
                   throws java.io.IOException

Specified by:

nextRecord in interface IndexIterator

Throws:

java.io.IOException

isDone

public boolean isDone()

Description copied from class: CountIterator

Returns true if there is no data left in the list and false otherwise. If the result of this method is true, the data returned from document() and count() is meaningless.

Specified by:

isDone in class ExtentIterator

extents

public ExtentArray extents()

Specified by:

extents in class ExtentIterator

document

public int document()

Description copied from class: CountIterator

Returns the current document.

Specified by:

document in class ExtentIterator

count

public int count()

Description copied from class: CountIterator

Returns the number of occurrences of this iterator's term in the current document.

Specified by:

count in class ExtentIterator