org.apache.accumulo.core.iterators.user
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

Field Summary

static String	END
static String	END_INCL
static String	START
static String	START_INCL

Constructor Summary

TimestampFilter()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

TimestampFilter

public TimestampFilter()

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

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

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 configure

start - 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 configure

start - the start timestamp (yyyyMMddHHmmssz)

startInclusive - boolean indicating whether the start is inclusive

end - 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 configure

start - 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 configure

end - 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 configure

start - the start timestamp, inclusive

end - 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 configure

start - the start timestamp

startInclusive - boolean indicating whether the start is inclusive

end - the end timestamp

endInclusive - 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 configure

start - the start timestamp

startInclusive - 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 configure

end - the end timestamp

endInclusive - boolean indicating whether the end is inclusive