org.datanucleus.store.hbase

Class HBaseUtils

java.lang.Object

org.datanucleus.store.hbase.HBaseUtils

public class HBaseUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.datanucleus.util.Localiser	LOCALISER Localiser for messages.

Constructor Summary

Constructors

Constructor and Description
HBaseUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getDefaultValueForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd) Accessor for the default value specified for the provided member.
static org.apache.hadoop.hbase.client.Delete	getDeleteForObject(org.datanucleus.state.ObjectProvider op)
static String	getFamilyName(org.datanucleus.metadata.AbstractClassMetaData acmd, int absoluteFieldNumber, String tableName) Accessor for the HBase family name for this field.
static String	getFamilyName(org.datanucleus.metadata.AbstractMemberMetaData mmd, int fieldNumber, String tableName) Accessor for the HBase family name for the field of the embedded field.
static String	getFamilyNameForColumnName(String colName, String tableName) Accessor for the family name for a column name.
static org.apache.hadoop.hbase.client.Get	getGetForObject(org.datanucleus.state.ObjectProvider op)
static org.apache.hadoop.hbase.client.Put	getPutForObject(org.datanucleus.state.ObjectProvider op)
static String	getQualifierName(org.datanucleus.metadata.AbstractClassMetaData acmd, int absoluteFieldNumber) Accessor for the HBase qualifier name for this field.
static String	getQualifierName(org.datanucleus.metadata.AbstractMemberMetaData mmd, int fieldNumber) Accessor for the HBase qualifier name for the field of this embedded field.
static String	getQualifierNameForColumnName(String colName) Accessor for the qualifier name for a column name.
static org.apache.hadoop.hbase.client.Result	getResultForObject(org.datanucleus.state.ObjectProvider op, org.apache.hadoop.hbase.client.HTableInterface table)
static Object	getSurrogateVersionForObject(org.datanucleus.metadata.AbstractClassMetaData cmd, org.apache.hadoop.hbase.client.Result result, String tableName, org.datanucleus.store.StoreManager storeMgr) Convenience method that extracts the surrogate version for a class of the specified type from the passed Result.
static Object	getVersionForObject(org.datanucleus.metadata.AbstractClassMetaData cmd, org.apache.hadoop.hbase.client.Result result, org.datanucleus.ExecutionContext ec, String tableName, org.datanucleus.store.StoreManager storeMgr) Convenience method that extracts the version for a class of the specified type from the passed Result.
static boolean	objectExistsInTable(org.datanucleus.state.ObjectProvider op, org.apache.hadoop.hbase.client.HTableInterface table)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final org.datanucleus.util.Localiser LOCALISER

Localiser for messages.

Constructor Detail

HBaseUtils

public HBaseUtils()

Method Detail

getDefaultValueForMember

public static String getDefaultValueForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Accessor for the default value specified for the provided member. If no defaultValue is provided on the column then returns null.

Parameters:

mmd - Metadata for the member

Returns:

The default value

getFamilyNameForColumnName

public static String getFamilyNameForColumnName(String colName,
                                String tableName)

Accessor for the family name for a column name. If the column name is of the form "family:qualifier" then returns family, otherwise returns the table name.

Parameters:

colName - Column name

tableName - The table name

Returns:

The family name for this column

getQualifierNameForColumnName

public static String getQualifierNameForColumnName(String colName)

Accessor for the qualifier name for a column name. If the column name is of the form "family:qualifier" then returns qualifier, otherwise returns the column name.

Parameters:

colName - Column name

Returns:

The qualifier name for this column

getFamilyName

public static String getFamilyName(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                   int fieldNumber,
                   String tableName)

Accessor for the HBase family name for the field of the embedded field. Extracts the family name using the following priorities

• If column is specified as "a:b" then takes "a" as the family name.
• Otherwise takes table name as the family name

Parameters:

mmd - Metadata for the embedded field

fieldNumber - Number of the field in the embedded object

Returns:

The family name

getQualifierName

public static String getQualifierName(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                      int fieldNumber)

Accessor for the HBase qualifier name for the field of this embedded field. Extracts the qualifier name using the following priorities

• If column is specified as "a:b" then takes "b" as the qualifier name.
• Otherwise takes the column name as the qualifier name when it is specified
• Otherwise takes "VERSION" as the qualifier name

Parameters:

mmd - Metadata for the owning member

fieldNumber - Member number of the embedded object

Returns:

The qualifier name

getFamilyName

public static String getFamilyName(org.datanucleus.metadata.AbstractClassMetaData acmd,
                   int absoluteFieldNumber,
                   String tableName)

Accessor for the HBase family name for this field. Extracts the family name using the following priorities

• If column is specified as "a:b" then takes "a" as the family name.
• Otherwise takes the table name as the family name

Parameters:

acmd - Metadata for the class

absoluteFieldNumber - Field number

Returns:

The family name

getQualifierName

public static String getQualifierName(org.datanucleus.metadata.AbstractClassMetaData acmd,
                      int absoluteFieldNumber)

Accessor for the HBase qualifier name for this field. Extracts the qualifier name using the following priorities

• If column is specified as "a:b" then takes "b" as the qualifier name.
• Otherwise takes the column name as the qualifier name when it is specified
• Otherwise takes the field name as the qualifier name

Parameters:

acmd - Metadata for the class

absoluteFieldNumber - Field number

Returns:

The qualifier name

getVersionForObject

public static Object getVersionForObject(org.datanucleus.metadata.AbstractClassMetaData cmd,
                         org.apache.hadoop.hbase.client.Result result,
                         org.datanucleus.ExecutionContext ec,
                         String tableName,
                         org.datanucleus.store.StoreManager storeMgr)

Convenience method that extracts the version for a class of the specified type from the passed Result.

Parameters:

cmd - Metadata for the class

result - The result

ec - ExecutionContext

tableName - Name of the table

Returns:

The version

getSurrogateVersionForObject

public static Object getSurrogateVersionForObject(org.datanucleus.metadata.AbstractClassMetaData cmd,
                                  org.apache.hadoop.hbase.client.Result result,
                                  String tableName,
                                  org.datanucleus.store.StoreManager storeMgr)

Convenience method that extracts the surrogate version for a class of the specified type from the passed Result.

Parameters:

cmd - Metadata for the class

result - The result

tableName - Name of the table

Returns:

The surrogate version

getPutForObject

public static org.apache.hadoop.hbase.client.Put getPutForObject(org.datanucleus.state.ObjectProvider op)
                                                          throws IOException

Throws:

IOException

getDeleteForObject

public static org.apache.hadoop.hbase.client.Delete getDeleteForObject(org.datanucleus.state.ObjectProvider op)
                                                                throws IOException

Throws:

IOException

getGetForObject

public static org.apache.hadoop.hbase.client.Get getGetForObject(org.datanucleus.state.ObjectProvider op)
                                                          throws IOException

Throws:

IOException

getResultForObject

public static org.apache.hadoop.hbase.client.Result getResultForObject(org.datanucleus.state.ObjectProvider op,
                                                       org.apache.hadoop.hbase.client.HTableInterface table)
                                                                throws IOException

Throws:

IOException

objectExistsInTable

public static boolean objectExistsInTable(org.datanucleus.state.ObjectProvider op,
                          org.apache.hadoop.hbase.client.HTableInterface table)
                                   throws IOException

Throws:

IOException