Author: billie
Date: Fri May 4 18:06:22 2012
New Revision: 1334105
URL: http://svn.apache.org/viewvc?rev=1334105&view=rev
Log:
ACCUMULO-574 expand seek javadoc
Modified:
accumulo/branches/1.4/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
Modified:
accumulo/branches/1.4/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
URL:
http://svn.apache.org/viewvc/accumulo/branches/1.4/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java?rev=1334105&r1=1334104&r2=1334105&view=diff
==============================================================================
---
accumulo/branches/1.4/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
(original)
+++
accumulo/branches/1.4/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
Fri May 4 18:06:22 2012
@@ -76,6 +76,12 @@ public 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 after {@link
#init} 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.
+ *
* @param range
* <tt>Range</tt> of keys to iterate over.
* @param columnFamilies
