org.galagosearch.core.index
Class IndexReader.Iterator

java.lang.Object
  org.galagosearch.core.index.IndexReader.Iterator

Enclosing class:

IndexReader

public class IndexReader.Iterator
extends java.lang.Object

Method Summary

long	getDataEnd()
long	getDataStart()
long	getFilePosition() Returns the byte offset of the end of this block.
java.lang.String	getKey() Returns the key associated with the current inverted list.
long	getValueEnd() Returns the byte offset of the end of the current inverted list, relative to the start of the whole inverted file.
long	getValueLength() Returns the length of the value, in bytes.
long	getValueStart() Returns the byte offset of the beginning of the current inverted list, relative to the start of the whole inverted file.
org.galagosearch.tupleflow.DataStream	getValueStream() Returns the value as a buffered stream.
java.lang.String	getValueString() Returns the value as a string.
boolean	isDone() Returns true if no more keys remain to be read.
boolean	nextKey() Advances to the next key in the index.
void	skipTo(byte[] key)

Methods inherited from class java.lang.Object

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

Method Detail

skipTo

public void skipTo(byte[] key)
            throws java.io.IOException

Throws:

java.io.IOException

isDone

public boolean isDone()

Returns true if no more keys remain to be read.

getFilePosition

public long getFilePosition()

Returns the byte offset of the end of this block.

getKey

public java.lang.String getKey()

Returns the key associated with the current inverted list.

getValueStream

public org.galagosearch.tupleflow.DataStream getValueStream()
                                                     throws java.io.IOException

Returns the value as a buffered stream.

Throws:

java.io.IOException

getValueLength

public long getValueLength()
                    throws java.io.IOException

Returns the length of the value, in bytes.

Throws:

java.io.IOException

getValueString

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

Returns the value as a string.

Throws:

java.io.IOException

getValueStart

public long getValueStart()

Returns the byte offset of the beginning of the current inverted list, relative to the start of the whole inverted file.

getDataStart

public long getDataStart()

getDataEnd

public long getDataEnd()

getValueEnd

public long getValueEnd()

Returns the byte offset of the end of the current inverted list, relative to the start of the whole inverted file.

nextKey

public boolean nextKey()
                throws java.io.IOException

Advances to the next key in the index.

Returns:

true if the advance was successful, false if no more keys remain.

Throws:

java.io.IOException