org.calrissian.accumulorecipes.commons.iterators

Class FirstNEntriesInRowIterator

java.lang.Object

org.calrissian.accumulorecipes.commons.iterators.FirstNEntriesInRowIterator

All Implemented Interfaces:

org.apache.accumulo.core.iterators.OptionDescriber, org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

public class FirstNEntriesInRowIterator
extends Object
implements org.apache.accumulo.core.iterators.OptionDescriber, org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

This SortedKeyValueIterator will return only the first n keys/values for each row that it iterates through.

Nested Class Summary

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

org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions

Constructor Summary

Constructors

Constructor and Description
FirstNEntriesInRowIterator()
FirstNEntriesInRowIterator(FirstNEntriesInRowIterator other, org.apache.accumulo.core.iterators.IteratorEnvironment env)

Method Summary

Methods

Modifier and Type	Method and Description
static List<Map.Entry<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>>	decodeRow(org.apache.accumulo.core.data.Key rowKey, org.apache.accumulo.core.data.Value rowValue)
org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>	deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)
org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions	describeOptions()
static org.apache.accumulo.core.data.Value	encodeRow(List<org.apache.accumulo.core.data.Key> keys, List<org.apache.accumulo.core.data.Value> values)
protected org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>	getSource()
org.apache.accumulo.core.data.Key	getTopKey()
org.apache.accumulo.core.data.Value	getTopValue()
boolean	hasTop()
void	init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source, Map<String,String> options, org.apache.accumulo.core.iterators.IteratorEnvironment env)
void	next()
void	seek(org.apache.accumulo.core.data.Range range, Collection<org.apache.accumulo.core.data.ByteSequence> columnFamilies, boolean inclusive)
static void	setNumKeysToReturn(org.apache.accumulo.core.client.IteratorSetting cfg, int n)
static void	setNumScansBeforeSeek(org.apache.accumulo.core.client.IteratorSetting cfg, int num)
protected void	setSource(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source)
protected void	skipRow()
boolean	validateOptions(Map<String,String> options)

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstNEntriesInRowIterator

public FirstNEntriesInRowIterator()

FirstNEntriesInRowIterator

public FirstNEntriesInRowIterator(FirstNEntriesInRowIterator other,
                          org.apache.accumulo.core.iterators.IteratorEnvironment env)

Method Detail

setNumScansBeforeSeek

public static void setNumScansBeforeSeek(org.apache.accumulo.core.client.IteratorSetting cfg,
                         int num)

setNumKeysToReturn

public static void setNumKeysToReturn(org.apache.accumulo.core.client.IteratorSetting cfg,
                      int n)

decodeRow

public static final List<Map.Entry<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>> decodeRow(org.apache.accumulo.core.data.Key rowKey,
                                                                                               org.apache.accumulo.core.data.Value rowValue)
                                                                                                              throws IOException

Throws:

IOException

encodeRow

public static final org.apache.accumulo.core.data.Value encodeRow(List<org.apache.accumulo.core.data.Key> keys,
                                            List<org.apache.accumulo.core.data.Value> values)
                                                           throws IOException

Throws:

IOException

deepCopy

public org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)

Specified by:

deepCopy in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

init

public void init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source,
        Map<String,String> options,
        org.apache.accumulo.core.iterators.IteratorEnvironment env)
          throws IOException

Specified by:

init in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

hasTop

public boolean hasTop()

Specified by:

hasTop in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

next

public void next()
          throws IOException

Specified by:

next in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

getSource

protected org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> getSource()

setSource

protected void setSource(org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value> source)

skipRow

protected void skipRow()
                throws IOException

Throws:

IOException

seek

public void seek(org.apache.accumulo.core.data.Range range,
        Collection<org.apache.accumulo.core.data.ByteSequence> columnFamilies,
        boolean inclusive)
          throws IOException

Specified by:

seek in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

Throws:

IOException

getTopKey

public org.apache.accumulo.core.data.Key getTopKey()

Specified by:

getTopKey in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

getTopValue

public org.apache.accumulo.core.data.Value getTopValue()

Specified by:

getTopValue in interface org.apache.accumulo.core.iterators.SortedKeyValueIterator<org.apache.accumulo.core.data.Key,org.apache.accumulo.core.data.Value>

describeOptions

public org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions describeOptions()

Specified by:

describeOptions in interface org.apache.accumulo.core.iterators.OptionDescriber

validateOptions

public boolean validateOptions(Map<String,String> options)

Specified by:

validateOptions in interface org.apache.accumulo.core.iterators.OptionDescriber