io.cdap.cdap.api.dataset.lib

Class KeyValueTable.KeyValueScanner

java.lang.Object

io.cdap.cdap.api.data.batch.SplitReader<byte[],byte[]>

io.cdap.cdap.api.dataset.lib.KeyValueTable.KeyValueScanner

Enclosing class:

KeyValueTable

public class KeyValueTable.KeyValueScanner
extends SplitReader<byte[],byte[]>

The split reader for KeyValueTable.

Constructor Summary

Constructors

Constructor and Description
KeyValueScanner(SplitReader<byte[],Row> reader)

Method Summary

Modifier and Type	Method and Description
void	close() Close the record reader.
byte[]	getCurrentKey() Get the current key.
byte[]	getCurrentValue() Get the current value.
void	initialize(Split split) Called once at initialization.
boolean	nextKeyValue() Read the next key, value pair.

Methods inherited from class io.cdap.cdap.api.data.batch.SplitReader

getProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueScanner

public KeyValueScanner(SplitReader<byte[],Row> reader)

Method Detail

initialize

public void initialize(Split split)
                throws InterruptedException

Description copied from class: SplitReader

Called once at initialization.

Specified by:

initialize in class SplitReader<byte[],byte[]>

Parameters:

split - The split that defines the range of records to read.

Throws:

InterruptedException

nextKeyValue

public boolean nextKeyValue()
                     throws InterruptedException

Description copied from class: SplitReader

Read the next key, value pair.

Specified by:

nextKeyValue in class SplitReader<byte[],byte[]>

Returns:

true if a key/value pair was read.

Throws:

InterruptedException

getCurrentKey

public byte[] getCurrentKey()
                     throws InterruptedException

Description copied from class: SplitReader

Get the current key.

Specified by:

getCurrentKey in class SplitReader<byte[],byte[]>

Returns:

The current key, or null if there is no current key.

Throws:

InterruptedException

getCurrentValue

public byte[] getCurrentValue()
                       throws InterruptedException

Description copied from class: SplitReader

Get the current value.

Specified by:

getCurrentValue in class SplitReader<byte[],byte[]>

Returns:

The current value of the object that was read.

Throws:

InterruptedException

close

public void close()

Description copied from class: SplitReader

Close the record reader.

Specified by:

close in class SplitReader<byte[],byte[]>