org.apache.accumulo.server.util
Class OfflineMetadataScanner

java.lang.Object
  extended by org.apache.accumulo.core.client.impl.ScannerOptions
      extended by org.apache.accumulo.server.util.OfflineMetadataScanner
All Implemented Interfaces:
java.lang.Iterable<java.util.Map.Entry<Key,Value>>, Scanner, ScannerBase

public class OfflineMetadataScanner
extends ScannerOptions
implements Scanner


Constructor Summary
OfflineMetadataScanner()
           
 
Method Summary
 void disableIsolation()
           
 void enableIsolation()
           
 int getBatchSize()
           
 Range getRange()
           
 int getTimeOut()
           
 java.util.Iterator<java.util.Map.Entry<Key,Value>> iterator()
          Returns an iterator over an accumulo table.
static void main(java.lang.String[] args)
           
 void setBatchSize(int size)
           
 void setRange(Range range)
           
 void setScanIterators(int priority, java.lang.String iteratorClass, java.lang.String iteratorName)
          Sets server side scan iterators.
 void setTimeOut(int timeOut)
          When failure occurs, the scanner automatically retries.
 
Methods inherited from class org.apache.accumulo.core.client.impl.ScannerOptions
clearColumns, clearScanIterators, fetchColumn, fetchColumn, fetchColumnFamily, getFetchedColumns, setColumnFamilyRegex, setColumnQualifierRegex, setOptions, setRowRegex, setScanIteratorOption, setupRegex, setValueRegex
 
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
clearColumns, clearScanIterators, fetchColumn, fetchColumnFamily, setColumnFamilyRegex, setColumnQualifierRegex, setRowRegex, setScanIteratorOption, setupRegex, setValueRegex
 

Constructor Detail

OfflineMetadataScanner

public OfflineMetadataScanner()
                       throws java.io.IOException
Throws:
java.io.IOException
Method Detail

getBatchSize

public int getBatchSize()
Specified by:
getBatchSize in interface Scanner
Returns:
the batch size configured for this scanner

getRange

public Range getRange()
Specified by:
getRange in interface Scanner
Returns:
the range configured for this scanner

getTimeOut

public int getTimeOut()
Specified by:
getTimeOut in interface Scanner
Returns:
the timeout configured for this scanner

iterator

public java.util.Iterator<java.util.Map.Entry<Key,Value>> iterator()
Description copied from interface: Scanner
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. Keys are returned in sorted order by the iterator.

Specified by:
iterator in interface java.lang.Iterable<java.util.Map.Entry<Key,Value>>
Specified by:
iterator in interface Scanner

setBatchSize

public void setBatchSize(int size)
Specified by:
setBatchSize in interface Scanner
Parameters:
size - the number of Keys/Value pairs to fetch per call to Accumulo

setRange

public void setRange(Range range)
Specified by:
setRange in interface Scanner
Parameters:
range - key range to begin and end scan

setTimeOut

public void setTimeOut(int timeOut)
Description copied from interface: Scanner
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 seconds

setScanIterators

public void setScanIterators(int priority,
                             java.lang.String iteratorClass,
                             java.lang.String iteratorName)
Description copied from class: ScannerOptions
Sets server side scan iterators.

Specified by:
setScanIterators in interface ScannerBase
Overrides:
setScanIterators in class ScannerOptions
Parameters:
priority - determines the order in which iterators are applied (system iterators are always applied first, then per-table and scan-time, lowest first)
iteratorClass - the fully qualified class name of the iterator to be applied at scan time
iteratorName - a nickname for the iterator

enableIsolation

public void enableIsolation()
Specified by:
enableIsolation in interface Scanner

disableIsolation

public void disableIsolation()
Specified by:
disableIsolation in interface Scanner

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException
Throws:
java.io.IOException


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.