org.apache.accumulo.core.iterators
Class RegExIterator

java.lang.Object
  extended by org.apache.accumulo.core.iterators.WrappingIterator
      extended by org.apache.accumulo.core.iterators.SkippingIterator
          extended by org.apache.accumulo.core.iterators.RegExIterator
All Implemented Interfaces:
OptionDescriber, SortedKeyValueIterator<Key,Value>

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()
           
 
Method Summary
protected  void consume()
           
 RegExIterator deepCopy(IteratorEnvironment env)
          Creates a deep copy of this iterator as though seek had not yet been called.
 OptionDescriber.IteratorOptions describeOptions()
           
 void init(SortedKeyValueIterator<Key,Value> source, java.util.Map<java.lang.String,java.lang.String> options, IteratorEnvironment env)
          Initializes the iterator.
 boolean validateOptions(java.util.Map<java.lang.String,java.lang.String> options)
           
 
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()
Method Detail

deepCopy

public RegExIterator 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>
Specified by:
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 java.io.IOException
Specified by:
consume in class SkippingIterator
Throws:
java.io.IOException

init

public void init(SortedKeyValueIterator<Key,Value> source,
                 java.util.Map<java.lang.String,java.lang.String> options,
                 IteratorEnvironment env)
          throws java.io.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:
java.io.IOException - unused.

describeOptions

public OptionDescriber.IteratorOptions describeOptions()
Specified by:
describeOptions in interface OptionDescriber

validateOptions

public boolean validateOptions(java.util.Map<java.lang.String,java.lang.String> options)
Specified by:
validateOptions in interface OptionDescriber


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.