org.cloudgraph.store.mapping

Enum KeyFieldCodecType

java.lang.Object

java.lang.Enum<KeyFieldCodecType>

org.cloudgraph.store.mapping.KeyFieldCodecType

All Implemented Interfaces:

Serializable, Comparable<KeyFieldCodecType>

public enum KeyFieldCodecType
extends Enum<KeyFieldCodecType>

Java class for KeyFieldCodecType.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="KeyFieldCodecType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="lexicopad"/>
     <enumeration value="hash"/>
     <enumeration value="lexicohash"/>
     <enumeration value="native"/>
     <enumeration value="lexicosimple"/>
     <enumeration value="custom"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Indicates key fields are encoded with a user supplied codec.
HASH Indicates a non-lexicographic one-way hashing codec where the configured hashing algorithm is used to convert a bytes representation of the data to an integer.
LEXICOHASH Indicates a lexicographic one-way hashing codec where the configured hashing algorithm is used to convert a bytes representation of the data to an integer.
LEXICOPAD Indicates a padding codec where keys are padded to support lexicographic ordering for the particular data type.
LEXICOSIMPLE Indicates key fields of all datatypes are encoded as lexicographic strings.
NATIVE When formatting key fields, indicates to leave the data for a key field in its native data type (bytes representation) and omit any formatting rather than representing the field as a formatted string.

Method Summary

Modifier and Type	Method and Description
static KeyFieldCodecType	fromValue(String v)
String	value()
static KeyFieldCodecType	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyFieldCodecType[]	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

LEXICOPAD

public static final KeyFieldCodecType LEXICOPAD

Indicates a padding codec where keys are padded to support lexicographic ordering for the particular data type. In general String fields are rear padded and integral keys are front padded. The padding writer best facilitates lexicographic ordering as well as wildcard searches. Wildcard searches are facilitated because the field is padded up to its maximum defined capacity as required for e.g. Hbase fuzzy row-key filters. The padding formatter will cause a potentially large data size increase if the defined capacity for the field far exceeds the actual data length.

HASH

public static final KeyFieldCodecType HASH

Indicates a non-lexicographic one-way hashing codec where the configured hashing algorithm is used to convert a bytes representation of the data to an integer. The data is stored natively as a 4 byte integer representation. Fields should only be stored as hashes when lexicographic ordering is not necessary for the field.

LEXICOHASH

public static final KeyFieldCodecType LEXICOHASH

Indicates a lexicographic one-way hashing codec where the configured hashing algorithm is used to convert a bytes representation of the data to an integer. The data is stored as a string representation of the integer hash supporting lexicographic sorting and related scan operations.

NATIVE

public static final KeyFieldCodecType NATIVE

When formatting key fields, indicates to leave the data for a key field in its native data type (bytes representation) and omit any formatting rather than representing the field as a formatted string. Representing fields as string data typically supports lexicographic ordering, which is imperative for certain fields within a composite key. Fields should only be formatted as the native data type when lexicographic ordering is not necessary for the field, such as for trailing fields within a composite key which are introduced only for the purpose of uniqueness.

LEXICOSIMPLE

public static final KeyFieldCodecType LEXICOSIMPLE

Indicates key fields of all datatypes are encoded as lexicographic strings.

CUSTOM

public static final KeyFieldCodecType CUSTOM

Indicates key fields are encoded with a user supplied codec.

Method Detail

values

public static KeyFieldCodecType[] 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 (KeyFieldCodecType c : KeyFieldCodecType.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyFieldCodecType 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

value

public String value()

fromValue

public static KeyFieldCodecType fromValue(String v)