|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.accumulo.core.iterators.WrappingIterator
org.apache.accumulo.core.iterators.Filter
org.apache.accumulo.core.iterators.user.AgeOffFilter
public class AgeOffFilter
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 |
| Constructor Summary | |
|---|---|
AgeOffFilter()
|
|
| Method Summary | |
|---|---|
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 |
| Constructor Detail |
|---|
public AgeOffFilter()
| Method Detail |
|---|
public boolean accept(Key k,
Value v)
accept in class FilterFilter.accept(org.apache.accumulo.core.data.Key, org.apache.accumulo.core.data.Value)
public void init(SortedKeyValueIterator<Key,Value> source,
Map<String,String> options,
IteratorEnvironment env)
throws IOException
SortedKeyValueIterator
init in interface SortedKeyValueIterator<Key,Value>init in class Filtersource - 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.
IOException - unused.public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
SortedKeyValueIterator
deepCopy in interface SortedKeyValueIterator<Key,Value>deepCopy in class Filterenv - IteratorEnvironment environment in which iterator is being run.
public OptionDescriber.IteratorOptions describeOptions()
OptionDescriber
describeOptions in interface OptionDescriberdescribeOptions in class Filterpublic boolean validateOptions(Map<String,String> options)
OptionDescriber
validateOptions in interface OptionDescribervalidateOptions in class Filteroptions - a map of option names to option values
public static void setTTL(IteratorSetting is,
Long ttl)
is - IteratorSetting object to configure.ttl - age off threshold in milliseconds.
public static void setCurrentTime(IteratorSetting is,
Long currentTime)
is - IteratorSetting object to configure.currentTime - time in milliseconds.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||