org.apache.hadoop.hbase.util

Class CollectionBackedScanner

java.lang.Object

org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner

org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner

org.apache.hadoop.hbase.util.CollectionBackedScanner

All Implemented Interfaces:

Closeable, AutoCloseable, KeyValueScanner, Shipper

@InterfaceAudience.Private
public class CollectionBackedScanner
extends NonReversedNonLazyKeyValueScanner

Utility scanner that wraps a sortable collection and serves as a KeyValueScanner.

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.regionserver.KeyValueScanner

NO_NEXT_INDEXED_KEY

Constructor Summary

Constructors

Constructor and Description
CollectionBackedScanner(CellComparator comparator, Cell... array)
CollectionBackedScanner(List<Cell> list)
CollectionBackedScanner(List<Cell> list, CellComparator comparator)
CollectionBackedScanner(SortedSet<Cell> set)
CollectionBackedScanner(SortedSet<Cell> set, CellComparator comparator)

Method Summary

Modifier and Type	Method and Description
void	close() Close the KeyValue scanner.
Cell	next() Return the next Cell in this scanner, iterating the scanner
Cell	peek() Look at the next Cell in this scanner, but do not iterate scanner.
boolean	reseek(Cell seekCell) Reseek the scanner at or after the specified KeyValue.
boolean	seek(Cell seekCell) Seek the scanner at or after the specified KeyValue.

Methods inherited from class org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner

backwardSeek, seekToLastRow, seekToPreviousRow

Methods inherited from class org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner

doRealSeek, enforceSeek, getFilePath, getNextIndexedKey, isFileScanner, realSeekDone, requestSeek, shipped, shouldUseScanner

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.regionserver.KeyValueScanner

getScannerOrder

Constructor Detail

CollectionBackedScanner

public CollectionBackedScanner(SortedSet<Cell> set)

CollectionBackedScanner

public CollectionBackedScanner(SortedSet<Cell> set,
                               CellComparator comparator)

CollectionBackedScanner

public CollectionBackedScanner(List<Cell> list)

CollectionBackedScanner

public CollectionBackedScanner(List<Cell> list,
                               CellComparator comparator)

CollectionBackedScanner

public CollectionBackedScanner(CellComparator comparator,
                               Cell... array)

Method Detail

peek

public Cell peek()

Description copied from interface: KeyValueScanner

Look at the next Cell in this scanner, but do not iterate scanner. NOTICE: The returned cell has not been passed into ScanQueryMatcher. So it may not be what the user need.

Returns:

the next Cell

next

public Cell next()

Description copied from interface: KeyValueScanner

Return the next Cell in this scanner, iterating the scanner

Returns:

the next Cell

seek

public boolean seek(Cell seekCell)

Description copied from interface: KeyValueScanner

Seek the scanner at or after the specified KeyValue.

Parameters:

seekCell - seek value

Returns:

true if scanner has values left, false if end of scanner

reseek

public boolean reseek(Cell seekCell)

Description copied from interface: KeyValueScanner

Reseek the scanner at or after the specified KeyValue. This method is guaranteed to seek at or after the required key only if the key comes after the current position of the scanner. Should not be used to seek to a key which may come before the current position.

Parameters:

seekCell - seek value (should be non-null)

Returns:

true if scanner has values left, false if end of scanner

close

public void close()

Description copied from interface: KeyValueScanner

Close the KeyValue scanner.