org.apache.hadoop.hive.hbase

Class HBaseCompositeKey

java.lang.Object

org.apache.hadoop.hive.serde2.lazy.LazyObject<OI>

org.apache.hadoop.hive.serde2.lazy.LazyNonPrimitive<LazySimpleStructObjectInspector>

org.apache.hadoop.hive.serde2.lazy.LazyStruct

org.apache.hadoop.hive.hbase.HBaseCompositeKey

All Implemented Interfaces:

LazyObjectBase, SerDeStatsStruct, StructObject

public class HBaseCompositeKey
extends LazyStruct

HBaseCompositeKey extension of LazyStruct. All complex composite keys should extend this class and override the LazyStruct.getField(int) method where fieldID corresponds to the ID of a key in the composite key.

For example, for a composite key "/part1/part2/part3", part1 will have an id 0, part2 will have an id 1 and part3 will have an id 2. Custom implementations of getField(fieldID) should return the value corresponding to that fieldID. So, for the above example, the value returned for getField(0) should be part1, getField(1) should be part2 and getField(2) should be part3.

All custom implementation are expected to have a constructor of the form:

 MyCustomCompositeKey(LazySimpleStructObjectInspector oi, Properties tbl, Configuration conf)
 

Field Summary

Fields inherited from class org.apache.hadoop.hive.serde2.lazy.LazyNonPrimitive

bytes, length, start

Fields inherited from class org.apache.hadoop.hive.serde2.lazy.LazyObject

isNull, oi

Constructor Summary

Constructors

Constructor and Description
HBaseCompositeKey(LazySimpleStructObjectInspector oi)

Method Summary

Methods

Modifier and Type	Method and Description
ArrayList<Object>	getFieldsAsList() Get the values of the fields as an ArrayList.
Map<String,String>	getParts() Return the different parts of the key.
LazyObject<? extends ObjectInspector>	toLazyObject(int fieldID, byte[] bytes) Create an initialize a LazyObject with the given bytes for the given fieldID.

Methods inherited from class org.apache.hadoop.hive.serde2.lazy.LazyStruct

createLazyField, getBytes, getField, getFieldInited, getFields, getParsed, getRawDataSerializedSize, init, initLazyFields, parseMultiDelimit, setFieldInited, setFields, setParsed

Methods inherited from class org.apache.hadoop.hive.serde2.lazy.LazyNonPrimitive

hashCode, isNull, isNull

Methods inherited from class org.apache.hadoop.hive.serde2.lazy.LazyObject

getInspector, getObject, setInspector, setNull

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseCompositeKey

public HBaseCompositeKey(LazySimpleStructObjectInspector oi)

Method Detail

getFieldsAsList

public ArrayList<Object> getFieldsAsList()

Description copied from class: LazyStruct

Get the values of the fields as an ArrayList.

Specified by:

getFieldsAsList in interface StructObject

Overrides:

getFieldsAsList in class LazyStruct

Returns:

The values of the fields as an ArrayList.

toLazyObject

public LazyObject<? extends ObjectInspector> toLazyObject(int fieldID,
                                                 byte[] bytes)

Create an initialize a LazyObject with the given bytes for the given fieldID.

Parameters:

fieldID - field for which the object is to be created

bytes - value with which the object is to be initialized with

Returns:

initialized LazyObject

getParts

public Map<String,String> getParts()

Return the different parts of the key. By default, this returns an empty map. Consumers can choose to override this to provide their own names and types of parts of the key.

Returns:

map of parts name to their type