nl.renarj.jasdb.index.keys.impl

Class CompositeKey

java.lang.Object

nl.renarj.jasdb.index.keys.AbstractKey

nl.renarj.jasdb.index.keys.impl.CompositeKey

All Implemented Interfaces:

Comparable<Key>, ComparableKey<Key>, Key

public class CompositeKey
extends AbstractKey

Author:

Renze de Vries

Constructor Summary

Constructors

Constructor and Description
CompositeKey()

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
CompareResult	compare(Key otherKey, CompareMethod method)
boolean	equals(Object obj)
CompositeKey	getValue()
int	hashCode()
Key	setKeys(KeyNameMapper keyMapper, Map<String,Key> keyFields) This sets all the key payload values
void	setValueMarker(int valueMarker)
String	toString()

Methods inherited from class nl.renarj.jasdb.index.keys.AbstractKey

compareTo, getChildrenAsComposite, getKey, getKey, getKeyCount, getKeys, getKeysByName, hasChildren, setKeys, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompositeKey

public CompositeKey()

Method Detail

equals

public boolean equals(Object obj)

Specified by:

equals in interface Key

Overrides:

equals in class Object

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

Overrides:

addKey in class AbstractKey

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)

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

Overrides:

setKeys in class AbstractKey

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)

cloneKey

public Key cloneKey()

Description copied from interface: Key

Clone the current key without influencing this instance

Returns:

The cloned Key including payload values

setValueMarker

public void setValueMarker(int valueMarker)

cloneKey

public Key cloneKey(boolean includeChildren)

Description copied from interface: Key

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

compare

public CompareResult compare(Key otherKey,
                             CompareMethod method)

getValue

public CompositeKey getValue()

hashCode

public int hashCode()

Specified by:

hashCode in interface Key

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Key

Overrides:

toString in class Object