org.apache.accumulo.core.iterators.user
Class GrepIterator

java.lang.Object
  org.apache.accumulo.core.iterators.WrappingIterator
      org.apache.accumulo.core.iterators.SkippingIterator
          org.apache.accumulo.core.iterators.user.GrepIterator

All Implemented Interfaces:

SortedKeyValueIterator<Key,Value>

Direct Known Subclasses:

GrepIterator

public class GrepIterator
extends SkippingIterator

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.

Constructor Summary

GrepIterator()

Method Summary

protected void	consume()
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.SkippingIterator

next, seek

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

GrepIterator

public GrepIterator()

Method Detail

consume

protected void consume()
                throws IOException

Specified by:

consume in class SkippingIterator

Throws:

IOException

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.

Specified by:

deepCopy in interface SortedKeyValueIterator<Key,Value>

Overrides:

deepCopy in class WrappingIterator

Parameters:

env - IteratorEnvironment environment in which iterator is being run.

Returns:

SortedKeyValueIterator a copy of this iterator (with the same source and settings).

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 interface SortedKeyValueIterator<Key,Value>

Overrides:

init in class WrappingIterator

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.

setTerm

public static void setTerm(IteratorSetting cfg,
                           String term)

Encode the grep term as an option for a ScanIterator

Parameters:

cfg -

term -