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

Class AgeOffFilter

java.lang.Object

org.apache.accumulo.core.iterators.WrappingIterator

org.apache.accumulo.core.iterators.Filter

org.apache.accumulo.core.iterators.user.AgeOffFilter

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>

public class AgeOffFilter
extends Filter

A filter that ages off key/value pairs based on the Key's timestamp. It removes an entry if its timestamp is less than currentTime - threshold. This filter requires a "ttl" option, in milliseconds, to determine the age off threshold.

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

NEGATE

Constructor Summary

Constructors

Constructor	Description
AgeOffFilter()

Method Summary

Modifier and Type	Method	Description
boolean	accept(Key k, Value v)	Accepts entries whose timestamps are less than currentTime - threshold.
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.
static void	setCurrentTime(IteratorSetting is, Long currentTime)	A convenience method for setting the current time (from which to measure the age off threshold).
static void	setTTL(IteratorSetting is, Long ttl)	A convenience method for setting the age off threshold.
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

Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator

enableYielding

Constructor Detail

AgeOffFilter

public AgeOffFilter()

Method Detail

accept

public boolean accept(Key k,
                      Value v)

Accepts entries whose timestamps are less than currentTime - threshold.

Specified by:

accept in class Filter

Returns:

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

See Also:

Filter.accept(org.apache.accumulo.core.data.Key, org.apache.accumulo.core.data.Value)

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.

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

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)

setTTL

public static void setTTL(IteratorSetting is,
                          Long ttl)

A convenience method for setting the age off threshold.

Parameters:

is - IteratorSetting object to configure.

ttl - age off threshold in milliseconds.

setCurrentTime

public static void setCurrentTime(IteratorSetting is,
                                  Long currentTime)

A convenience method for setting the current time (from which to measure the age off threshold).

Parameters:

is - IteratorSetting object to configure.

currentTime - time in milliseconds.