org.apache.omid.transaction

Class CellUtils

java.lang.Object

org.apache.omid.transaction.CellUtils

public final class CellUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_GET_ATTRIBUTE
static byte[]	FAMILY_DELETE_QUALIFIER
static String	LL_ATTRIBUTE
static String	TRANSACTION_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CellUtils()

Method Summary

Modifier and Type	Method and Description
static byte[]	addShadowCellSuffixPrefix(byte[] qualifier) Builds a new qualifier composed of the HBase qualifier passed + the shadow cell suffix.
static byte[]	addShadowCellSuffixPrefix(byte[] qualifierArray, int qualOffset, int qualLength) Builds a new qualifier composed of the HBase qualifier passed + the shadow cell suffix.
static org.apache.hadoop.hbase.Cell	buildShadowCellFromCell(org.apache.hadoop.hbase.Cell cell, byte[] shadowCellValue) Returns a new shadow cell created from a particular cell.
static boolean	hasCell(byte[] row, byte[] family, byte[] qualifier, long version, org.apache.omid.transaction.CellUtils.CellGetter cellGetter) Returns true if the particular cell passed exists in the datastore.
static boolean	hasShadowCell(byte[] row, byte[] family, byte[] qualifier, long version, org.apache.omid.transaction.CellUtils.CellGetter cellGetter) Returns true if the particular cell passed has a corresponding shadow cell in the datastore
static boolean	isFamilyDeleteCell(org.apache.hadoop.hbase.Cell cell) Returns whether a cell contains a qualifier that is a delete cell column qualifier or not.
static boolean	isShadowCell(org.apache.hadoop.hbase.Cell cell) Returns whether a cell contains a qualifier that is a shadow cell column qualifier or not.
static boolean	isTombstone(org.apache.hadoop.hbase.Cell cell) Returns if a cell is marked as a tombstone.
static SortedMap<org.apache.hadoop.hbase.Cell,org.apache.phoenix.thirdparty.com.google.common.base.Optional<org.apache.hadoop.hbase.Cell>>	mapCellsToShadowCells(List<org.apache.hadoop.hbase.Cell> cells) Analyzes a list of cells, associating the corresponding shadow cell if present.
static boolean	matchingQualifier(org.apache.hadoop.hbase.Cell left, byte[] qualArray, int qualOffset, int qualLen) Complement to matchingQualifier() methods in HBase's CellUtil.class
static int	qualifierLengthFromShadowCellQualifier(byte[] qualifier, int qualOffset, int qualLength) Returns the qualifier length removing the shadow cell suffix and prefix.
static int	qualifierOffsetFromShadowCellQualifier(byte[] qualifier, int qualOffset, int qualLength) Returns the qualifier length removing the shadow cell suffix and prefix.
static byte[]	removeShadowCellSuffixPrefix(byte[] qualifier, int qualOffset, int qualLength) Builds a new qualifier removing the shadow cell suffix from the passed HBase qualifier.
static void	validateCell(org.apache.hadoop.hbase.Cell cell, long startTimestamp) Check that the cell passed meets the requirements for a valid cell identifier with Omid.

Methods inherited from class java.lang.Object

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

Field Detail

FAMILY_DELETE_QUALIFIER

public static final byte[] FAMILY_DELETE_QUALIFIER

TRANSACTION_ATTRIBUTE

public static final String TRANSACTION_ATTRIBUTE

See Also:

Constant Field Values

CLIENT_GET_ATTRIBUTE

public static final String CLIENT_GET_ATTRIBUTE

See Also:

Constant Field Values

LL_ATTRIBUTE

public static final String LL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

CellUtils

public CellUtils()

Method Detail

hasCell

public static boolean hasCell(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              long version,
                              org.apache.omid.transaction.CellUtils.CellGetter cellGetter)
                       throws IOException

Returns true if the particular cell passed exists in the datastore.

Parameters:

row - row

family - column family

qualifier - columnn name

version - version

cellGetter - an instance of CellGetter

Returns:

true if the cell specified exists. false otherwise

Throws:

IOException

hasShadowCell

public static boolean hasShadowCell(byte[] row,
                                    byte[] family,
                                    byte[] qualifier,
                                    long version,
                                    org.apache.omid.transaction.CellUtils.CellGetter cellGetter)
                             throws IOException

Returns true if the particular cell passed has a corresponding shadow cell in the datastore

Parameters:

row - row

family - column family

qualifier - columnn name

version - version

cellGetter - an instance of CellGetter

Returns:

true if it has a shadow cell. false otherwise.

Throws:

IOException

addShadowCellSuffixPrefix

