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

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

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>

public class ColumnAgeOffFilter
extends Filter

A filter that ages off key/value pairs based on the Key's column and timestamp. It removes an entry if its timestamp is less than currentTime - threshold. Different thresholds are set for each column.

Nested Class Summary

static class

ColumnAgeOffFilter.TTLSet

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

OptionDescriber.IteratorOptions

Constructor Summary

ColumnAgeOffFilter()

Method Summary

boolean	accept(Key k, Value v)
static void	addTTL(IteratorSetting is, IteratorSetting.Column column, Long ttl) A convenience method for adding or changing an age off threshold for a column.
SortedKeyValueIterator<Key,Value>	deepCopy(IteratorEnvironment env) Creates a deep copy of this iterator as though seek had not yet been called.
OptionDescriber.IteratorOptions	describeOptions() 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) Initializes the iterator.
void	overrideCurrentTime(long ts)
static void	removeTTL(IteratorSetting is, IteratorSetting.Column column) A convenience method for removing an age off threshold for a column.
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.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

ColumnAgeOffFilter

public ColumnAgeOffFilter()

Method Detail

accept

public boolean accept(Key k,
                      Value v)

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.

Throws:

IOException - unused.

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.

Specified by:

deepCopy in interface SortedKeyValueIterator<Key,Value>

Overrides:

deepCopy in class Filter

Parameters:

env - IteratorEnvironment environment in which iterator is being run.

Returns:

SortedKeyValueIterator a copy of this iterator (with the same source and settings).

overrideCurrentTime

public void overrideCurrentTime(long ts)

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

addTTL

public static void addTTL(IteratorSetting is,
                          IteratorSetting.Column column,
                          Long ttl)

A convenience method for adding or changing an age off threshold for a column.

Parameters:

is - IteratorSetting object to configure.

column - column to encode as a parameter name.

ttl - age off threshold in milliseconds.

removeTTL

public static void removeTTL(IteratorSetting is,
                             IteratorSetting.Column column)

A convenience method for removing an age off threshold for a column.

Parameters:

is - IteratorSetting object to configure.

column - column to encode as a parameter name.