org.apache.hadoop.hbase.rest.client

Class RemoteHTable.Scanner

java.lang.Object

org.apache.hadoop.hbase.rest.client.RemoteHTable.Scanner

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Result>, ResultScanner

Enclosing class:

RemoteHTable

class RemoteHTable.Scanner
extends Object
implements ResultScanner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RemoteHTable.Scanner.Iter

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	uri

Constructor Summary

Constructors

Constructor and Description
Scanner(Scan scan)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the scanner and releases any resources it has allocated
ScanMetrics	getScanMetrics()
Iterator<Result>	iterator()
Result	next() Grab the next row's worth of values.
Result[]	next(int nbRows) Get nbRows rows.
boolean	renewLease() Allow the client to renew the scanner's lease on the server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

uri

String uri

Constructor Detail

Scanner

public Scanner(Scan scan)
        throws IOException

Throws:

IOException

Method Detail

next

public Result[] next(int nbRows)
              throws IOException

Description copied from interface: ResultScanner

Get nbRows rows. How many RPCs are made is determined by the Scan.setCaching(int) setting (or hbase.client.scanner.caching in hbase-site.xml).

Specified by:

next in interface ResultScanner

Parameters:

nbRows - number of rows to return

Returns:

Between zero and nbRows rowResults. Scan is done if returned array is of zero-length (We never return null).

Throws:

IOException

next

public Result next()
            throws IOException

Description copied from interface: ResultScanner

Grab the next row's worth of values. The scanner will return a Result.

Specified by:

next in interface ResultScanner

Returns:

Result object if there is another row, null if the scanner is exhausted.

Throws:

IOException - e

iterator

public Iterator<Result> iterator()

Specified by:

iterator in interface Iterable<Result>

Specified by:

iterator in interface ResultScanner

close

public void close()

Description copied from interface: ResultScanner

Closes the scanner and releases any resources it has allocated

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ResultScanner

renewLease

public boolean renewLease()

Description copied from interface: ResultScanner

Allow the client to renew the scanner's lease on the server.

Specified by:

renewLease in interface ResultScanner

Returns:

true if the lease was successfully renewed, false otherwise.

getScanMetrics

public ScanMetrics getScanMetrics()

Specified by:

getScanMetrics in interface ResultScanner

Returns:

the scan metrics, or null if we do not enable metrics.