Package org.apache.accumulo.core.iterators.user

Class GrepIterator

java.lang.Object

org.apache.accumulo.core.iterators.WrappingIterator

org.apache.accumulo.core.iterators.Filter

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

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>

public class GrepIterator
extends Filter

This iterator provides exact string matching of the term specified by the "term" option. It searches both the Key and Value for the string, according to the specified configuration options.

The match options are:

• term (String, required)
• matchRow (boolean, default: true)
• matchColumnFamily (boolean, default: true)
• matchColumnQualifier (boolean, default: true)
• matchColumnVisibility (boolean, default: false)
• matchValue (boolean, default: true)

Nested Class Summary

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.Filter

NEGATE

Constructor Summary

Constructors

Constructor	Description
GrepIterator()

Method Summary

Modifier and Type	Method	Description
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.
protected int	indexOf(byte[] value, int offset, int length)
void	init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env)	Initializes the iterator.
protected boolean	match(byte[] ba)
protected boolean	match(ByteSequence bs)
static void	matchColumnFamily(IteratorSetting cfg, boolean match)	Enable or disable matching on the family field of the key.
static void	matchColumnQualifier(IteratorSetting cfg, boolean match)	Enable or disable matching on the qualifier field of the key.
static void	matchColumnVisibility(IteratorSetting cfg, boolean match)	Enable or disable matching on the visibility field of the key.
static void	matchRow(IteratorSetting cfg, boolean match)	Enable or disable matching on the row field of the key.
static void	matchValue(IteratorSetting cfg, boolean match)	Enable or disable matching on the value.
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

Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator

enableYielding

Constructor Details

GrepIterator

public GrepIterator()

Method Details

accept

public boolean accept(Key k,
 Value v)

Specified by:

accept in class Filter

Returns:

true if the key/value pair is accepted by the filter.

match

protected boolean match(ByteSequence bs)

match

protected boolean match(byte[] ba)

indexOf

protected int indexOf(byte[] value,
 int offset,
 int length)

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

Overrides:

deepCopy in class Filter

Parameters:

env - IteratorEnvironment environment in which iterator is being run, provided by Accumulo itself and is expected to be non-null.

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 Filter

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, provided by Accumulo itself and is expected to be non-null.

Throws:

IOException - unused.

setTerm

public static void setTerm(IteratorSetting cfg,
 String term)

Encode the grep term as an option for a ScanIterator

matchRow

public static void matchRow(IteratorSetting cfg,
 boolean match)

Enable or disable matching on the row field of the key. Defaults to enable.

Since:

2.1.3

matchColumnFamily

public static void matchColumnFamily(IteratorSetting cfg,
 boolean match)

Enable or disable matching on the family field of the key. Defaults to enable.

Since:

2.1.3

matchColumnQualifier

public static void matchColumnQualifier(IteratorSetting cfg,
 boolean match)

Enable or disable matching on the qualifier field of the key. Defaults to enable.

Since:

2.1.3

matchColumnVisibility

public static void matchColumnVisibility(IteratorSetting cfg,
 boolean match)

Enable or disable matching on the visibility field of the key. Defaults to disable.

Since:

2.1.3

matchValue

public static void matchValue(IteratorSetting cfg,
 boolean match)

Enable or disable matching on the value. Defaults to enable.

Since:

2.1.3