nl.renarj.jasdb.index.keys

Interface Key

All Superinterfaces:

Comparable<Key>, ComparableKey<Key>

All Known Implementing Classes:

AbstractKey, AnyKey, CompositeKey, DataKey, LongKey, StringKey, UUIDKey

public interface Key
extends ComparableKey<Key>

The key represents a search item in the index, the index stores the key and allows it to be retrieved. The key can contain a payload consisting of multiple subkeys which are not part of the index but can be quickly retrieved. The index will allow storing of any key type by implementing this interface for both values and the key itself. The key needs to be comparable which is used to apply a Lexicographical order comparison with order keys so the btree can be used for quick search and storing.

Author:

Renze de Vries

Method Summary

Modifier and Type	Method and Description
Key	addKey(KeyNameMapper keyMapper, String name, Key key) This adds a child Key to the key, in case the mapper cannot map will not add to child keys and just ignore the added key
Key	cloneKey() Clone the current key without influencing this instance
Key	cloneKey(boolean includeChildren) Clone the current key without influencing this instance, whilst leaving the values
boolean	equals(Object obj)
CompositeKey	getChildrenAsComposite()
Key	getKey(int index) This retrieves a key at a given index
Key	getKey(KeyNameMapper keyMapper, String name) This retrieves a specific payload value KeyValue object which contains the Key of the value
int	getKeyCount()
Key[]	getKeys() Returns an array of the child keys
Map<String,Key>	getKeysByName(KeyNameMapper keyMapper) This retrieves a map of all the child keys stored in this key
Object	getValue()
boolean	hasChildren() Returns if the key has children
int	hashCode()
Key	setKeys(Key[] keys) Sets directly the children key values
Key	setKeys(KeyNameMapper keyMapper, Map<String,Key> keys) This sets all the key payload values
long	size()
String	toString()

Methods inherited from interface nl.renarj.jasdb.index.keys.ComparableKey

compare

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

hashCode

int hashCode()

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Overrides:

equals in class Object

toString

String toString()

Overrides:

toString in class Object

getKeysByName

Map<String,Key> getKeysByName(KeyNameMapper keyMapper)

This retrieves a map of all the child keys stored in this key

Returns:

The map containing all the value payload keys

getKeys

Key[] getKeys()

Returns an array of the child keys

Returns:

The keys in this key

hasChildren

boolean hasChildren()

Returns if the key has children

Returns:

True if the key has children, False if not

getChildrenAsComposite

CompositeKey getChildrenAsComposite()

getKey

Key getKey(KeyNameMapper keyMapper,
           String name)

This retrieves a specific payload value KeyValue object which contains the Key of the value

Parameters:

keyMapper - the mapper to map from name to index

name - The name of the key field to retrieve

Returns:

The Key requested for the given name, null if not present

getKey

Key getKey(int index)

This retrieves a key at a given index

Parameters:

index - The index at which the key is held

Returns:

The key if present, null if not

addKey

Key addKey(KeyNameMapper keyMapper,
           String name,
           Key key)

This adds a child Key to the key, in case the mapper cannot map will not add to child keys and just ignore the added key

Parameters:

key - The child Key to add to the payload of this key

keyMapper - the mapper to map from name to index

name - The name that represents the field / key

Returns:

This key will be returned for easy payload value building (fluent api)

setKeys

Key setKeys(KeyNameMapper keyMapper,
            Map<String,Key> keys)

This sets all the key payload values

Parameters:

keyMapper - the mapper to map from name to index

keys - the child keys to add

Returns:

This key will be returned for easy payload value building (fluent api)

setKeys

Key setKeys(Key[] keys)

Sets directly the children key values

Parameters:

keys - The keys

Returns:

This key will be returned for easy payload value building (fluent api)

cloneKey

Key cloneKey()

Clone the current key without influencing this instance

Returns:

The cloned Key including payload values

cloneKey

Key cloneKey(boolean includeChildren)

Clone the current key without influencing this instance, whilst leaving the values

Parameters:

includeChildren - True if child keys need to be included;

Returns:

The key with values if was specified True, False means without values

size

long size()

getKeyCount

int getKeyCount()

getValue

Object getValue()