org.calrissian.accumulorecipes.commons.iterators

Class TimeLimitingFilter

java.lang.Object

org.apache.accumulo.core.iterators.WrappingIterator

org.apache.accumulo.core.iterators.Filter

org.calrissian.accumulorecipes.commons.iterators.TimeLimitingFilter

All Implemented Interfaces:

org.apache.accumulo.core.iterators.OptionDescriber, org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

public class TimeLimitingFilter
extends org.apache.accumulo.core.iterators.Filter

A small modification of the age off filter that ships with Accumulo which ages off key/value pairs based on the Key's timestamp. It removes an entry if its timestamp is less than currentTime - threshold.

The modification will now allow rows with timestamp > currentTime to pass through.

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

org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CURRENT_TIME
protected long	currentTime The use of private for this member in the original AgeOffFilter wouldn't allow me to extend it.
protected long	threshold
protected static String	TTL

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

NEGATE

Constructor Summary

Constructors

Constructor and Description
TimeLimitingFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(org.apache.accumulo.core.data.Key k, org.apache.accumulo.core.data.Value v) Accepts entries whose timestamps are less than currentTime - threshold.
org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>	deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)
org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions	describeOptions()
void	init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source, Map<String,String> options, org.apache.accumulo.core.iterators.IteratorEnvironment env)
static void	setCurrentTime(org.apache.accumulo.core.client.IteratorSetting is, Long currentTime) A convenience method for setting the current time (from which to measure the age off threshold).
static void	setTTL(org.apache.accumulo.core.client.IteratorSetting is, Long ttl) A convenience method for setting the age off threshold.
boolean	validateOptions(Map<String,String> options)

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

Field Detail

TTL

protected static final String TTL

See Also:

Constant Field Values

CURRENT_TIME

protected static final String CURRENT_TIME

See Also:

Constant Field Values

threshold

protected long threshold

currentTime

protected long currentTime

The use of private for this member in the original AgeOffFilter wouldn't allow me to extend it. Setting to protected.

Constructor Detail

TimeLimitingFilter

public TimeLimitingFilter()

Method Detail

setTTL

public static void setTTL(org.apache.accumulo.core.client.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(org.apache.accumulo.core.client.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.

accept

public boolean accept(org.apache.accumulo.core.data.Key k,
             org.apache.accumulo.core.data.Value v)

Accepts entries whose timestamps are less than currentTime - threshold.

Specified by:

accept in class org.apache.accumulo.core.iterators.Filter

See Also:

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

init

public void init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source,
        Map<String,String> options,
        org.apache.accumulo.core.iterators.IteratorEnvironment env)
          throws IOException

Specified by:

init in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Overrides:

init in class org.apache.accumulo.core.iterators.Filter

Throws:

IOException

deepCopy

public org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)

Specified by:

deepCopy in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Overrides:

deepCopy in class org.apache.accumulo.core.iterators.Filter

describeOptions

public org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions describeOptions()

Specified by:

describeOptions in interface org.apache.accumulo.core.iterators.OptionDescriber

Overrides:

describeOptions in class org.apache.accumulo.core.iterators.Filter

validateOptions

public boolean validateOptions(Map<String,String> options)

Specified by:

validateOptions in interface org.apache.accumulo.core.iterators.OptionDescriber

Overrides:

validateOptions in class org.apache.accumulo.core.iterators.Filter