com.bigdata.btree.keys

Interface IKeyBuilderExtension<V>

Type Parameters:

V - The value type of the document identifier.

All Known Implementing Classes:

IVDocIdExtension

public interface IKeyBuilderExtension<V>

An extension interface for encoding and decoding unsigned byte[] keys.

Note: This was developed to provide backwards compatibility for the full text index with the change of term identifiers from simple long values to variable length IVs. However, the extension principle is of general use and a similar mechanism exists to allow the override when assembling key components for IKeyOrder.

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
int	byteLength(V obj) Return as-encoded byte length of an object.
V	decode(byte[] key, int off) Decode an object from an unsigned byte[] key.
void	encode(IKeyBuilder keyBuilder, V obj) Encode the object.

Method Detail

decode

V decode(byte[] key,
       int off)

Decode an object from an unsigned byte[] key.

Parameters:

key - The key.

off - The offset of the start of the encoded object.

Returns:

The decoded object.

byteLength

int byteLength(V obj)

Return as-encoded byte length of an object.

Parameters:

obj - The object.

Returns:

The byte length when encoded into a component of an unsigned byte[] key.

encode

void encode(IKeyBuilder keyBuilder,
          V obj)

Encode the object.

Parameters:

keyBuilder - The object being used to encode the key.

obj - The object to be encoded.