org.apache.hadoop.hbase.client

Class BatchScanResultCache

java.lang.Object

org.apache.hadoop.hbase.client.ScanResultCache

org.apache.hadoop.hbase.client.BatchScanResultCache

@InterfaceAudience.Private
public class BatchScanResultCache
extends ScanResultCache

A scan result cache for batched scan, i.e, scan.getBatch() > 0 && !scan.getAllowPartialResults().

If user setBatch(5) and rpc returns 3+5+5+5+3 cells, we should return 5+5+5+5+1 to user. setBatch doesn't mean setAllowPartialResult(true).

Constructor Summary

Constructors

Constructor and Description
BatchScanResultCache(List<Result> cache, int batch)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkUpdateNumberOfCompleteRowsAndCache(Result rs) Check and update number of complete rows and add result to cache
void	clear() Clear the cached result if any.
void	loadResultsToCache(Result[] results, boolean isHeartbeatMessage) Process the results from the server and load it to cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchScanResultCache

public BatchScanResultCache(List<Result> cache,
                    int batch)

Method Detail

loadResultsToCache

public void loadResultsToCache(Result[] results,
                      boolean isHeartbeatMessage)
                        throws IOException

Description copied from class: ScanResultCache

Process the results from the server and load it to cache.

Parameters:

results - the results of a scan next. Must not be null.

isHeartbeatMessage - indicate whether the results is gotten from a heartbeat response.

Throws:

IOException

checkUpdateNumberOfCompleteRowsAndCache

protected void checkUpdateNumberOfCompleteRowsAndCache(Result rs)

Description copied from class: ScanResultCache

Check and update number of complete rows and add result to cache

Parameters:

rs - Result to cache from Results array or constructed from partial results

clear

public void clear()

Description copied from class: ScanResultCache

Clear the cached result if any. Called when scan error and we will start from a start of a row again.