Package org.apache.accumulo.core.iterators

Interface OptionDescriber

All Known Implementing Classes:
AgeOffFilter, BigDecimalCombiner, BigDecimalCombiner.BigDecimalMaxCombiner, BigDecimalCombiner.BigDecimalMinCombiner, BigDecimalCombiner.BigDecimalSummingCombiner, CfCqSliceFilter, CfCqSliceSeekingFilter, ColumnAgeOffFilter, ColumnSliceFilter, Combiner, DebugIterator, Filter, FirstEntryInRowIterator, GrepIterator, LargeRowFilter, LongCombiner, MaxCombiner, MinCombiner, OrIterator, RegExFilter, ReqVisFilter, RowEncodingIterator, SortedKeyIterator, SummingArrayCombiner, SummingCombiner, TimestampFilter, TransformingIterator, TypedValueCombiner, VersioningIterator, VisibilityFilter, WholeColumnFamilyIterator, WholeRowIterator
public interface OptionDescriber
The OptionDescriber interface allows you to set up iterator properties interactively in the accumulo shell. If your iterator and/or filter must implement this interface for the interactive part. The alternative would be to manually set configuration options with the config -t tableName property=value. If you go the manual route, be careful to use the correct structure for the property and to set all the properties required for the iterator. OptionDescribers will need to implement two methods: describeOptions() which returns an instance of OptionDescriber.IteratorOptions and validateOptions(Map<String,String> options) which is intended to throw an exception or return false if the options are not acceptable.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    OptionDescriber.IteratorOptions
     

  • Method Summary

    Modifier and Type
    Method
    Description
    OptionDescriber.IteratorOptions
    describeOptions()
    Gets an iterator options object that contains information needed to configure this iterator.
    boolean
    validateOptions(Map<String,String> options)
    Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.

  • Method Details

    • describeOptions

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

    • validateOptions

      boolean validateOptions(Map<String,String> options)
      Check to see if an options map contains all options required by an iterator and that the option values are in the expected formats.
      Parameters:
      options - a map of option names to option values
      Returns:
      true if options are valid, false otherwise (IllegalArgumentException preferred)
      Throws:
      IllegalArgumentException - if there are problems with the options