BufferedDataBlockEncoder.SeekerState (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.BufferedDataBlockEncoder.SeekerState

All Implemented Interfaces:

Cell

Direct Known Subclasses:

DiffKeyDeltaEncoder.DiffSeekerState, FastDiffDeltaEncoder.FastDiffSeekerState

Enclosing class:

BufferedDataBlockEncoder
```
protected static class BufferedDataBlockEncoder.SeekerState
extends Object
implements Cell
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteBuffer`	`currentBuffer`
`protected KeyValue.KeyOnlyKeyValue`	`currentKey`
`protected byte[]`	`keyBuffer` We need to store a copy of the key.
`protected int`	`keyLength`
`protected int`	`lastCommonPrefix`
`protected long`	`memstoreTS`
`protected int`	`nextKvOffset`
`protected TagCompressionContext`	`tagCompressionContext`
`protected byte[]`	`tagsBuffer`
`protected int`	`tagsCompressedLength`
`protected int`	`tagsLength`
`protected int`	`tagsOffset`
`protected boolean`	`uncompressTags`
`protected int`	`valueLength`
`protected int`	`valueOffset`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BufferedDataBlockEncoder.SeekerState()

Constructors
Modifier	Constructor and Description
`protected`	`BufferedDataBlockEncoder.SeekerState()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`copyFromNext(BufferedDataBlockEncoder.SeekerState nextState)` Copy the state from the next one into this instance (the previous state placeholder).
`protected void`	`ensureSpaceForKey()`
`protected void`	`ensureSpaceForTags()`
`byte[]`	`getFamily()` Deprecated.
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`byte`	`getFamilyLength()`
`int`	`getFamilyOffset()`
`long`	`getMvccVersion()`
`byte[]`	`getQualifier()` Deprecated.
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()`
`int`	`getQualifierOffset()`
`byte[]`	`getRow()` Deprecated.
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`short`	`getRowLength()`
`int`	`getRowOffset()`
`long`	`getSequenceId()` A region-specific unique monotonically increasing sequence ID given to each Cell.
`byte[]`	`getTagsArray()`
`int`	`getTagsLength()`
`int`	`getTagsOffset()`
`long`	`getTimestamp()`
`byte`	`getTypeByte()`
`byte[]`	`getValue()` Deprecated.
`byte[]`	`getValueArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getValueLength()`
`int`	`getValueOffset()`
`protected void`	`invalidate()`
`protected boolean`	`isValid()`
`protected void`	`setKey(byte[] keyBuffer, long memTS)`
`Cell`	`shallowCopy()`
`String`	`toString()`

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

- Field Detail
  - currentBuffer
```
protected ByteBuffer currentBuffer
```
  - tagCompressionContext
```
protected TagCompressionContext tagCompressionContext
```
  - valueOffset
```
protected int valueOffset
```
  - keyLength
```
protected int keyLength
```
  - valueLength
```
protected int valueLength
```
  - lastCommonPrefix
```
protected int lastCommonPrefix
```
  - tagsLength
```
protected int tagsLength
```
  - tagsOffset
```
protected int tagsOffset
```
  - tagsCompressedLength
```
protected int tagsCompressedLength
```
  - uncompressTags
```
protected boolean uncompressTags
```
  - keyBuffer
```
protected byte[] keyBuffer
```
    We need to store a copy of the key.
  - tagsBuffer
```
protected byte[] tagsBuffer
```
  - memstoreTS
```
protected long memstoreTS
```
  - nextKvOffset
```
protected int nextKvOffset
```
  - currentKey
```
protected KeyValue.KeyOnlyKeyValue currentKey
```
- Constructor Detail
  - BufferedDataBlockEncoder.SeekerState
```
protected BufferedDataBlockEncoder.SeekerState()
```
- Method Detail
  - isValid
```
protected boolean isValid()
```
  - invalidate
```
protected void invalidate()
```
  - ensureSpaceForKey
```
protected void ensureSpaceForKey()
```
  - ensureSpaceForTags
```
protected void ensureSpaceForTags()
```
  - setKey
```
protected void setKey(byte[] keyBuffer,
          long memTS)
```
  - copyFromNext
```
protected void copyFromNext(BufferedDataBlockEncoder.SeekerState nextState)
```
    Copy the state from the next one into this instance (the previous state placeholder). Used to save the previous state when we are advancing the seeker to the next key/value.
  - getRowArray
```
public byte[] getRowArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Short.MAX_VALUE which is 32,767 bytes.
    
    Specified by:
    
    getRowArray in interface Cell
    
    Returns:
    The array containing the row bytes.
  - getRowOffset
```
public int getRowOffset()
```
    Specified by:
    
    getRowOffset in interface Cell
    
    Returns:
    Array index of first row byte
  - getRowLength
```
public short getRowLength()
```
    Specified by:
    
    getRowLength in interface Cell
    
    Returns:
    Number of row bytes. Must be < rowArray.length - offset.
  - getFamilyArray
```
public byte[] getFamilyArray()
```
    Description copied from interface: Cell
    
    Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array. Max length is Byte.MAX_VALUE, which is 127 bytes.
    
    Specified by:
    
    getFamilyArray in interface Cell
    
    Returns:
    the array containing the family bytes.
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Specified by:
    
    getFamilyOffset in interface Cell
    
    Returns:
    Array index of first family byte
  - getFamilyLength
```
public byte getFamilyLength()
```
    Specified by:
    
    getFamilyLength in interface Cell
    
    Returns:
    Number of family bytes. Must be < familyArray.length - offset.
  - getQualifierArray
```
public byte[] getQualifierArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array.
    
    Specified by:
    
    getQualifierArray in interface Cell
    
    Returns:
    The array containing the qualifier bytes.
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Specified by:
    
    getQualifierOffset in interface Cell
    
    Returns:
    Array index of first qualifier byte
  - getQualifierLength
```
public int getQualifierLength()
```
    Specified by:
    
    getQualifierLength in interface Cell
    
    Returns:
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Cell
    
    Returns:
    Long value representing time at which this cell was "Put" into the row. Typically represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.
  - getTypeByte
```
public byte getTypeByte()
```
    Specified by:
    
    getTypeByte in interface Cell
    
    Returns:
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - getMvccVersion
```
public long getMvccVersion()
```
    Specified by:
    
    getMvccVersion in interface Cell
    
    Returns:
    mvccVersion (always >= 0 if exists), or 0 if it no longer exists
  - getSequenceId
```
public long getSequenceId()
```
    Description copied from interface: Cell
    
    A region-specific unique monotonically increasing sequence ID given to each Cell. It always exists for cells in the memstore but is not retained forever. It will be kept for HConstants.KEEP_SEQID_PERIOD days, but generally becomes irrelevant after the cell's row is no longer involved in any operations that require strict consistency.
    
    Specified by:
    
    getSequenceId in interface Cell
    
    Returns:
    seqId (always > 0 if exists), or 0 if it no longer exists
  - getValueArray
```
public byte[] getValueArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Integer.MAX_VALUE which is 2,147,483,647 bytes.
    
    Specified by:
    
    getValueArray in interface Cell
    
    Returns:
    The array containing the value bytes.
  - getValueOffset
```
public int getValueOffset()
```
    Specified by:
    
    getValueOffset in interface Cell
    
    Returns:
    Array index of first value byte
  - getValueLength
```
public int getValueLength()
```
    Specified by:
    
    getValueLength in interface Cell
    
    Returns:
    Number of value bytes. Must be < valueArray.length - offset.
  - getTagsArray
```
public byte[] getTagsArray()
```
    Specified by:
    
    getTagsArray in interface Cell
    
    Returns:
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Specified by:
    
    getTagsOffset in interface Cell
    
    Returns:
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    Specified by:
    
    getTagsLength in interface Cell
    
    Returns:
    the total length of the tags in the Cell.
  - getValue
```
@Deprecated
public byte[] getValue()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's value. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getValue in interface Cell
  - getFamily
```
@Deprecated
public byte[] getFamily()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's family. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getFamily in interface Cell
  - getQualifier
```
@Deprecated
public byte[] getQualifier()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's qualifier. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getQualifier in interface Cell
  - getRow
```
@Deprecated
public byte[] getRow()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. this gets an arraycopy of the cell's row. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getRow in interface Cell
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - shallowCopy
```
public Cell shallowCopy()
```

Class BufferedDataBlockEncoder.SeekerState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentBuffer

tagCompressionContext

valueOffset

keyLength

valueLength

lastCommonPrefix

tagsLength

tagsOffset

tagsCompressedLength

uncompressTags

keyBuffer

tagsBuffer

memstoreTS

nextKvOffset

currentKey

Constructor Detail

BufferedDataBlockEncoder.SeekerState

Method Detail

isValid

invalidate

ensureSpaceForKey

ensureSpaceForTags

setKey

copyFromNext

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getMvccVersion

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getValue

getFamily

getQualifier

getRow

toString

shallowCopy