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

Class RegExFilter

java.lang.Object
org.apache.accumulo.core.iterators.WrappingIterator
org.apache.accumulo.core.iterators.Filter
org.apache.accumulo.core.iterators.user.RegExFilter
All Implemented Interfaces:
OptionDescriber, SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>
public class RegExFilter extends Filter
A Filter that matches entries based on Java regular expressions.

  • Field Details

  • Constructor Details

    • RegExFilter

      public RegExFilter()

  • Method Details

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

    • accept

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

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

    • describeOptions

      public OptionDescriber.IteratorOptions describeOptions()
      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
      Overrides:
      describeOptions in class Filter
      Returns:
      an iterator options object

    • validateOptions

      public boolean validateOptions(Map<String,String> options)
      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
      Overrides:
      validateOptions in class Filter
      Parameters:
      options - a map of option names to option values
      Returns:
      true if options are valid, false otherwise (IllegalArgumentException preferred)

    • setRegexs

      public static void setRegexs(IteratorSetting si, String rowTerm, String cfTerm, String cqTerm, String valueTerm, boolean orFields)
      Encode the terms to match against in the iterator. Same as calling setRegexs(IteratorSetting, String, String, String, String, boolean, boolean) with matchSubstring set to false
      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

    • setRegexs

      public static void setRegexs(IteratorSetting si, String rowTerm, String cfTerm, String cqTerm, String valueTerm, boolean orFields, boolean matchSubstring)
      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.
      matchSubstring - if true then search expressions will match on partial strings

    • setEncoding

      public static void setEncoding(IteratorSetting si, String encoding)
      Set the encoding string to use when interpreting characters
      Parameters:
      si - ScanIterator config to be updated
      encoding - the encoding string to use for character interpretation.