org.apache.hadoop.hbase.client

Class AbstractClientScanner

java.lang.Object

org.apache.hadoop.hbase.client.AbstractClientScanner

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Result>, ResultScanner

Direct Known Subclasses:

ClientScanner, ClientSideRegionScanner, TableSnapshotScanner

@InterfaceAudience.Private
public abstract class AbstractClientScanner
extends Object
implements ResultScanner

Helper class for custom client scanners.

Field Summary

Fields

Modifier and Type	Field and Description
protected ScanMetrics	scanMetrics

Constructor Summary

Constructors

Constructor and Description
AbstractClientScanner()

Method Summary

Modifier and Type	Method and Description
ScanMetrics	getScanMetrics() Used internally accumulating metrics on scan.
protected void	initScanMetrics(Scan scan) Check and initialize if application wants to collect scan metrics

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.client.ResultScanner

close, iterator, next, next, renewLease

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

scanMetrics

protected ScanMetrics scanMetrics

Constructor Detail

AbstractClientScanner

public AbstractClientScanner()

Method Detail

initScanMetrics

protected void initScanMetrics(Scan scan)

Check and initialize if application wants to collect scan metrics

getScanMetrics

public ScanMetrics getScanMetrics()

Used internally accumulating metrics on scan. To enable collection of metrics on a Scanner, call Scan.setScanMetricsEnabled(boolean).

Specified by:

getScanMetrics in interface ResultScanner

Returns:

Returns the running ScanMetrics instance or null if scan metrics not enabled.