|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.types.OrderedBytesBase<T>
@InterfaceAudience.Public @InterfaceStability.Evolving public abstract class OrderedBytesBase<T>
Base class for data types backed by the OrderedBytes
encoding
implementations.
Field Summary | |
---|---|
protected Order |
order
|
Constructor Summary | |
---|---|
protected |
OrderedBytesBase(Order order)
|
Method Summary | |
---|---|
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 |
---|
protected final Order order
Constructor Detail |
---|
protected OrderedBytesBase(Order order)
Method Detail |
---|
public boolean isOrderPreserving()
DataType
byte[]
's
which preserve the natural sort order of the unencoded value.
isOrderPreserving
in interface DataType<T>
true
when natural order is preserved,
false
otherwise.public Order getOrder()
DataType
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
.
getOrder
in interface DataType<T>
public boolean isNullable()
DataType
DataType
s that support null should treat null as comparing
less than any non-null value for default sort ordering purposes.
isNullable
in interface DataType<T>
true
when null is supported, false
otherwise.public boolean isSkippable()
DataType
DataType
s that are not skippable can only be used as the
right-most field of a Struct
.
isSkippable
in interface DataType<T>
public int skip(PositionedByteRange src)
DataType
src
's position forward over one encoded value.
skip
in interface DataType<T>
src
- the buffer containing the encoded value.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |