Class CfCqSliceSeekingFilter
- java.lang.Object
-
- org.apache.accumulo.core.iterators.WrappingIterator
-
- org.apache.accumulo.core.iterators.user.SeekingFilter
-
- org.apache.accumulo.core.iterators.user.CfCqSliceSeekingFilter
-
- All Implemented Interfaces:
OptionDescriber
,SortedKeyValueIterator<Key,Value>
,YieldingKeyValueIterator<Key,Value>
public class CfCqSliceSeekingFilter extends SeekingFilter implements OptionDescriber
Filters key/value pairs for a range of column families and a range of column qualifiers. Only keys which fall in both ranges will be passed by the filter. Note that if you have a small, well-defined set of column families it will be much more efficient to configure locality groups to isolate that data instead of configuring this iterator to seek over it. This filter may be more efficient than the CfCqSliceFilter or the ColumnSlice filter for small slices of large rows as it will seek to the next potential match once it determines that it has iterated past the end of a slice.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.accumulo.core.iterators.user.SeekingFilter
SeekingFilter.AdvanceResult, SeekingFilter.FilterResult
-
Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber
OptionDescriber.IteratorOptions
-
-
Field Summary
-
Fields inherited from class org.apache.accumulo.core.iterators.user.SeekingFilter
NEGATE
-
-
Constructor Summary
Constructors Constructor Description CfCqSliceSeekingFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SortedKeyValueIterator<Key,Value>
deepCopy(IteratorEnvironment env)
Creates a deep copy of this iterator as though seek had not yet been called.OptionDescriber.IteratorOptions
describeOptions()
Gets an iterator options object that contains information needed to configure this iterator.SeekingFilter.FilterResult
filter(Key k, Value v)
Subclasses must provide an implementation which examines the given key and value and determines (1) whether to accept the KV pair and (2) how far to advance the source iterator past the key.Key
getNextKeyHint(Key k, Value v)
Whenever the subclass returns AdvanceResult.USE_HINT from its filter predicate, this method will be called to see how far to advance the source iterator.void
init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env)
Initializes the iterator.boolean
validateOptions(Map<String,String> options)
Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.-
Methods inherited from class org.apache.accumulo.core.iterators.user.SeekingFilter
findTop, hasTop, next, seek
-
Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator
getSource, getTopKey, getTopValue, setSource
-
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.iterators.YieldingKeyValueIterator
enableYielding
-
-
-
-
Method Detail
-
init
public void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) throws IOException
Description copied from interface:SortedKeyValueIterator
Initializes the iterator. Data should not be read from the source in this method.- Specified by:
init
in interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
init
in classSeekingFilter
- Parameters:
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.- Throws:
IOException
- unused.
-
filter
public SeekingFilter.FilterResult filter(Key k, Value v)
Description copied from class:SeekingFilter
Subclasses must provide an implementation which examines the given key and value and determines (1) whether to accept the KV pair and (2) how far to advance the source iterator past the key.- Specified by:
filter
in classSeekingFilter
- Parameters:
k
- a keyv
- a value- Returns:
- indicating whether to pass or block the key, and how far the source iterator should be advanced.
-
getNextKeyHint
public Key getNextKeyHint(Key k, Value v) throws IllegalArgumentException
Description copied from class:SeekingFilter
Whenever the subclass returns AdvanceResult.USE_HINT from its filter predicate, this method will be called to see how far to advance the source iterator. The return value must be a key which is greater than (sorts after) the input key. If the subclass never returns USE_HINT, this method will never be called and may safely return null.- Specified by:
getNextKeyHint
in classSeekingFilter
- Parameters:
k
- a keyv
- a value- Returns:
- as above
- Throws:
IllegalArgumentException
-
deepCopy
public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
Description copied from interface:SortedKeyValueIterator
Creates a deep copy of this iterator as though seek had not yet been called. init should be called on an iterator before deepCopy is called. init should not need to be called on the copy that is returned by deepCopy; that is, when necessary init should be called in the deepCopy method on the iterator it returns. The behavior is unspecified if init is called after deepCopy either on the original or the copy. A proper implementation would call deepCopy on the source.- Specified by:
deepCopy
in interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
deepCopy
in classSeekingFilter
- Parameters:
env
-IteratorEnvironment
environment in which iterator is being run.- Returns:
SortedKeyValueIterator
a copy of this iterator (with the same source and settings).
-
describeOptions
public OptionDescriber.IteratorOptions describeOptions()
Description copied from interface:OptionDescriber
Gets an iterator options object that contains information needed to configure this iterator. This object will be used by the accumulo shell to prompt the user to input the appropriate information.- Specified by:
describeOptions
in interfaceOptionDescriber
- Returns:
- an iterator options object
-
validateOptions
public boolean validateOptions(Map<String,String> options)
Description copied from interface:OptionDescriber
Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.- Specified by:
validateOptions
in interfaceOptionDescriber
- Parameters:
options
- a map of option names to option values- Returns:
- true if options are valid, false otherwise (IllegalArgumentException preferred)
-
-