Class TimestampFilter
- java.lang.Object
-
- org.apache.accumulo.core.iterators.WrappingIterator
-
- org.apache.accumulo.core.iterators.Filter
-
- org.apache.accumulo.core.iterators.user.TimestampFilter
-
- All Implemented Interfaces:
OptionDescriber
,SortedKeyValueIterator<Key,Value>
public class TimestampFilter extends Filter
A Filter that matches entries whose timestamps fall within a range.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber
OptionDescriber.IteratorOptions
-
-
Constructor Summary
Constructors Constructor Description TimestampFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(Key k, Value v)
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
setEnd(IteratorSetting is, long end, boolean endInclusive)
A convenience method for setting the end timestamp accepted by the timestamp filter.static void
setEnd(IteratorSetting is, String end, boolean endInclusive)
A convenience method for setting the end timestamp accepted by the timestamp filter.static void
setRange(IteratorSetting is, long start, boolean startInclusive, long end, boolean endInclusive)
A convenience method for setting the range of timestamps accepted by the timestamp filter.static void
setRange(IteratorSetting is, long start, long end)
A convenience method for setting the range of timestamps accepted by the timestamp filter.static void
setRange(IteratorSetting is, String start, boolean startInclusive, String end, boolean endInclusive)
A convenience method for setting the range of timestamps accepted by the timestamp filter.static void
setRange(IteratorSetting is, String start, String end)
A convenience method for setting the range of timestamps accepted by the timestamp filter.static void
setStart(IteratorSetting is, long start, boolean startInclusive)
A convenience method for setting the start timestamp accepted by the timestamp filter.static void
setStart(IteratorSetting is, String start, boolean startInclusive)
A convenience method for setting the start timestamp accepted by the timestamp filter.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
-
-
-
-
Field Detail
-
START
public static final String START
- See Also:
- Constant Field Values
-
START_INCL
public static final String START_INCL
- See Also:
- Constant Field Values
-
END
public static final String END
- See Also:
- Constant Field Values
-
END_INCL
public static final String END_INCL
- See Also:
- Constant Field Values
-
-
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 interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
init
in classFilter
- 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 interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
deepCopy
in classFilter
- 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 interfaceOptionDescriber
- Overrides:
describeOptions
in classFilter
- 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 interfaceOptionDescriber
- Overrides:
validateOptions
in classFilter
- Parameters:
options
- a map of option names to option values- Returns:
- true if options are valid, false otherwise (IllegalArgumentException preferred)
-
setRange
public static void setRange(IteratorSetting is, String start, String end)
A convenience method for setting the range of timestamps accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestamp, inclusive (yyyyMMddHHmmssz)end
- the end timestamp, inclusive (yyyyMMddHHmmssz)
-
setRange
public static void setRange(IteratorSetting is, String start, boolean startInclusive, String end, boolean endInclusive)
A convenience method for setting the range of timestamps accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestamp (yyyyMMddHHmmssz)startInclusive
- boolean indicating whether the start is inclusiveend
- the end timestamp (yyyyMMddHHmmssz)endInclusive
- boolean indicating whether the end is inclusive
-
setStart
public static void setStart(IteratorSetting is, String start, boolean startInclusive)
A convenience method for setting the start timestamp accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestamp (yyyyMMddHHmmssz)startInclusive
- boolean indicating whether the start is inclusive
-
setEnd
public static void setEnd(IteratorSetting is, String end, boolean endInclusive)
A convenience method for setting the end timestamp accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configureend
- the end timestamp (yyyyMMddHHmmssz)endInclusive
- boolean indicating whether the end is inclusive
-
setRange
public static void setRange(IteratorSetting is, long start, long end)
A convenience method for setting the range of timestamps accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestamp, inclusiveend
- the end timestamp, inclusive
-
setRange
public static void setRange(IteratorSetting is, long start, boolean startInclusive, long end, boolean endInclusive)
A convenience method for setting the range of timestamps accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestampstartInclusive
- boolean indicating whether the start is inclusiveend
- the end timestampendInclusive
- boolean indicating whether the end is inclusive
-
setStart
public static void setStart(IteratorSetting is, long start, boolean startInclusive)
A convenience method for setting the start timestamp accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configurestart
- the start timestampstartInclusive
- boolean indicating whether the start is inclusive
-
setEnd
public static void setEnd(IteratorSetting is, long end, boolean endInclusive)
A convenience method for setting the end timestamp accepted by the timestamp filter.- Parameters:
is
- the iterator setting object to configureend
- the end timestampendInclusive
- boolean indicating whether the end is inclusive
-
-