org.apache.hadoop.hive.accumulo.columns

Enum ColumnEncoding

java.lang.Object

java.lang.Enum<ColumnEncoding>

org.apache.hadoop.hive.accumulo.columns.ColumnEncoding

All Implemented Interfaces:

Serializable, Comparable<ColumnEncoding>

public enum ColumnEncoding
extends Enum<ColumnEncoding>

Encapsulate the encoding of values within the given column in Accumulo

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY
STRING

Method Summary

Modifier and Type	Method and Description
static ColumnEncoding	fromCode(String code) Get the ColumnEncoding which has the given code.
static ColumnEncoding	fromName(String name)
static ColumnEncoding	get(String nameOrCode)
String	getCode()
static String	getColumnEncoding(String columnMapping)
static ColumnEncoding	getDefault()
static ColumnEncoding	getFromMapping(String columnMapping)
static Map.Entry<ColumnEncoding,ColumnEncoding>	getMapEncoding(String columnEncoding)
String	getName()
static boolean	hasColumnEncoding(String columnMapping) Determines if a custom encoding was specified for the give column.
static boolean	isMapEncoding(String columnEncoding)
static String	stripCode(String columnMapping) Removes the column encoding code and separator from the original column mapping string.
static ColumnEncoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColumnEncoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRING

public static final ColumnEncoding STRING

BINARY

public static final ColumnEncoding BINARY

Method Detail

values

public static ColumnEncoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ColumnEncoding c : ColumnEncoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ColumnEncoding valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

getCode

public String getCode()

fromCode

public static ColumnEncoding fromCode(String code)

Get the ColumnEncoding which has the given code.

Parameters:

code - The one-character 'code' which uniquely identifies the ColumnEncoding

Returns:

The ColumnEncoding with the code equal to the provided argument

fromName

public static ColumnEncoding fromName(String name)

get

public static ColumnEncoding get(String nameOrCode)

getFromMapping

public static ColumnEncoding getFromMapping(String columnMapping)

hasColumnEncoding

public static boolean hasColumnEncoding(String columnMapping)

Determines if a custom encoding was specified for the give column.

Parameters:

columnMapping - The mapping from Hive column to an Accumulo column

Returns:

True if the column mapping string specifies an encoding, false otherwise

getColumnEncoding

public static String getColumnEncoding(String columnMapping)

getDefault

public static ColumnEncoding getDefault()

stripCode

public static String stripCode(String columnMapping)

Removes the column encoding code and separator from the original column mapping string. Throws an IllegalArgumentException if this method is called on a string that doesn't contain a code.

Parameters:

columnMapping - The mapping from Hive column to Accumulo column

Returns:

The column mapping with the code removed

isMapEncoding

public static boolean isMapEncoding(String columnEncoding)

getMapEncoding

public static Map.Entry<ColumnEncoding,ColumnEncoding> getMapEncoding(String columnEncoding)