public static byte[] addShadowCellSuffixPrefix(byte[] qualifierArray,
                                               int qualOffset,
                                               int qualLength)

Builds a new qualifier composed of the HBase qualifier passed + the shadow cell suffix.

Parameters:

qualifierArray - the qualifier to be suffixed

qualOffset - the offset where the qualifier starts

qualLength - the qualifier length

Returns:

the suffixed qualifier

addShadowCellSuffixPrefix

public static byte[] addShadowCellSuffixPrefix(byte[] qualifier)

Builds a new qualifier composed of the HBase qualifier passed + the shadow cell suffix. Contains a reduced signature to avoid boilerplate code in client side.

Parameters:

qualifier - the qualifier to be suffixed

Returns:

the suffixed qualifier

removeShadowCellSuffixPrefix

public static byte[] removeShadowCellSuffixPrefix(byte[] qualifier,
                                                  int qualOffset,
                                                  int qualLength)

Builds a new qualifier removing the shadow cell suffix from the passed HBase qualifier.

Parameters:

qualifier - the qualifier to remove the suffix from

qualOffset - the offset where the qualifier starts

qualLength - the qualifier length

Returns:

the new qualifier without the suffix

qualifierLengthFromShadowCellQualifier

public static int qualifierLengthFromShadowCellQualifier(byte[] qualifier,
                                                         int qualOffset,
                                                         int qualLength)

Returns the qualifier length removing the shadow cell suffix and prefix. In case that que suffix is not found, just returns the length of the qualifier passed.

Parameters:

qualifier - the qualifier to remove the suffix from

qualOffset - the offset where the qualifier starts

qualLength - the qualifier length

Returns:

the qualifier length without the suffix

qualifierOffsetFromShadowCellQualifier

public static int qualifierOffsetFromShadowCellQualifier(byte[] qualifier,
                                                         int qualOffset,
                                                         int qualLength)

Returns the qualifier length removing the shadow cell suffix and prefix. In case that que suffix is not found, just returns the length of the qualifier passed.

Parameters:

qualifier - the qualifier to remove the suffix from

qualOffset - the offset where the qualifier starts

qualLength - the qualifier length

Returns:

the qualifier length without the suffix

matchingQualifier

public static boolean matchingQualifier(org.apache.hadoop.hbase.Cell left,
                                        byte[] qualArray,
                                        int qualOffset,
                                        int qualLen)

Complement to matchingQualifier() methods in HBase's CellUtil.class

Parameters:

left - the cell to compare the qualifier

qualArray - the explicit qualifier array passed

qualOffset - the explicit qualifier offset passed

qualLen - the explicit qualifier length passed

Returns:

whether the qualifiers are equal or not

validateCell

public static void validateCell(org.apache.hadoop.hbase.Cell cell,
                                long startTimestamp)

Check that the cell passed meets the requirements for a valid cell identifier with Omid. Basically, users can't: 1) specify a timestamp 2) use a particular suffix in the qualifier

isFamilyDeleteCell

public static boolean isFamilyDeleteCell(org.apache.hadoop.hbase.Cell cell)

Returns whether a cell contains a qualifier that is a delete cell column qualifier or not.

Parameters:

cell - the cell to check if contains the delete cell qualifier

Returns:

whether the cell passed contains a delete cell qualifier or not

isShadowCell

public static boolean isShadowCell(org.apache.hadoop.hbase.Cell cell)

Returns whether a cell contains a qualifier that is a shadow cell column qualifier or not.

Parameters:

cell - the cell to check if contains the shadow cell qualifier

Returns:

whether the cell passed contains a shadow cell qualifier or not

isTombstone

public static boolean isTombstone(org.apache.hadoop.hbase.Cell cell)

Returns if a cell is marked as a tombstone.

Parameters:

cell - the cell to check

Returns:

whether the cell is marked as a tombstone or not

buildShadowCellFromCell

public static org.apache.hadoop.hbase.Cell buildShadowCellFromCell(org.apache.hadoop.hbase.Cell cell,
                                                                   byte[] shadowCellValue)

Returns a new shadow cell created from a particular cell.

Parameters:

cell - the cell to reconstruct the shadow cell from.

shadowCellValue - the value for the new shadow cell created

Returns:

the brand-new shadow cell

mapCellsToShadowCells

public static SortedMap<org.apache.hadoop.hbase.Cell,org.apache.phoenix.thirdparty.com.google.common.base.Optional<org.apache.hadoop.hbase.Cell>> mapCellsToShadowCells(List<org.apache.hadoop.hbase.Cell> cells)

Analyzes a list of cells, associating the corresponding shadow cell if present.

Parameters:

cells - the list of cells to classify

Returns:

a sorted map associating each cell with its shadow cell