org.apache.accumulo.core.iterators.user
Class VisibilityFilter

java.lang.Object
  org.apache.accumulo.core.iterators.WrappingIterator
      org.apache.accumulo.core.iterators.Filter
          org.apache.accumulo.core.iterators.system.VisibilityFilter
              org.apache.accumulo.core.iterators.user.VisibilityFilter

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>

public class VisibilityFilter
extends VisibilityFilter
implements OptionDescriber

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.system.VisibilityFilter

cache, defaultVisibility, tmpVis, ve

Fields inherited from class org.apache.accumulo.core.iterators.Filter

NEGATE

Constructor Summary

VisibilityFilter()

Method Summary

boolean	accept(Key k, Value v)
OptionDescriber.IteratorOptions	describeOptions() Gets an iterator options object that contains information needed to configure this iterator.
static void	filterInvalidLabelsOnly(IteratorSetting setting, boolean featureEnabled)
void	init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) Initializes the iterator.
static void	setAuthorizations(IteratorSetting setting, Authorizations auths)
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.

Methods inherited from class org.apache.accumulo.core.iterators.system.VisibilityFilter

deepCopy

Methods inherited from class org.apache.accumulo.core.iterators.Filter

findTop, next, seek, setNegate

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

VisibilityFilter

public VisibilityFilter()

Method Detail

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.

Throws:

IOException - unused.

accept

public boolean accept(Key k,
                      Value v)

Overrides:

accept in class VisibilityFilter

Returns:

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

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)

setAuthorizations

public static void setAuthorizations(IteratorSetting setting,
                                     Authorizations auths)

filterInvalidLabelsOnly

public static void filterInvalidLabelsOnly(IteratorSetting setting,
                                           boolean featureEnabled)