org.apache.hadoop.hbase.client

Class BatchScanResultCache

java.lang.Object

org.apache.hadoop.hbase.client.BatchScanResultCache

All Implemented Interfaces:

ScanResultCache

@InterfaceAudience.Private
public class BatchScanResultCache
extends Object
implements 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).

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
private int	batch
private Cell	lastCell
private boolean	lastResultPartial
private int	numberOfCompleteRows
private int	numCellsOfPartialResults
private Deque<Result>	partialResults

Fields inherited from interface org.apache.hadoop.hbase.client.ScanResultCache

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.
private Result	createCompletedResult()
int	numberOfCompleteRows() Return the number of complete rows.
private void	recordLastResult(Result result)
private Result	regroupResults(Result result)

Methods inherited from class java.lang.Object

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

Field Detail

batch

private final int batch

lastCell

private Cell lastCell

lastResultPartial

private boolean lastResultPartial

partialResults

private final Deque<Result> partialResults

numCellsOfPartialResults

private int numCellsOfPartialResults

numberOfCompleteRows

private int numberOfCompleteRows

Constructor Detail

BatchScanResultCache

public BatchScanResultCache(int batch)

Method Detail

recordLastResult

private void recordLastResult(Result result)

createCompletedResult

private Result createCompletedResult()
                              throws IOException

Throws:

IOException

regroupResults

private Result regroupResults(Result result)

addAndGet

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

Description copied from interface: ScanResultCache

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

Specified by:

addAndGet in interface ScanResultCache

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

Description copied from interface: ScanResultCache

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

Specified by:

clear in interface ScanResultCache

numberOfCompleteRows

public int numberOfCompleteRows()

Description copied from interface: ScanResultCache

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

Specified by:

numberOfCompleteRows in interface ScanResultCache