Class InterruptibleMapIterator
- java.lang.Object
-
- org.apache.accumulo.core.iterators.SortedMapIterator
-
- org.apache.accumulo.core.iteratorsImpl.system.InterruptibleMapIterator
-
- All Implemented Interfaces:
SortedKeyValueIterator<Key,Value>
,YieldingKeyValueIterator<Key,Value>
,InterruptibleIterator
public class InterruptibleMapIterator extends SortedMapIterator implements InterruptibleIterator
A SortedMapIterator but is made Interruptible for system use. This behavior was moved here so that SortedMapIterator could be treated as public API.
-
-
Constructor Summary
Constructors Constructor Description InterruptibleMapIterator(SortedMap<Key,Value> map, AtomicBoolean interruptFlag)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
next()
Advances to the next K,V pair.void
seek(Range range, Collection<ByteSequence> columnFamilies, boolean inclusive)
Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns.void
setInterruptFlag(AtomicBoolean flag)
-
Methods inherited from class org.apache.accumulo.core.iterators.SortedMapIterator
deepCopy, getTopKey, getTopValue, hasTop, init
-
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.SortedKeyValueIterator
deepCopy, getTopKey, getTopValue, hasTop, init
-
Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator
enableYielding
-
-
-
-
Constructor Detail
-
InterruptibleMapIterator
public InterruptibleMapIterator(SortedMap<Key,Value> map, AtomicBoolean interruptFlag)
-
-
Method Detail
-
next
public void next() throws IOException
Description copied from interface:SortedKeyValueIterator
Advances to the next K,V pair. Note that in minor compaction scope and in non-full major compaction scopes the iterator may see deletion entries. These entries should be preserved by all iterators except ones that are strictly scan-time iterators that will never be configured for the minc or majc scopes. Deletion entries are only removed during full major compactions.- Specified by:
next
in interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
next
in classSortedMapIterator
- Throws:
IOException
- if an I/O error occurs.
-
seek
public void seek(Range range, Collection<ByteSequence> columnFamilies, boolean inclusive) throws IOException
Description copied from interface:SortedKeyValueIterator
Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns. An iterator does not have to stop at the end of the range. The whole range is provided so that iterators can make optimizations. Seek may be called multiple times with different parameters afterSortedKeyValueIterator.init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<K, V>, java.util.Map<java.lang.String, java.lang.String>, org.apache.accumulo.core.iterators.IteratorEnvironment)
is called. Iterators that examine groups of adjacent key/value pairs (e.g. rows) to determine their top key and value should be sure that they properly handle a seek to a key in the middle of such a group (e.g. the middle of a row). Even if the client always seeks to a range containing an entire group (a,c), the tablet server could send back a batch of entries corresponding to (a,b], then reseek the iterator to range (b,c) when the scan is continued.columnFamilies
is used, at the lowest level, to determine which data blocks inside of an RFile need to be opened for this iterator. This set of data blocks is also the set of locality groups defined for the given table. If no columnFamilies are provided, the data blocks for all locality groups inside of the correct RFile will be opened and seeked in an attempt to find the correct start key, regardless of the startKey in therange
. In an Accumulo instance in which multiple locality groups exist for a table, it is important to ensure thatcolumnFamilies
is properly set to the minimum required column families to ensure that data from separate locality groups is not inadvertently read.- Specified by:
seek
in interfaceSortedKeyValueIterator<Key,Value>
- Overrides:
seek
in classSortedMapIterator
- Parameters:
range
-Range
of keys to iterate over.columnFamilies
-Collection
of column families to include or exclude.inclusive
-boolean
that indicates whether to include (true) or exclude (false) column families.- Throws:
IOException
- if an I/O error occurs.
-
setInterruptFlag
public void setInterruptFlag(AtomicBoolean flag)
- Specified by:
setInterruptFlag
in interfaceInterruptibleIterator
-
-