org.apache.accumulo.core.client.impl
Class ScannerImpl

java.lang.Object
  org.apache.accumulo.core.client.impl.ScannerOptions
      org.apache.accumulo.core.client.impl.ScannerImpl

All Implemented Interfaces:

Iterable<Map.Entry<Key,Value>>, Scanner, ScannerBase

public class ScannerImpl
extends ScannerOptions
implements Scanner

Field Summary

Fields inherited from class org.apache.accumulo.core.client.impl.ScannerOptions

fetchedColumns, serverSideIteratorList, serverSideIteratorOptions

Constructor Summary

ScannerImpl(Instance instance, AuthInfo credentials, String table, Authorizations authorizations)

Method Summary

void	disableIsolation() Disables row isolation.
void	enableIsolation() Enables row isolation.
int	getBatchSize() Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet server.
Range	getRange() Returns the range of keys to scan over.
int	getTimeOut() Returns the setting for how long a scanner will automatically retry when a failure occurs.
Iterator<Map.Entry<Key,Value>>	iterator() Returns an iterator over an accumulo table.
void	setBatchSize(int size) Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.
void	setRange(Range range) Sets the range of keys to scan over.
void	setTimeOut(int timeOut) When failure occurs, the scanner automatically retries.

Methods inherited from class org.apache.accumulo.core.client.impl.ScannerOptions

addScanIterator, clearColumns, clearScanIterators, fetchColumn, fetchColumn, fetchColumnFamily, getFetchedColumns, removeScanIterator, setColumnFamilyRegex, setColumnQualifierRegex, setOptions, setRowRegex, setScanIteratorOption, setScanIterators, setupRegex, setValueRegex, updateScanIteratorOption

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.accumulo.core.client.ScannerBase

addScanIterator, clearColumns, clearScanIterators, fetchColumn, fetchColumnFamily, removeScanIterator, setColumnFamilyRegex, setColumnQualifierRegex, setRowRegex, setScanIteratorOption, setScanIterators, setupRegex, setValueRegex, updateScanIteratorOption

Constructor Detail

ScannerImpl

public ScannerImpl(Instance instance,
                   AuthInfo credentials,
                   String table,
                   Authorizations authorizations)

Method Detail

setTimeOut

public void setTimeOut(int timeOut)

When failure occurs, the scanner automatically retries. This setting determines how long a scanner will retry. By default a scanner will retry forever.

Specified by:

setTimeOut in interface Scanner

Parameters:

timeOut - in milliseconds

getTimeOut

public int getTimeOut()

Description copied from interface: Scanner

Returns the setting for how long a scanner will automatically retry when a failure occurs.

Specified by:

getTimeOut in interface Scanner

Returns:

the timeout configured for this scanner

setRange

public void setRange(Range range)

Description copied from interface: Scanner

Sets the range of keys to scan over.

Specified by:

setRange in interface Scanner

Parameters:

range - key range to begin and end scan

getRange

public Range getRange()

Description copied from interface: Scanner

Returns the range of keys to scan over.

Specified by:

getRange in interface Scanner

Returns:

the range configured for this scanner

setBatchSize

public void setBatchSize(int size)

Description copied from interface: Scanner

Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.

Specified by:

setBatchSize in interface Scanner

Parameters:

size - the number of Key/Value pairs to fetch per call to Accumulo

getBatchSize

public int getBatchSize()

Description copied from interface: Scanner

Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet server.

Specified by:

getBatchSize in interface Scanner

Returns:

the batch size configured for this scanner

iterator

public Iterator<Map.Entry<Key,Value>> iterator()

Returns an iterator over an accumulo table. This iterator uses the options that are currently set on the scanner for its lifetime. So setting options on a Scanner object will have no effect on existing iterators.

Specified by:

iterator in interface Iterable<Map.Entry<Key,Value>>

Specified by:

iterator in interface ScannerBase

Overrides:

iterator in class ScannerOptions

Returns:

an iterator over Key,Value pairs which meet the restrictions set on the scanner

enableIsolation

public void enableIsolation()

Description copied from interface: Scanner

Enables row isolation. Writes that occur to a row after a scan of that row has begun will not be seen if this option is enabled.

Specified by:

enableIsolation in interface Scanner

disableIsolation

public void disableIsolation()

Description copied from interface: Scanner

Disables row isolation. Writes that occur to a row after a scan of that row has begun may be seen if this option is enabled.

Specified by:

disableIsolation in interface Scanner