nl.renarj.jasdb.index.keys.keyinfo

Interface KeyInfo

All Known Implementing Classes:

KeyInfoImpl

public interface KeyInfo

This represents all the key information in an index

Author:

Renze de Vries

Method Summary

Modifier and Type	Method and Description
List<IndexField>	getIndexKeyFields()
List<IndexField>	getIndexValueFields()
KeyInfoType	getInfoType()
KeyFactory	getKeyFactory() The key factory used to create/serialize/deserialize keys for the index
List<String>	getKeyFields() Returns all the fields kept in the key part of the index
String	getKeyName() Returns a name of the key field(s)
KeyNameMapper	getKeyNameMapper() Gets the key name mapper which can be used to map the name of the field to a position in the key payload.
int	getKeySize() This determines the byte size that is required to store all the key information in the index
MultiKeyloader	getMultiKeyloader()
List<String>	getValueFields()
String	keyAsHeader() Persists all key information as a header string
Key	loadKey(int curPosition, ByteBuffer byteBuffer)
KeyLoadResult	loadKey(int curPosition, DataBlock dataBlock)
int	match(Set<String> fields) Determines how close the gives fields match the index descriptor.
String	valueAsHeader() Persists all value information as a header string
DataBlock	writeKey(Key key, DataBlock dataBlock)
void	writeKey(Key key, int curPosition, ByteBuffer byteBuffer)

Method Detail

loadKey

Key loadKey(int curPosition,
            ByteBuffer byteBuffer)
     throws JasDBStorageException

Throws:

JasDBStorageException

writeKey

void writeKey(Key key,
              int curPosition,
              ByteBuffer byteBuffer)
       throws JasDBStorageException

Throws:

JasDBStorageException

loadKey

KeyLoadResult loadKey(int curPosition,
                      DataBlock dataBlock)
               throws JasDBStorageException

Throws:

JasDBStorageException

writeKey

DataBlock writeKey(Key key,
                   DataBlock dataBlock)
            throws JasDBStorageException

Throws:

JasDBStorageException

keyAsHeader

String keyAsHeader()

Persists all key information as a header string

Returns:

The key information as header string

valueAsHeader

String valueAsHeader()

Persists all value information as a header string

Returns:

The value information as header string

match

int match(Set<String> fields)

Determines how close the gives fields match the index descriptor. The scale is on 0-200. This would reach 200 in case all value fields and index fields are a 100% match. The calculation is N (number of matching fields) / field.size + (N / fields.size) * included matching columns.

Parameters:

fields - The fields to check for matching

Returns:

The matching on a scale from 0-200

getKeySize

int getKeySize()

This determines the byte size that is required to store all the key information in the index

Returns:

The bytesize required to store all the key information

getKeyName

String getKeyName()

Returns a name of the key field(s)

Returns:

The name of the key field(s)

getIndexKeyFields

List<IndexField> getIndexKeyFields()

getIndexValueFields

List<IndexField> getIndexValueFields()

getKeyFields

List<String> getKeyFields()

Returns all the fields kept in the key part of the index

Returns:

The list of all the key fields in the index

getValueFields

List<String> getValueFields()

getInfoType

KeyInfoType getInfoType()

getKeyFactory

KeyFactory getKeyFactory()

The key factory used to create/serialize/deserialize keys for the index

Returns:

The keyfactory used for this index

getMultiKeyloader

MultiKeyloader getMultiKeyloader()

getKeyNameMapper

KeyNameMapper getKeyNameMapper()

Gets the key name mapper which can be used to map the name of the field to a position in the key payload.

Returns:

The key name mapper