CollectionBackedScanner (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner
- - org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner
  - - org.apache.hadoop.hbase.util.CollectionBackedScanner

All Implemented Interfaces:

KeyValueScanner
```
@InterfaceAudience.Private
public class CollectionBackedScanner
extends NonReversedNonLazyKeyValueScanner
```
Utility scanner that wraps a sortable collection and serves as a KeyValueScanner.

Field Summary

Fields
Modifier and Type Field and Description

(package private) KeyValue.KVComparator comparator

private Cell current

private Iterable<Cell> data

private Iterator<Cell> iter
- Fields inherited from interface org.apache.hadoop.hbase.regionserver.KeyValueScanner
  NO_NEXT_INDEXED_KEY

Fields
Modifier and Type	Field and Description
`(package private) KeyValue.KVComparator`	`comparator`
`private Cell`	`current`
`private Iterable<Cell>`	`data`
`private Iterator<Cell>`	`iter`

Constructor Summary

Constructors
Constructor and Description
`CollectionBackedScanner(KeyValue.KVComparator comparator, Cell... array)`
`CollectionBackedScanner(List<Cell> list)`
`CollectionBackedScanner(List<Cell> list, KeyValue.KVComparator comparator)`
`CollectionBackedScanner(SortedSet<Cell> set)`
`CollectionBackedScanner(SortedSet<Cell> set, KeyValue.KVComparator comparator)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close the KeyValue scanner.
`long`	`getSequenceID()` Get the sequence id associated with this KeyValueScanner.
`private void`	`init()`
`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, getNextIndexedKey, isFileScanner, realSeekDone, requestSeek, shouldUseScanner

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - data
```
private final Iterable<Cell> data
```
  - comparator
```
final KeyValue.KVComparator comparator
```
  - iter
```
private Iterator<Cell> iter
```
  - current
```
private Cell current
```
- Constructor Detail
  - CollectionBackedScanner
```
public CollectionBackedScanner(SortedSet<Cell> set)
```
  - CollectionBackedScanner
```
public CollectionBackedScanner(SortedSet<Cell> set,
                       KeyValue.KVComparator comparator)
```
  - CollectionBackedScanner
```
public CollectionBackedScanner(List<Cell> list)
```
  - CollectionBackedScanner
```
public CollectionBackedScanner(List<Cell> list,
                       KeyValue.KVComparator comparator)
```
  - CollectionBackedScanner
```
public CollectionBackedScanner(KeyValue.KVComparator comparator,
                       Cell... array)
```
- Method Detail
  - init
```
private void init()
```
  - peek
```
public Cell peek()
```
    Description copied from interface: KeyValueScanner
    
    Look at the next Cell in this scanner, but do not iterate scanner.
    
    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
  - getSequenceID
```
public long getSequenceID()
```
    Description copied from interface: KeyValueScanner
    
    Get the sequence id associated with this KeyValueScanner. This is required for comparing multiple files to find out which one has the latest data. The default implementation for this would be to return 0. A file having lower sequence id will be considered to be the older one.
  - close
```
public void close()
```
    Description copied from interface: KeyValueScanner
    
    Close the KeyValue scanner.

Class CollectionBackedScanner

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

data

comparator

iter

current

Constructor Detail

CollectionBackedScanner

CollectionBackedScanner

CollectionBackedScanner

CollectionBackedScanner

CollectionBackedScanner

Method Detail

init

peek

next

seek

reseek

getSequenceID

close