org.apache.hadoop.hbase.client

Class BatchScanResultCache

java.lang.Object

org.apache.hadoop.hbase.client.BatchScanResultCache

@InterfaceAudience.Private
public class BatchScanResultCache
extends Object

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).

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static Result[]	EMPTY_RESULT_ARRAY

Constructor Summary

Constructors

Constructor and Description
BatchScanResultCache(int batch)

Method Summary

Modifier and Type	Method and Description
Result[]	addAndGet(Result[] results, boolean isHeartbeatMessage) Add the given results to cache and get valid results back.
void	clear() Clear the cached result if any.
int	numberOfCompleteRows() Return the number of complete rows.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_RESULT_ARRAY

public static final Result[] EMPTY_RESULT_ARRAY

Constructor Detail

BatchScanResultCache

public BatchScanResultCache(int batch)

Method Detail

addAndGet

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

Add the given results to cache and get valid results back.

Parameters:

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

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

Returns:

valid results, never null.

Throws:

IOException

clear

public void clear()

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

numberOfCompleteRows

public int numberOfCompleteRows()

Return the number of complete rows. Used to implement limited scan.