com.google.cloud.bigtable.hbase.adapters.admin

Class ColumnDescriptorAdapter

java.lang.Object

com.google.cloud.bigtable.hbase.adapters.admin.ColumnDescriptorAdapter

@InternalApi(value="For internal usage only")
public class ColumnDescriptorAdapter
extends Object

Adapt a single instance of an HBase HColumnDescriptor to an instance of ColumnFamily

For internal use only - public for technical reasons.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	IGNORED_OPTION_KEYS Configuration keys that we ignore unconditionally
static ColumnDescriptorAdapter	INSTANCE
static Set<String>	SUPPORTED_OPTION_KEYS Configuration keys that we can support unconditionally and we provide a mapped version of the column descriptor to Bigtable.
static Map<String,String>	SUPPORTED_OPTION_VALUES Configuration option values that we ignore as long as the value is the one specified below.

Constructor Summary

Constructors

Constructor and Description
ColumnDescriptorAdapter()

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.hbase.HColumnDescriptor	adapt(com.google.cloud.bigtable.admin.v2.models.ColumnFamily columnFamily) Convert a Bigtable ColumnFamily to an HBase HColumnDescriptor.
com.google.bigtable.admin.v2.ColumnFamily	adapt(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Adapt a single instance of an HBase HColumnDescriptor to an instance of ColumnFamily.Builder.
static com.google.cloud.bigtable.admin.v2.models.GCRules.GCRule	buildGarbageCollectionRule(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Construct an Bigtable GCRules.GCRule from the given column descriptor.
static List<String>	getUnknownFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Build a list of configuration keys that we don't know how to handle
static Map<String,String>	getUnsupportedFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Build a Map of configuration keys and values describing configuration values we don't support.
protected static void	processIntersection(com.google.bigtable.admin.v2.GcRule gcRule, org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) processIntersection.
static void	throwIfRequestingUnknownFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Throw an UnsupportedOperationException if the column descriptor cannot be adapted due to it having unknown configuration keys.
static void	throwIfRequestingUnsupportedFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor) Throw an UnsupportedOperationException if the column descriptor cannot be adapted due to it having configuration values that are not supported.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ColumnDescriptorAdapter INSTANCE

SUPPORTED_OPTION_KEYS

public static final Set<String> SUPPORTED_OPTION_KEYS

Configuration keys that we can support unconditionally and we provide a mapped version of the column descriptor to Bigtable.

IGNORED_OPTION_KEYS

public static final Set<String> IGNORED_OPTION_KEYS

Configuration keys that we ignore unconditionally

SUPPORTED_OPTION_VALUES

public static final Map<String,String> SUPPORTED_OPTION_VALUES

Configuration option values that we ignore as long as the value is the one specified below. Any other value results in an exception.

Constructor Detail

ColumnDescriptorAdapter

public ColumnDescriptorAdapter()

Method Detail

getUnknownFeatures

public static List<String> getUnknownFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Build a list of configuration keys that we don't know how to handle

Parameters:

columnDescriptor - a HColumnDescriptor object.

Returns:

a List object.

getUnsupportedFeatures

public static Map<String,String> getUnsupportedFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Build a Map of configuration keys and values describing configuration values we don't support.

Parameters:

columnDescriptor - a HColumnDescriptor object.

Returns:

a Map object.

throwIfRequestingUnknownFeatures

public static void throwIfRequestingUnknownFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Throw an UnsupportedOperationException if the column descriptor cannot be adapted due to it having unknown configuration keys.

Parameters:

columnDescriptor - a HColumnDescriptor object.

throwIfRequestingUnsupportedFeatures

public static void throwIfRequestingUnsupportedFeatures(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Throw an UnsupportedOperationException if the column descriptor cannot be adapted due to it having configuration values that are not supported.

Parameters:

columnDescriptor - a HColumnDescriptor object.

buildGarbageCollectionRule

public static com.google.cloud.bigtable.admin.v2.models.GCRules.GCRule buildGarbageCollectionRule(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Construct an Bigtable GCRules.GCRule from the given column descriptor.

Parameters:

columnDescriptor - a HColumnDescriptor object.

Returns:

a GCRules.GCRule object.

processIntersection

protected static void processIntersection(com.google.bigtable.admin.v2.GcRule gcRule,
                                          org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

processIntersection.

Parameters:

gcRule - a GcRule object.

columnDescriptor - a HColumnDescriptor object.

adapt

public com.google.bigtable.admin.v2.ColumnFamily adapt(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

Adapt a single instance of an HBase HColumnDescriptor to an instance of ColumnFamily.Builder.

NOTE: This method does not set the name of the ColumnFamily.Builder. The assumption is that the CreateTableRequest or CreateColumnFamilyRequest takes care of the naming. As of now (3/11/2015), the server insists on having a blank name.

Parameters:

columnDescriptor - a HColumnDescriptor object.

Returns:

a ColumnFamily.Builder object.

adapt

public org.apache.hadoop.hbase.HColumnDescriptor adapt(com.google.cloud.bigtable.admin.v2.models.ColumnFamily columnFamily)

Convert a Bigtable ColumnFamily to an HBase HColumnDescriptor. See convertGarbageCollectionRule(GcRule, HColumnDescriptor) for more info.

Parameters:

columnFamily - a ColumnFamily object.

Returns:

a HColumnDescriptor object.