public interface ScannerBase extends Iterable<Map.Entry<Key,Value>>
Modifier and Type | Method and Description |
---|---|
void |
addScanIterator(IteratorSetting cfg)
Add a server-side scan iterator.
|
void |
clearColumns()
Clears the columns to be fetched (useful for resetting the scanner for reuse).
|
void |
clearScanIterators()
Clears scan iterators prior to returning a scanner to the pool.
|
void |
fetchColumn(org.apache.hadoop.io.Text colFam,
org.apache.hadoop.io.Text colQual)
Adds a column to the list of columns that will be fetched by this scanner.
|
void |
fetchColumnFamily(org.apache.hadoop.io.Text col)
Adds a column family to the list of columns that will be fetched by this scanner.
|
Iterator<Map.Entry<Key,Value>> |
iterator()
Returns an iterator over an accumulo table.
|
void |
removeScanIterator(String iteratorName)
Remove an iterator from the list of iterators.
|
void |
setColumnFamilyRegex(String regex)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) and
RegExFilter |
void |
setColumnQualifierRegex(String regex)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) and
RegExFilter |
void |
setRowRegex(String regex)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) and
RegExFilter
// Use the more flexible addScanIterator method: ScanIterator cfg = new ScanIterator("regex", RegexIterator.class); RegexIterator.setRegexs(cfg, row, null, null, null, false); scanner.addScanIterator(priority, cfg); |
void |
setScanIteratorOption(String iteratorName,
String key,
String value)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) . |
void |
setScanIterators(int priority,
String iteratorClass,
String iteratorName)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) . |
void |
setupRegex(String iteratorName,
int iteratorPriority)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) and
RegExFilter |
void |
setValueRegex(String regex)
Deprecated.
Since 1.4, use
addScanIterator(org.apache.accumulo.core.client.IteratorSetting) and
RegExFilter |
void |
updateScanIteratorOption(String iteratorName,
String key,
String value)
Update the options for an iterator.
|
void addScanIterator(IteratorSetting cfg)
cfg
- fully specified scan-time iterator, including all options for the iterator. Any changes to the iterator setting after this call are not propagated
to the stored iterator.IllegalArgumentException
- if the setting conflicts with existing iteratorsvoid removeScanIterator(String iteratorName)
iteratorName
- nickname used for the iteratorvoid updateScanIteratorOption(String iteratorName, String key, String value)
iteratorName
- the name of the iterator to changekey
- the name of the optionvalue
- the new value for the named optionvoid setScanIterators(int priority, String iteratorClass, String iteratorName) throws IOException
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
.IOException
void setScanIteratorOption(String iteratorName, String key, String value)
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
.void setupRegex(String iteratorName, int iteratorPriority) throws IOException
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
and
RegExFilter
iteratorName
- a nickname for the iteratoriteratorPriority
- determines the order in which iterators are applied (system iterators are always applied first, then per-table and scan-time, lowest first)IOException
- if an exception occurs reading from the iterator stackvoid setRowRegex(String regex)
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
and
RegExFilter
// Use the more flexible addScanIterator method: ScanIterator cfg = new ScanIterator("regex", RegexIterator.class); RegexIterator.setRegexs(cfg, row, null, null, null, false); scanner.addScanIterator(priority, cfg);
regex
- java regular expression to matchvoid setColumnFamilyRegex(String regex)
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
and
RegExFilter
regex
- java regular expression to matchvoid setColumnQualifierRegex(String regex)
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
and
RegExFilter
regex
- java regular expression to matchvoid setValueRegex(String regex)
addScanIterator(org.apache.accumulo.core.client.IteratorSetting)
and
RegExFilter
regex
- java regular expression to matchvoid fetchColumnFamily(org.apache.hadoop.io.Text col)
col
- the column family to be fetchedvoid fetchColumn(org.apache.hadoop.io.Text colFam, org.apache.hadoop.io.Text colQual)
colFam
- the column family of the column to be fetchedcolQual
- the column qualifier of the column to be fetchedvoid clearColumns()
void clearScanIterators()
Iterator<Map.Entry<Key,Value>> iterator()
Copyright © 2012 The Apache Software Foundation. All Rights Reserved.