ScanDeleteTracker (Apache HBase 2.2.3 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.querymatcher.ScanDeleteTracker

All Implemented Interfaces:

DeleteTracker, ShipperListener

Direct Known Subclasses:

VisibilityScanDeleteTracker
```
@InterfaceAudience.Private
public class ScanDeleteTracker
extends Object
implements DeleteTracker
```
This class is responsible for the tracking and enforcement of Deletes during the course of a Scan operation. It only has to enforce Delete and DeleteColumn, since the DeleteFamily is handled at a higher level.
This class is utilized through three methods:
- add(org.apache.hadoop.hbase.Cell) when encountering a Delete or DeleteColumn
- isDeleted(org.apache.hadoop.hbase.Cell) when checking if a Put Cell has been deleted
- update() when reaching the end of a StoreFile or row for scans
This class is NOT thread-safe as queries are never multi-threaded

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker
  DeleteTracker.DeleteResult

Field Summary

Fields
Modifier and Type	Field and Description
`protected CellComparator`	`comparator`
`protected byte[]`	`deleteBuffer`
`protected Cell`	`deleteCell`
`protected int`	`deleteLength`
`protected int`	`deleteOffset`
`protected long`	`deleteTimestamp`
`protected byte`	`deleteType`
`protected long`	`familyStamp`
`protected SortedSet<Long>`	`familyVersionStamps`
`protected boolean`	`hasFamilyStamp`

Constructor Summary

Constructors
Constructor and Description

ScanDeleteTracker(CellComparator comparator)

Constructors
Constructor and Description
`ScanDeleteTracker(CellComparator comparator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Cell cell)` Add the specified Cell to the list of deletes to check against for this row operation.
`void`	`beforeShipped()` The action that needs to be performed before `Shipper.shipped()` is performed
`CellComparator`	`getCellComparator()` Return the comparator passed to this delete tracker
`DeleteTracker.DeleteResult`	`isDeleted(Cell cell)` Check if the specified Cell buffer has been deleted by a previously seen delete.
`boolean`	`isEmpty()`
`void`	`reset()` Called between rows.
`void`	`update()` Called at the end of every StoreFile.

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

- Field Detail
  - hasFamilyStamp
```
protected boolean hasFamilyStamp
```
  - familyStamp
```
protected long familyStamp
```
  - familyVersionStamps
```
protected SortedSet<Long> familyVersionStamps
```
  - deleteCell
```
protected Cell deleteCell
```
  - deleteBuffer
```
protected byte[] deleteBuffer
```
  - deleteOffset
```
protected int deleteOffset
```
  - deleteLength
```
protected int deleteLength
```
  - deleteType
```
protected byte deleteType
```
  - deleteTimestamp
```
protected long deleteTimestamp
```
  - comparator
```
protected final CellComparator comparator
```
- Constructor Detail
  - ScanDeleteTracker
```
public ScanDeleteTracker(CellComparator comparator)
```
- Method Detail
  - add
```
public void add(Cell cell)
```
    Add the specified Cell to the list of deletes to check against for this row operation.
    This is called when a Delete is encountered.
    
    Specified by:
    
    add in interface DeleteTracker
    
    Parameters:
    
    cell - - the delete cell
  - isDeleted
```
public DeleteTracker.DeleteResult isDeleted(Cell cell)
```
    Check if the specified Cell buffer has been deleted by a previously seen delete.
    
    Specified by:
    
    isDeleted in interface DeleteTracker
    
    Parameters:
    
    cell - - current cell to check if deleted by a previously seen delete
    
    Returns:
    
    deleteResult
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface DeleteTracker
    
    Returns:
    
    true if there are no current delete, false otherwise
  - reset
```
public void reset()
```
    Description copied from interface: DeleteTracker
    
    Called between rows.
    This clears everything as if a new DeleteTracker was instantiated.
    
    Specified by:
    
    reset in interface DeleteTracker
  - update
```
public void update()
```
    Description copied from interface: DeleteTracker
    
    Called at the end of every StoreFile.
    Many optimized implementations of Trackers will require an update at when the end of each StoreFile is reached.
    
    Specified by:
    
    update in interface DeleteTracker
  - beforeShipped
```
public void beforeShipped()
                   throws IOException
```
    Description copied from interface: ShipperListener
    
    The action that needs to be performed before Shipper.shipped() is performed
    
    Specified by:
    
    beforeShipped in interface ShipperListener
    
    Throws:
    
    IOException
  - getCellComparator
```
public CellComparator getCellComparator()
```
    Description copied from interface: DeleteTracker
    
    Return the comparator passed to this delete tracker
    
    Specified by:
    
    getCellComparator in interface DeleteTracker
    
    Returns:
    
    the cell comparator

Class ScanDeleteTracker

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hasFamilyStamp

familyStamp

familyVersionStamps

deleteCell

deleteBuffer

deleteOffset

deleteLength

deleteType

deleteTimestamp

comparator

Constructor Detail

ScanDeleteTracker

Method Detail

add

isDeleted

isEmpty

reset

update

beforeShipped

getCellComparator