org.apache.accumulo.core.iterators
Class RegExIterator

java.lang.Object
  org.apache.accumulo.core.iterators.WrappingIterator
      org.apache.accumulo.core.iterators.SkippingIterator
          org.apache.accumulo.core.iterators.RegExIterator

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>

Deprecated. since 1.4, replaced by RegExFilter

public class RegExIterator
extends SkippingIterator
implements OptionDescriber

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber

OptionDescriber.IteratorOptions

Constructor Summary

RegExIterator()
Deprecated.

Method Summary

protected void	consume() Deprecated.
RegExIterator	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.
static void	setRegexs(IteratorSetting si, String rowTerm, String cfTerm, String cqTerm, String valueTerm, boolean orFields) Deprecated. Encode the terms to match against in the iterator
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.

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

RegExIterator

public RegExIterator()

Deprecated.

Method Detail

deepCopy

public RegExIterator deepCopy(IteratorEnvironment env)

Deprecated.

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

consume

protected void consume()
                throws IOException

Deprecated.

Specified by:

consume in class SkippingIterator

Throws:

IOException

init

public void init(SortedKeyValueIterator<Key,Value> source,
                 Map<String,String> options,
                 IteratorEnvironment env)
          throws IOException

Deprecated.

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.

describeOptions

public OptionDescriber.IteratorOptions describeOptions()

Deprecated.

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 interface OptionDescriber

Returns:

an iterator options object

validateOptions

public boolean validateOptions(Map<String,String> options)

Deprecated.

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 interface OptionDescriber

Parameters:

options - a map of option names to option values

Returns:

true if options are valid, false otherwise

setRegexs

public static void setRegexs(IteratorSetting si,
                             String rowTerm,
                             String cfTerm,
                             String cqTerm,
                             String valueTerm,
                             boolean orFields)

Deprecated.

Encode the terms to match against in the iterator

Parameters:

si - ScanIterator config to be updated

rowTerm - the pattern to match against the Key's row. Not used if null.

cfTerm - the pattern to match against the Key's column family. Not used if null.

cqTerm - the pattern to match against the Key's column qualifier. Not used if null.

valueTerm - the pattern to match against the Key's value. Not used if null.

orFields - if true, any of the non-null terms can match to return the entry