nl.renarj.jasdb.index.keys

Class AbstractKey

java.lang.Object

nl.renarj.jasdb.index.keys.AbstractKey

All Implemented Interfaces:

Comparable<Key>, ComparableKey<Key>, Key

Direct Known Subclasses:

AnyKey, CompositeKey, DataKey, LongKey, StringKey, UUIDKey

public abstract class AbstractKey
extends Object
implements Key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKey()

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
int	compareTo(Key o)
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
boolean	hasChildren() Returns if the key has children
Key	setKeys(Key[] keys) Sets directly the children key values
Key	setKeys(KeyNameMapper keyMapper, Map<String,Key> keyFields) This sets all the key payload values
long	size()

Methods inherited from class java.lang.Object

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

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

cloneKey, cloneKey, equals, getValue, hashCode, toString

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

compare

Constructor Detail

AbstractKey

protected AbstractKey()

Method Detail

setKeys

public Key setKeys(KeyNameMapper keyMapper,
                   Map<String,Key> keyFields)

Description copied from interface: Key

This sets all the key payload values

Specified by:

setKeys in interface Key

Parameters:

keyMapper - the mapper to map from name to index

keyFields - the child keys to add

Returns:

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

setKeys

public Key setKeys(Key[] keys)

Description copied from interface: Key

Sets directly the children key values

Specified by:

setKeys in interface Key

Parameters:

keys - The keys

Returns:

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

addKey

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

Description copied from interface: 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

Specified by:

addKey in interface Key

Parameters:

keyMapper - the mapper to map from name to index

name - The name that represents the field / key

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

Returns:

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

getKey

public Key getKey(int index)

Description copied from interface: Key

This retrieves a key at a given index

Specified by:

getKey in interface Key

Parameters:

index - The index at which the key is held

Returns:

The key if present, null if not

getKey

public Key getKey(KeyNameMapper keyMapper,
                  String name)

Description copied from interface: Key

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

Specified by:

getKey in interface Key

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

hasChildren

public boolean hasChildren()

Description copied from interface: Key

Returns if the key has children

Specified by:

hasChildren in interface Key

Returns:

True if the key has children, False if not

getKeys

public Key[] getKeys()

Description copied from interface: Key

Returns an array of the child keys

Specified by:

getKeys in interface Key

Returns:

The keys in this key

size

public long size()

Specified by:

size in interface Key

getKeyCount

public int getKeyCount()

Specified by:

getKeyCount in interface Key

getChildrenAsComposite

public CompositeKey getChildrenAsComposite()

Specified by:

getChildrenAsComposite in interface Key

getKeysByName

public Map<String,Key> getKeysByName(KeyNameMapper keyMapper)

Description copied from interface: Key

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

Specified by:

getKeysByName in interface Key

Returns:

The map containing all the value payload keys

compareTo

public int compareTo(Key o)

Specified by:

compareTo in interface Comparable<Key>