org.apache.hadoop.hbase
Interface HScannerInterface

All Superinterfaces:
Closeable, Iterable<Map.Entry<HStoreKey,SortedMap<Text,byte[]>>>
All Known Subinterfaces:
HInternalScannerInterface
All Known Implementing Classes:
HAbstractScanner, HTable.ClientScanner

public interface HScannerInterface
extends Closeable, Iterable<Map.Entry<HStoreKey,SortedMap<Text,byte[]>>>

HScannerInterface iterates through a set of rows. It's implemented by several classes. Implements Iterable but be sure to still call close() when done with your Iterator


Method Summary
 void close()
          Closes a scanner and releases any resources it has allocated
 boolean next(HStoreKey key, SortedMap<Text,byte[]> results)
          Grab the next row's worth of values.
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

next

boolean next(HStoreKey key,
             SortedMap<Text,byte[]> results)
             throws IOException
Grab the next row's worth of values. The scanner will return the most recent data value for each row that is not newer than the target time passed when the scanner was created.

Parameters:
key - will contain the row and timestamp upon return
results - will contain an entry for each column family member and its value
Returns:
true if data was returned
Throws:
IOException

close

void close()
           throws IOException
Closes a scanner and releases any resources it has allocated

Specified by:
close in interface Closeable
Throws:
IOException


Copyright © 2006 The Apache Software Foundation