PrefixTreeBlockMeta (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.codec.prefixtree.PrefixTreeBlockMeta

```
@InterfaceAudience.Private
public class PrefixTreeBlockMeta
extends Object
```
Information about the block. Stored at the beginning of the byte[]. Contains things like minimum timestamp and width of FInts in the row tree. Most fields stored in VInts that get decoded on the first access of each new block.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allSameType`
`protected byte`	`allTypes`
`protected int`	`arrayOffset` transient fields
`protected int`	`bufferOffset`
`protected int`	`familyOffsetWidth`
`protected boolean`	`includesMvccVersion`
`static int`	`MAX_BYTES`
`static int`	`MAX_FAMILY_LENGTH`
`protected int`	`maxQualifierLength`
`protected int`	`maxRowLength`
`protected int`	`maxTagsLength`
`protected long`	`minMvccVersion`
`protected long`	`minTimestamp`
`protected int`	`mvccVersionDeltaWidth`
`protected int`	`mvccVersionIndexWidth`
`protected int`	`nextNodeOffsetWidth`
`static int`	`NUM_INTS`
`static int`	`NUM_LONGS`
`static int`	`NUM_SHORTS`
`static int`	`NUM_SINGLE_BYTES`
`protected int`	`numFamilyBytes`
`protected int`	`numKeyValueBytes`
`protected int`	`numMetaBytes`
`protected int`	`numMvccVersionBytes`
`protected int`	`numQualifierBytes`
`protected int`	`numRowBytes`
`protected int`	`numTagsBytes`
`protected int`	`numTimestampBytes`
`protected int`	`numUniqueFamilies`
`protected int`	`numUniqueQualifiers`
`protected int`	`numUniqueRows`
`protected int`	`numUniqueTags`
`protected int`	`numValueBytes`
`protected int`	`qualifierOffsetWidth`
`protected int`	`rowTreeDepth`
`protected int`	`tagsOffsetWidth`
`protected int`	`timestampDeltaWidth`
`protected int`	`timestampIndexWidth`
`protected int`	`valueLengthWidth`
`protected int`	`valueOffsetWidth`
`protected int`	`version` persisted fields
`static int`	`VERSION` static fields

Constructor Summary

Constructors
Constructor and Description

PrefixTreeBlockMeta()
constructors

PrefixTreeBlockMeta(ByteBuffer buffer)

PrefixTreeBlockMeta(InputStream is)

Constructors
Constructor and Description
`PrefixTreeBlockMeta()` constructors
`PrefixTreeBlockMeta(ByteBuffer buffer)`
`PrefixTreeBlockMeta(InputStream is)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`calculateNumMetaBytes()` operate on each field
`boolean`	`equals(Object obj)` Generated by Eclipse
`int`	`getAbsoluteFamilyOffset()`
`int`	`getAbsoluteMetaOffset()` absolute getters
`int`	`getAbsoluteMvccVersionOffset()`
`int`	`getAbsoluteQualifierOffset()`
`int`	`getAbsoluteRowOffset()`
`int`	`getAbsoluteTagsOffset()`
`int`	`getAbsoluteTimestampOffset()`
`int`	`getAbsoluteValueOffset()`
`byte`	`getAllSameTypeByte()`
`byte`	`getAllTypes()`
`int`	`getArrayOffset()`
`int`	`getBufferOffset()`
`int`	`getFamilyOffsetWidth()`
`byte`	`getIncludesMvccVersionByte()`
`int`	`getKeyValueTypeWidth()` methods
`int`	`getMaxQualifierLength()`
`int`	`getMaxRowLength()`
`int`	`getMaxTagsLength()`
`long`	`getMinMvccVersion()`
`long`	`getMinTimestamp()`
`int`	`getMvccVersionDeltaWidth()`
`int`	`getMvccVersionIndexWidth()`
`int`	`getNextNodeOffsetWidth()`
`int`	`getNumFamilyBytes()`
`int`	`getNumKeyValueBytes()`
`int`	`getNumMetaBytes()`
`int`	`getNumMvccVersionBytes()`
`int`	`getNumQualifierBytes()`
`int`	`getNumRowBytes()`
`int`	`getNumTagsBytes()`
`int`	`getNumTimestampBytes()`
`int`	`getNumUniqueFamilies()`
`int`	`getNumUniqueQualifiers()`
`int`	`getNumUniqueRows()`
`int`	`getNumUniqueTags()`
`int`	`getNumValueBytes()`
`int`	`getQualifierOffsetWidth()`
`int`	`getRowTreeDepth()`
`int`	`getTagsOffsetWidth()`
`int`	`getTimestampDeltaWidth()` get/set
`int`	`getTimestampIndexWidth()`
`int`	`getValueLengthWidth()`
`int`	`getValueOffsetWidth()`
`int`	`getVersion()`
`int`	`hashCode()` Generated by Eclipse
`void`	`initOnBlock(ByteBuffer buffer)`
`boolean`	`isAllSameMvccVersion()`
`boolean`	`isAllSameTimestamp()`
`boolean`	`isAllSameType()`
`boolean`	`isIncludesMvccVersion()`
`void`	`readVariableBytesFromArray(byte[] bytes, int offset)`
`void`	`readVariableBytesFromInputStream(InputStream is)`
`void`	`setAllSameType(boolean allSameType)`
`void`	`setAllSameType(byte allSameTypeByte)`
`void`	`setAllTypes(byte allTypes)`
`void`	`setArrayOffset(int arrayOffset)`
`void`	`setBufferOffset(int bufferOffset)`
`void`	`setFamilyOffsetWidth(int familyOffsetWidth)`
`void`	`setIncludesMvccVersion(boolean includesMvccVersion)`
`void`	`setIncludesMvccVersion(byte includesMvccVersionByte)`
`void`	`setMaxQualifierLength(int maxQualifierLength)`
`void`	`setMaxRowLength(int maxRowLength)`
`void`	`setMaxTagsLength(int maxTagLength)`
`void`	`setMinMvccVersion(long minMvccVersion)`
`void`	`setMinTimestamp(long minTimestamp)`
`void`	`setMvccVersionDeltaWidth(int mvccVersionDeltaWidth)`
`void`	`setMvccVersionFields(LongEncoder encoder)`
`void`	`setMvccVersionIndexWidth(int mvccVersionIndexWidth)`
`void`	`setNextNodeOffsetWidth(int nextNodeOffsetWidth)`
`void`	`setNumFamilyBytes(int numFamilyBytes)`
`void`	`setNumKeyValueBytes(int numKeyValueBytes)`
`void`	`setNumMetaBytes(int numMetaBytes)`
`void`	`setNumMvccVersionBytes(int numMvccVersionBytes)`
`void`	`setNumQualifierBytes(int numQualifierBytes)`
`void`	`setNumRowBytes(int numRowBytes)`
`void`	`setNumTagsBytes(int numTagBytes)`
`void`	`setNumTimestampBytes(int numTimestampBytes)`
`void`	`setNumUniqueFamilies(int numUniqueFamilies)`
`void`	`setNumUniqueQualifiers(int numUniqueQualifiers)`
`void`	`setNumUniqueRows(int numUniqueRows)`
`void`	`setNumUniqueTags(int numUniqueTags)`
`void`	`setNumValueBytes(int numValueBytes)`
`void`	`setQualifierOffsetWidth(int qualifierOffsetWidth)`
`void`	`setRowTreeDepth(int rowTreeDepth)`
`void`	`setTagsOffsetWidth(int dataOffsetWidth)`
`void`	`setTimestampDeltaWidth(int timestampDeltaWidth)`
`void`	`setTimestampFields(LongEncoder encoder)`
`void`	`setTimestampIndexWidth(int timestampIndexWidth)`
`void`	`setValueLengthWidth(int dataLengthWidth)`
`void`	`setValueOffsetWidth(int dataOffsetWidth)`
`void`	`setVersion(int version)`
`String`	`toString()` Generated by Eclipse
`void`	`writeVariableBytesToOutputStream(OutputStream os)`

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

Field Detail

VERSION
```
public static final int VERSION
```
static fields

See Also:
Constant Field Values

MAX_FAMILY_LENGTH
```
public static final int MAX_FAMILY_LENGTH
```
See Also:
Constant Field Values

NUM_LONGS
```
public static final int NUM_LONGS
```
See Also:
Constant Field Values

NUM_INTS
```
public static final int NUM_INTS
```
See Also:
Constant Field Values

NUM_SHORTS
```
public static final int NUM_SHORTS
```
See Also:
Constant Field Values

NUM_SINGLE_BYTES
```
public static final int NUM_SINGLE_BYTES
```
See Also:
Constant Field Values

MAX_BYTES
```
public static final int MAX_BYTES
```
See Also:
Constant Field Values

arrayOffset
```
protected int arrayOffset
```
transient fields

bufferOffset
```
protected int bufferOffset
```

version
```
protected int version
```
persisted fields

numMetaBytes
```
protected int numMetaBytes
```

numKeyValueBytes
```
protected int numKeyValueBytes
```

includesMvccVersion
```
protected boolean includesMvccVersion
```

numRowBytes
```
protected int numRowBytes
```

numFamilyBytes
```
protected int numFamilyBytes
```

numQualifierBytes
```
protected int numQualifierBytes
```

numTimestampBytes
```
protected int numTimestampBytes
```

numMvccVersionBytes
```
protected int numMvccVersionBytes
```

numValueBytes
```
protected int numValueBytes
```

numTagsBytes
```
protected int numTagsBytes
```

nextNodeOffsetWidth
```
protected int nextNodeOffsetWidth
```

familyOffsetWidth
```
protected int familyOffsetWidth
```

qualifierOffsetWidth
```
protected int qualifierOffsetWidth
```

timestampIndexWidth
```
protected int timestampIndexWidth
```

mvccVersionIndexWidth
```
protected int mvccVersionIndexWidth
```

valueOffsetWidth
```
protected int valueOffsetWidth
```

valueLengthWidth
```
protected int valueLengthWidth
```

tagsOffsetWidth
```
protected int tagsOffsetWidth
```

rowTreeDepth
```
protected int rowTreeDepth
```

maxRowLength
```
protected int maxRowLength
```

maxQualifierLength
```
protected int maxQualifierLength
```

maxTagsLength
```
protected int maxTagsLength
```

minTimestamp
```
protected long minTimestamp
```

timestampDeltaWidth
```
protected int timestampDeltaWidth
```

minMvccVersion
```
protected long minMvccVersion
```

mvccVersionDeltaWidth
```
protected int mvccVersionDeltaWidth
```

allSameType
```
protected boolean allSameType
```

allTypes
```
protected byte allTypes
```

numUniqueRows
```
protected int numUniqueRows
```

numUniqueFamilies
```
protected int numUniqueFamilies
```

numUniqueQualifiers
```
protected int numUniqueQualifiers
```

numUniqueTags
```
protected int numUniqueTags
```

Constructor Detail

PrefixTreeBlockMeta
```
public PrefixTreeBlockMeta()
```
constructors

PrefixTreeBlockMeta

public PrefixTreeBlockMeta(InputStream is)
                    throws IOException

Throws:: IOException

PrefixTreeBlockMeta
```
public PrefixTreeBlockMeta(ByteBuffer buffer)
```
Parameters:
buffer - positioned at start of PtBlockMeta

Method Detail

initOnBlock

public void initOnBlock(ByteBuffer buffer)

calculateNumMetaBytes
```
public int calculateNumMetaBytes()
```
operate on each field

writeVariableBytesToOutputStream

public void writeVariableBytesToOutputStream(OutputStream os)
                                      throws IOException

Throws:: IOException

readVariableBytesFromInputStream

public void readVariableBytesFromInputStream(InputStream is)
                                      throws IOException

Throws:: IOException

readVariableBytesFromArray

public void readVariableBytesFromArray(byte[] bytes,
                              int offset)

getKeyValueTypeWidth
```
public int getKeyValueTypeWidth()
```
methods

getIncludesMvccVersionByte

public byte getIncludesMvccVersionByte()

setIncludesMvccVersion

public void setIncludesMvccVersion(byte includesMvccVersionByte)

getAllSameTypeByte
```
public byte getAllSameTypeByte()
```

setAllSameType

public void setAllSameType(byte allSameTypeByte)

isAllSameTimestamp
```
public boolean isAllSameTimestamp()
```

isAllSameMvccVersion
```
public boolean isAllSameMvccVersion()
```

setTimestampFields

public void setTimestampFields(LongEncoder encoder)

setMvccVersionFields

public void setMvccVersionFields(LongEncoder encoder)

equals
```
public boolean equals(Object obj)
```
Generated by Eclipse

Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Generated by Eclipse

Overrides:

hashCode in class Object

toString
```
public String toString()
```
Generated by Eclipse

Overrides:

toString in class Object

getAbsoluteMetaOffset
```
public int getAbsoluteMetaOffset()
```
absolute getters

getAbsoluteRowOffset
```
public int getAbsoluteRowOffset()
```

getAbsoluteFamilyOffset
```
public int getAbsoluteFamilyOffset()
```

getAbsoluteQualifierOffset

public int getAbsoluteQualifierOffset()

getAbsoluteTagsOffset
```
public int getAbsoluteTagsOffset()
```

getAbsoluteTimestampOffset

public int getAbsoluteTimestampOffset()

getAbsoluteMvccVersionOffset

public int getAbsoluteMvccVersionOffset()

getAbsoluteValueOffset
```
public int getAbsoluteValueOffset()
```

getTimestampDeltaWidth
```
public int getTimestampDeltaWidth()
```
get/set

setTimestampDeltaWidth

public void setTimestampDeltaWidth(int timestampDeltaWidth)

getValueOffsetWidth
```
public int getValueOffsetWidth()
```

getTagsOffsetWidth
```
public int getTagsOffsetWidth()
```

setValueOffsetWidth

public void setValueOffsetWidth(int dataOffsetWidth)

setTagsOffsetWidth

public void setTagsOffsetWidth(int dataOffsetWidth)

getValueLengthWidth
```
public int getValueLengthWidth()
```

setValueLengthWidth

public void setValueLengthWidth(int dataLengthWidth)

getMaxRowLength
```
public int getMaxRowLength()
```

setMaxRowLength

public void setMaxRowLength(int maxRowLength)

getMinTimestamp
```
public long getMinTimestamp()
```

setMinTimestamp

public void setMinTimestamp(long minTimestamp)

getAllTypes
```
public byte getAllTypes()
```

setAllTypes

public void setAllTypes(byte allTypes)

isAllSameType
```
public boolean isAllSameType()
```

setAllSameType

public void setAllSameType(boolean allSameType)

getNextNodeOffsetWidth
```
public int getNextNodeOffsetWidth()
```

setNextNodeOffsetWidth

public void setNextNodeOffsetWidth(int nextNodeOffsetWidth)

getNumRowBytes
```
public int getNumRowBytes()
```

setNumRowBytes

public void setNumRowBytes(int numRowBytes)

getNumTimestampBytes
```
public int getNumTimestampBytes()
```

setNumTimestampBytes

public void setNumTimestampBytes(int numTimestampBytes)

getNumValueBytes
```
public int getNumValueBytes()
```

getNumTagsBytes
```
public int getNumTagsBytes()
```

setNumTagsBytes

public void setNumTagsBytes(int numTagBytes)

setNumValueBytes

public void setNumValueBytes(int numValueBytes)

getNumMetaBytes
```
public int getNumMetaBytes()
```

setNumMetaBytes

public void setNumMetaBytes(int numMetaBytes)

getArrayOffset
```
public int getArrayOffset()
```

setArrayOffset

public void setArrayOffset(int arrayOffset)

getBufferOffset
```
public int getBufferOffset()
```

setBufferOffset

public void setBufferOffset(int bufferOffset)

getNumKeyValueBytes
```
public int getNumKeyValueBytes()
```

setNumKeyValueBytes

public void setNumKeyValueBytes(int numKeyValueBytes)

getRowTreeDepth
```
public int getRowTreeDepth()
```

setRowTreeDepth

public void setRowTreeDepth(int rowTreeDepth)

getNumMvccVersionBytes
```
public int getNumMvccVersionBytes()
```

setNumMvccVersionBytes

public void setNumMvccVersionBytes(int numMvccVersionBytes)

getMvccVersionDeltaWidth
```
public int getMvccVersionDeltaWidth()
```

setMvccVersionDeltaWidth

public void setMvccVersionDeltaWidth(int mvccVersionDeltaWidth)

getMinMvccVersion
```
public long getMinMvccVersion()
```

setMinMvccVersion

public void setMinMvccVersion(long minMvccVersion)

getNumFamilyBytes
```
public int getNumFamilyBytes()
```

setNumFamilyBytes

public void setNumFamilyBytes(int numFamilyBytes)

getFamilyOffsetWidth
```
public int getFamilyOffsetWidth()
```

setFamilyOffsetWidth

public void setFamilyOffsetWidth(int familyOffsetWidth)

getNumUniqueRows
```
public int getNumUniqueRows()
```

setNumUniqueRows

public void setNumUniqueRows(int numUniqueRows)

getNumUniqueFamilies
```
public int getNumUniqueFamilies()
```

setNumUniqueFamilies

public void setNumUniqueFamilies(int numUniqueFamilies)

getNumUniqueQualifiers
```
public int getNumUniqueQualifiers()
```

setNumUniqueQualifiers

public void setNumUniqueQualifiers(int numUniqueQualifiers)

setNumUniqueTags

public void setNumUniqueTags(int numUniqueTags)

getNumUniqueTags
```
public int getNumUniqueTags()
```

getNumQualifierBytes
```
public int getNumQualifierBytes()
```

setNumQualifierBytes

public void setNumQualifierBytes(int numQualifierBytes)

getQualifierOffsetWidth
```
public int getQualifierOffsetWidth()
```

setQualifierOffsetWidth

public void setQualifierOffsetWidth(int qualifierOffsetWidth)

getMaxQualifierLength
```
public int getMaxQualifierLength()
```

setMaxQualifierLength

public void setMaxQualifierLength(int maxQualifierLength)

getMaxTagsLength
```
public int getMaxTagsLength()
```

setMaxTagsLength

public void setMaxTagsLength(int maxTagLength)

getTimestampIndexWidth
```
public int getTimestampIndexWidth()
```

setTimestampIndexWidth

public void setTimestampIndexWidth(int timestampIndexWidth)

getMvccVersionIndexWidth
```
public int getMvccVersionIndexWidth()
```

setMvccVersionIndexWidth

public void setMvccVersionIndexWidth(int mvccVersionIndexWidth)

getVersion
```
public int getVersion()
```

setVersion
```
public void setVersion(int version)
```

isIncludesMvccVersion

public boolean isIncludesMvccVersion()

setIncludesMvccVersion

public void setIncludesMvccVersion(boolean includesMvccVersion)

Class PrefixTreeBlockMeta

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

MAX_FAMILY_LENGTH

NUM_LONGS

NUM_INTS

NUM_SHORTS

NUM_SINGLE_BYTES

MAX_BYTES

arrayOffset

bufferOffset

version

numMetaBytes

numKeyValueBytes

includesMvccVersion

numRowBytes

numFamilyBytes

numQualifierBytes

numTimestampBytes

numMvccVersionBytes

numValueBytes

numTagsBytes

nextNodeOffsetWidth

familyOffsetWidth

qualifierOffsetWidth

timestampIndexWidth

mvccVersionIndexWidth

valueOffsetWidth

valueLengthWidth

tagsOffsetWidth

rowTreeDepth

maxRowLength

maxQualifierLength

maxTagsLength

minTimestamp

timestampDeltaWidth

minMvccVersion

mvccVersionDeltaWidth

allSameType

allTypes

numUniqueRows

numUniqueFamilies

numUniqueQualifiers

numUniqueTags

Constructor Detail

PrefixTreeBlockMeta

PrefixTreeBlockMeta

PrefixTreeBlockMeta

Method Detail

initOnBlock

calculateNumMetaBytes

writeVariableBytesToOutputStream

readVariableBytesFromInputStream

readVariableBytesFromArray

getKeyValueTypeWidth

getIncludesMvccVersionByte

setIncludesMvccVersion

getAllSameTypeByte

setAllSameType

isAllSameTimestamp

isAllSameMvccVersion

setTimestampFields

setMvccVersionFields

equals

hashCode

toString

getAbsoluteMetaOffset

getAbsoluteRowOffset

getAbsoluteFamilyOffset

getAbsoluteQualifierOffset

getAbsoluteTagsOffset

getAbsoluteTimestampOffset

getAbsoluteMvccVersionOffset

getAbsoluteValueOffset

getTimestampDeltaWidth

setTimestampDeltaWidth