nl.renarj.jasdb.index.keys.keyinfo

Class KeyInfoImpl

java.lang.Object

nl.renarj.jasdb.index.keys.keyinfo.KeyInfoImpl

All Implemented Interfaces:

KeyInfo

public class KeyInfoImpl
extends Object
implements KeyInfo

Constructor Summary

Constructors

Constructor and Description
KeyInfoImpl(IndexField indexField, IndexField... valueFields)
KeyInfoImpl(IndexField indexField, List<IndexField> valueIndexFields)
KeyInfoImpl(List<IndexField> keyFields, List<IndexField> valueFields)
KeyInfoImpl(String headerDescriptor, String valueDescriptor)

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> searchFields) Determines how close the gives fields match the index descriptor.
String	toString()
String	valueAsHeader() Persists all value information as a header string
DataBlock	writeKey(Key key, DataBlock dataBlock)
void	writeKey(Key key, int curPosition, ByteBuffer byteBuffer)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyInfoImpl

public KeyInfoImpl(IndexField indexField,
                   IndexField... valueFields)
            throws JasDBStorageException

Throws:

JasDBStorageException

KeyInfoImpl

public KeyInfoImpl(IndexField indexField,
                   List<IndexField> valueIndexFields)
            throws JasDBStorageException

Throws:

JasDBStorageException

KeyInfoImpl

public KeyInfoImpl(List<IndexField> keyFields,
                   List<IndexField> valueFields)
            throws JasDBStorageException

Throws:

JasDBStorageException

KeyInfoImpl

public KeyInfoImpl(String headerDescriptor,
                   String valueDescriptor)
            throws JasDBStorageException

Throws:

JasDBStorageException

Method Detail

match

public int match(Set<String> searchFields)

Description copied from interface: KeyInfo

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.

Specified by:

match in interface KeyInfo

Parameters:

searchFields - The fields to check for matching

Returns:

The matching on a scale from 0-200

getKeyFields

public List<String> getKeyFields()

Description copied from interface: KeyInfo

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

Specified by:

getKeyFields in interface KeyInfo

Returns:

The list of all the key fields in the index

getIndexKeyFields

public List<IndexField> getIndexKeyFields()

Specified by:

getIndexKeyFields in interface KeyInfo

getIndexValueFields

public List<IndexField> getIndexValueFields()

Specified by:

getIndexValueFields in interface KeyInfo

getValueFields

public List<String> getValueFields()

Specified by:

getValueFields in interface KeyInfo

loadKey

public Key loadKey(int curPosition,
                   ByteBuffer byteBuffer)
            throws JasDBStorageException

Specified by:

loadKey in interface KeyInfo

Throws:

JasDBStorageException

writeKey

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

Specified by:

writeKey in interface KeyInfo

Throws:

JasDBStorageException

loadKey

public KeyLoadResult loadKey(int curPosition,
                             DataBlock dataBlock)
                      throws JasDBStorageException

Specified by:

loadKey in interface KeyInfo

Throws:

JasDBStorageException

writeKey

public DataBlock writeKey(Key key,
                          DataBlock dataBlock)
                   throws JasDBStorageException

Specified by:

writeKey in interface KeyInfo

Throws:

JasDBStorageException

getKeyNameMapper

public KeyNameMapper getKeyNameMapper()

Description copied from interface: KeyInfo

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

Specified by:

getKeyNameMapper in interface KeyInfo

Returns:

The key name mapper

keyAsHeader

public String keyAsHeader()

Description copied from interface: KeyInfo

Persists all key information as a header string

Specified by:

keyAsHeader in interface KeyInfo

Returns:

The key information as header string

valueAsHeader

public String valueAsHeader()

Description copied from interface: KeyInfo

Persists all value information as a header string

Specified by:

valueAsHeader in interface KeyInfo

Returns:

The value information as header string

getKeyName

public String getKeyName()

Description copied from interface: KeyInfo

Returns a name of the key field(s)

Specified by:

getKeyName in interface KeyInfo

Returns:

The name of the key field(s)

getKeyFactory

public KeyFactory getKeyFactory()

Description copied from interface: KeyInfo

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

Specified by:

getKeyFactory in interface KeyInfo

Returns:

The keyfactory used for this index

getMultiKeyloader

public MultiKeyloader getMultiKeyloader()

Specified by:

getMultiKeyloader in interface KeyInfo

getKeySize

public int getKeySize()

Description copied from interface: KeyInfo

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

Specified by:

getKeySize in interface KeyInfo

Returns:

The bytesize required to store all the key information

getInfoType

public KeyInfoType getInfoType()

Specified by:

getInfoType in interface KeyInfo

toString

public String toString()

Overrides:

toString in class Object