Filter
public class FilteringIterator extends WrappingIterator implements OptionDescriber
OptionDescriber.IteratorOptions
Constructor and Description |
---|
FilteringIterator()
Deprecated.
|
FilteringIterator(SortedKeyValueIterator<Key,Value> iterator,
List<? extends Filter> filters)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
FilteringIterator |
deepCopy(IteratorEnvironment env)
Deprecated.
Creates a deep copy of this iterator as though seek had not yet been called.
|
OptionDescriber.IteratorOptions |
describeOptions()
Deprecated.
Gets an iterator options object that contains information needed to configure this iterator.
|
void |
init(SortedKeyValueIterator<Key,Value> source,
Map<String,String> options,
IteratorEnvironment env)
Deprecated.
Initializes the iterator.
|
void |
next()
Deprecated.
Advances to the next K,V pair.
|
void |
seek(Range range,
Collection<ByteSequence> columnFamilies,
boolean inclusive)
Deprecated.
Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns.
|
boolean |
validateOptions(Map<String,String> options)
Deprecated.
Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.
|
getSource, getTopKey, getTopValue, hasTop, setSource
public FilteringIterator()
public FilteringIterator(SortedKeyValueIterator<Key,Value> iterator, List<? extends Filter> filters) throws IOException
IOException
public FilteringIterator deepCopy(IteratorEnvironment env)
SortedKeyValueIterator
deepCopy
in interface SortedKeyValueIterator<Key,Value>
deepCopy
in class WrappingIterator
env
- IteratorEnvironment environment in which iterator is being run.public void next() throws IOException
SortedKeyValueIterator
next
in interface SortedKeyValueIterator<Key,Value>
next
in class WrappingIterator
IOException
- if an I/O error occurs.public void seek(Range range, Collection<ByteSequence> columnFamilies, boolean inclusive) throws IOException
SortedKeyValueIterator
SortedKeyValueIterator.init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<K, V>, java.util.Map<java.lang.String, java.lang.String>, org.apache.accumulo.core.iterators.IteratorEnvironment)
is called.
Iterators that examine groups of adjacent key/value pairs (e.g. rows) to determine their top key and value should be sure that they properly handle a seek
to a key in the middle of such a group (e.g. the middle of a row). Even if the client always seeks to a range containing an entire group (a,c), the tablet
server could send back a batch of entries corresponding to (a,b], then reseek the iterator to range (b,c) when the scan is continued.seek
in interface SortedKeyValueIterator<Key,Value>
seek
in class WrappingIterator
range
- Range of keys to iterate over.columnFamilies
- Collection of column families to include or exclude.inclusive
- boolean that indicates whether to include (true) or exclude (false) column families.IOException
- if an I/O error occurs.public void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) throws IOException
SortedKeyValueIterator
init
in interface SortedKeyValueIterator<Key,Value>
init
in class WrappingIterator
source
- SortedKeyValueIterator source to read data from.options
- Map map of string option names to option values.env
- IteratorEnvironment environment in which iterator is being run.IOException
- unused.public OptionDescriber.IteratorOptions describeOptions()
OptionDescriber
describeOptions
in interface OptionDescriber
public boolean validateOptions(Map<String,String> options)
OptionDescriber
validateOptions
in interface OptionDescriber
options
- a map of option names to option valuesCopyright © 2012 The Apache Software Foundation. All Rights Reserved.