org.apache.hadoop.hbase.types

Class OrderedBytesBase<T>

java.lang.Object

org.apache.hadoop.hbase.types.OrderedBytesBase<T>

All Implemented Interfaces:

DataType<T>

Direct Known Subclasses:

OrderedBlob, OrderedBlobVar, OrderedFloat32, OrderedFloat64, OrderedInt16, OrderedInt32, OrderedInt64, OrderedInt8, OrderedNumeric, OrderedString

@InterfaceAudience.Public
public abstract class OrderedBytesBase<T>
extends Object
implements DataType<T>

Base class for data types backed by the OrderedBytes encoding implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Order	order

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderedBytesBase(Order order)

Method Summary

Modifier and Type	Method and Description
Order	getOrder() Retrieve the sort Order imposed by this data type, or null when natural ordering is not preserved.
boolean	isNullable() Indicates whether this instance supports encoding null values.
boolean	isOrderPreserving() Indicates whether this instance writes encoded byte[]'s which preserve the natural sort order of the unencoded value.
boolean	isSkippable() Indicates whether this instance is able to skip over it's encoded value.
int	skip(PositionedByteRange src) Skip src's position forward over one encoded value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.types.DataType

decode, encode, encodedClass, encodedLength

Field Detail

order

protected final Order order

Constructor Detail

OrderedBytesBase

protected OrderedBytesBase(Order order)

Method Detail

isOrderPreserving

public boolean isOrderPreserving()

Description copied from interface: DataType

Indicates whether this instance writes encoded byte[]'s which preserve the natural sort order of the unencoded value.

Specified by:

isOrderPreserving in interface DataType<T>

Returns:

true when natural order is preserved, false otherwise.

getOrder

public Order getOrder()

Description copied from interface: DataType

Retrieve the sort Order imposed by this data type, or null when natural ordering is not preserved. Value is either ascending or descending. Default is assumed to be Order.ASCENDING.

Specified by:

getOrder in interface DataType<T>

isNullable

public boolean isNullable()

Description copied from interface: DataType

Indicates whether this instance supports encoding null values. This depends on the implementation details of the encoding format. All DataTypes that support null should treat null as comparing less than any non-null value for default sort ordering purposes.

Specified by:

isNullable in interface DataType<T>

Returns:

true when null is supported, false otherwise.

isSkippable

public boolean isSkippable()

Description copied from interface: DataType

Indicates whether this instance is able to skip over it's encoded value. DataTypes that are not skippable can only be used as the right-most field of a Struct.

Specified by:

isSkippable in interface DataType<T>

skip

public int skip(PositionedByteRange src)

Description copied from interface: DataType

Skip src's position forward over one encoded value.

Specified by:

skip in interface DataType<T>

Parameters:

src - the buffer containing the encoded value.

Returns:

number of bytes skipped.