org.apache.accumulo.core.iterators.user

Class ColumnSliceFilter

java.lang.Object

org.apache.accumulo.core.iterators.WrappingIterator

org.apache.accumulo.core.iterators.Filter

org.apache.accumulo.core.iterators.user.ColumnSliceFilter

All Implemented Interfaces:

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

public class ColumnSliceFilter
extends Filter

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber

OptionDescriber.IteratorOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_BOUND
static String	END_INCLUSIVE
static String	START_BOUND
static String	START_INCLUSIVE

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

NEGATE

Constructor Summary

Constructors

Constructor and Description
ColumnSliceFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(Key key, Value value)
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	setSlice(IteratorSetting si, String start, boolean startInclusive, String end, boolean endInclusive)
static void	setSlice(IteratorSetting si, String start, String end)

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

findTop, next, seek, setNegate, validateOptions

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

Field Detail

START_BOUND

public static final String START_BOUND

See Also:

Constant Field Values

START_INCLUSIVE

public static final String START_INCLUSIVE

See Also:

Constant Field Values

END_BOUND

public static final String END_BOUND

See Also:

Constant Field Values

END_INCLUSIVE

public static final String END_INCLUSIVE

See Also:

Constant Field Values

Constructor Detail

ColumnSliceFilter

public ColumnSliceFilter()

Method Detail

accept

public boolean accept(Key key,
                      Value value)

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.

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

setSlice

public static void setSlice(IteratorSetting si,
                            String start,
                            String end)

setSlice

public static void setSlice(IteratorSetting si,
                            String start,
                            boolean startInclusive,
                            String end,
                            boolean endInclusive)

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.

Returns:

SortedKeyValueIterator a copy of this iterator (with the same source and settings).