org.apache.tez.runtime.library.common.sort.impl

Interface TezRawKeyValueIterator

All Known Implementing Classes:

DefaultSorter.MRResultIterator

@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface TezRawKeyValueIterator

TezRawKeyValueIterator is an iterator used to iterate over the raw keys and values during sort/merge of intermediate data.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the iterator so that the underlying streams can be closed.
org.apache.hadoop.io.DataInputBuffer	getKey() Gets the current raw key.
org.apache.hadoop.util.Progress	getProgress() Gets the Progress object; this has a float (0.0 - 1.0) indicating the bytes processed by the iterator so far
org.apache.hadoop.io.DataInputBuffer	getValue() Gets the current raw value.
boolean	isSameKey() Whether the current key is same as the previous key
boolean	next() Sets up the current key and value (for getKey and getValue).

Method Detail

getKey

org.apache.hadoop.io.DataInputBuffer getKey()
                                            throws IOException

Gets the current raw key.

Returns:

Gets the current raw key as a DataInputBuffer

Throws:

IOException

getValue

org.apache.hadoop.io.DataInputBuffer getValue()
                                              throws IOException

Gets the current raw value.

Returns:

Gets the current raw value as a DataInputBuffer

Throws:

IOException

next

boolean next()
             throws IOException

Sets up the current key and value (for getKey and getValue).

Returns:

true if there exists a key/value, false otherwise.

Throws:

IOException

close

void close()
           throws IOException

Closes the iterator so that the underlying streams can be closed.

Throws:

IOException

getProgress

org.apache.hadoop.util.Progress getProgress()

Gets the Progress object; this has a float (0.0 - 1.0) indicating the bytes processed by the iterator so far

isSameKey

boolean isSameKey()
                  throws IOException

Whether the current key is same as the previous key

Returns:

true if key is the same as the previous key

Throws:

IOException