org.cloudgraph.store.mapping.codec

Class LexicoPadKeyFieldCodec

java.lang.Object

org.cloudgraph.store.mapping.codec.DefaultKeyFieldCodec

org.cloudgraph.store.mapping.codec.LexicoPadKeyFieldCodec

All Implemented Interfaces:

KeyFieldCodec

public class LexicoPadKeyFieldCodec
extends DefaultKeyFieldCodec
implements KeyFieldCodec

A lexicographic KeyFieldCodec which uses DataFlavor specific padding to force the encoded result to the limit or given maximum length, creating fixed length key fields important in many partial and fuzzy scan scenarios.

This codec can cause greatly increased data sizes where given max length far exceeds the length of the actual data to encode.

Since:

1.1.0

Author:

Scott Cinnamond

See Also:

LexicographicCodec, Type, DataFlavor, Padding

Field Summary

Fields inherited from class org.cloudgraph.store.mapping.codec.DefaultKeyFieldCodec

keyField

Constructor Summary

Constructors

Constructor and Description
LexicoPadKeyFieldCodec(KeyFieldMapping keyField)

Method Summary

Modifier and Type	Method and Description
boolean	checkEncodeOverflow(byte[] keyValue) Returns true if the given encoded value will overflow the underlying key field.
Object	decode(byte[] value) Returns the object representation for the given encoded bytes value.
byte[]	encode(Object value) Returns the encoded bytes representation for the given object or literal value.
byte[]	encodeNext(Object value) Returns the encoded "next" bytes representation for the given object or literal value, where the next value depends on the coded implementation and may typically be the lexicographic next value.
org.plasma.sdo.DataFlavor	getDataFlavor()
int	getMaxLength()
boolean	isLexicographic() Return true if the encoded values support lexicographic ordering.
boolean	isTransforming() Return true if the encoded values are fundamentally transformed father than formatted or padded in some way.

Methods inherited from class java.lang.Object

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

Constructor Detail

LexicoPadKeyFieldCodec

public LexicoPadKeyFieldCodec(KeyFieldMapping keyField)

Method Detail

isLexicographic

public boolean isLexicographic()

Description copied from interface: KeyFieldCodec

Return true if the encoded values support lexicographic ordering. For example integer values are not encoded natively but as the integer string representation.

Specified by:

isLexicographic in interface KeyFieldCodec

Returns:

true if the encoded values support lexicographic ordering

isTransforming

public boolean isTransforming()

Description copied from interface: KeyFieldCodec

Return true if the encoded values are fundamentally transformed father than formatted or padded in some way.

Specified by:

isTransforming in interface KeyFieldCodec

Returns:

true if the encoded values are fundamentally transformed father than formatted or padded in some way.

getMaxLength

public int getMaxLength()

getDataFlavor

public org.plasma.sdo.DataFlavor getDataFlavor()

encode

public byte[] encode(Object value)

Description copied from interface: KeyFieldCodec

Returns the encoded bytes representation for the given object or literal value.

Specified by:

encode in interface KeyFieldCodec

Parameters:

value - the object or literal value

Returns:

the encoded bytes representation

checkEncodeOverflow

public boolean checkEncodeOverflow(byte[] keyValue)

Description copied from interface: KeyFieldCodec

Returns true if the given encoded value will overflow the underlying key field.

Specified by:

checkEncodeOverflow in interface KeyFieldCodec

Returns:

true if the given encoded value will overflow the underlying key field.

decode

public Object decode(byte[] value)

Description copied from interface: KeyFieldCodec

Returns the object representation for the given encoded bytes value.

Specified by:

decode in interface KeyFieldCodec

Parameters:

value - encoded bytes value

Returns:

the object representation for the given encoded bytes value

encodeNext

public byte[] encodeNext(Object value)

Description copied from interface: KeyFieldCodec

Returns the encoded "next" bytes representation for the given object or literal value, where the next value depends on the coded implementation and may typically be the lexicographic next value.

Specified by:

encodeNext in interface KeyFieldCodec

Parameters:

value - the object or literal value

Returns:

the encoded bytes representation