Class GrepIterator

  extended by org.apache.accumulo.core.iterators.WrappingIterator
      extended by org.apache.accumulo.core.iterators.Filter
          extended by org.apache.accumulo.core.iterators.user.GrepIterator
All Implemented Interfaces:
OptionDescriber, SortedKeyValueIterator<Key,Value>
Direct Known Subclasses:

public class GrepIterator
extends Filter

This iterator provides exact string matching. It searches both the Key and Value for the string. The string to match is specified by the "term" option.

Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber
Field Summary
Fields inherited from class org.apache.accumulo.core.iterators.Filter
Constructor Summary
Method Summary
 boolean accept(Key k, Value v)
 SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
          Creates a deep copy of this iterator as though seek had not yet been called.
 void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env)
          Initializes the iterator.
static void setTerm(IteratorSetting cfg, String term)
          Encode the grep term as an option for a ScanIterator
Methods inherited from class org.apache.accumulo.core.iterators.Filter
describeOptions, findTop, next, seek, setNegate, validateOptions
Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator
getSource, getTopKey, getTopValue, hasTop, setSource
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public GrepIterator()
Method Detail


public boolean accept(Key k,
                      Value v)
Specified by:
accept in class Filter
true if the key/value pair is accepted by the filter.


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.

Specified by:
deepCopy in interface SortedKeyValueIterator<Key,Value>
deepCopy in class Filter
env - IteratorEnvironment environment in which iterator is being run.
SortedKeyValueIterator a copy of this iterator (with the same source and settings).


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 interface SortedKeyValueIterator<Key,Value>
init in class Filter
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 static void setTerm(IteratorSetting cfg,
                           String term)
Encode the grep term as an option for a ScanIterator

cfg -
term -

Copyright © 2013 Apache Accumulo Project. All Rights Reserved.