ai.libs.jaicore.basic.kvstore

Class KVStore

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

ai.libs.jaicore.basic.kvstore.KVStore

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class KVStore
extends java.util.HashMap<java.lang.String,java.lang.Object>
implements java.io.Serializable

A KVStore can be used to store arbitrary objects for some string key. The KVStore allows for more convenient data access and some basic operations. Within KVStoreCollections it can be subject to significance tests and it may be transformed into a table representation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
KVStore() Standard c'tor creating an empty KV store.
KVStore(KVStore keyValueStoreToCopy) C'tor for making a deep copy of another KVStore.
KVStore(java.util.Map<java.lang.String,java.lang.Object> keyValueMap) C'tor for creating a shallow copy of another KeyValueStore or to initialize with the provided keyValueMap.
KVStore(java.lang.String stringRepresentation) C'tor creating a KV store loading the data from the provided string representation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	filter(java.util.Map<java.lang.String,IKVFilter> filterMap) Enables filtering values of multiple keys.
void	filter(java.lang.String key, IKVFilter filter) Allows to apply a filter to the value of a specific key.
java.lang.Boolean	getAsBoolean(java.lang.String key) Returns a value as boolean for the given key.
java.util.List<java.lang.Boolean>	getAsBooleanList(java.lang.String key) Returns a value as boolean list for the given key.
java.util.List<java.lang.Boolean>	getAsBooleanList(java.lang.String key, java.lang.String separator) Returns a value as boolean list for the given key.
java.lang.Byte	getAsByte(java.lang.String key) Returns a value as byte for the given key.
java.lang.Double	getAsDouble(java.lang.String key) Returns a value as double for the given key.
java.util.List<java.lang.Double>	getAsDoubleList(java.lang.String key) Returns a value as double list for the given key.
java.util.List<java.lang.Double>	getAsDoubleList(java.lang.String key, java.lang.String separator) Returns a value as double list for the given key.
java.io.File	getAsFile(java.lang.String key) Returns a value as a File object.
java.lang.Integer	getAsInt(java.lang.String key) Returns a value as integer for the given key.
java.util.List<java.lang.Integer>	getAsIntList(java.lang.String key) Returns a value as integer list for the given key.
java.util.List<java.lang.Integer>	getAsIntList(java.lang.String key, java.lang.String separator) Returns a value as integer list for the given key.
java.lang.Long	getAsLong(java.lang.String key) Returns a value as long for the given key.
java.lang.Object	getAsObject(java.lang.String key, java.lang.Class<?> objectClass) Returns a value as object for the given key.
java.lang.Short	getAsShort(java.lang.String key) Returns a value as short for the given key.
java.lang.String	getAsString(java.lang.String key) Returns a value as string for the given key.
java.util.List<java.lang.String>	getAsStringList(java.lang.String key, java.lang.String separator) Returns a value as string list for the given key.
KVStoreCollection	getCollection()
java.lang.String	getStringRepresentation(java.lang.String[] projectionFilter) Allows to get a string representation of this KVStore incorporating only key value pairs for the named
int	hashCode()
boolean	matches(java.util.Map<java.lang.String,java.lang.String> selection) Checks whether particular keys have matching values according to selection.
void	merge(java.lang.String[] fieldKeys, java.lang.String separator, java.lang.String newKey) Merges a set of keys and concatenates the values of the respective keys.
void	prefixAllKeys(java.lang.String prefix) Updates all keys of this key value store and prepends the given prefix.
void	project(java.lang.String[] filterKeys) Reduces the key value store such that it only contains the given keys.
void	readKVStoreFromDescription(java.lang.String kvDescription) Reads a KVStore from a string description.
void	removeAll(java.lang.String[] removeKeys) Removes all the keys provided by removeKeys.
void	renameKey(java.lang.String key, java.lang.String newKeyName) Renames a key by the new key name.
void	serializeTo(java.io.File file) Serializes the key value store to the file with the given fileName.
void	serializeTo(java.lang.String fileName) Serializes the key value store to a file with the given fileName.
void	setCollection(KVStoreCollection collection) Assigns the KVStore to a KVStoreCollection.
java.lang.String	toString()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

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

Constructor Detail

KVStore

public KVStore()

Standard c'tor creating an empty KV store.

KVStore

public KVStore(java.lang.String stringRepresentation)

C'tor creating a KV store loading the data from the provided string representation.

Parameters:

stringRepresentation - A string formatted key value store to be restored.

KVStore

public KVStore(java.util.Map<java.lang.String,java.lang.Object> keyValueMap)

C'tor for creating a shallow copy of another KeyValueStore or to initialize with the provided keyValueMap.

Parameters:

keyValueMap - Map of keys and values to initialize this KeyValueStore with.

KVStore

public KVStore(KVStore keyValueStoreToCopy)

C'tor for making a deep copy of another KVStore.

Parameters:

keyValueStoreToCopy - The KVStore to make a deep copy from.

Method Detail

getAsString

public java.lang.String getAsString(java.lang.String key)

Returns a value as string for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsBoolean

public java.lang.Boolean getAsBoolean(java.lang.String key)

Returns a value as boolean for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsInt

public java.lang.Integer getAsInt(java.lang.String key)

Returns a value as integer for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsDouble

public java.lang.Double getAsDouble(java.lang.String key)

Returns a value as double for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsLong

public java.lang.Long getAsLong(java.lang.String key)

Returns a value as long for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsShort

public java.lang.Short getAsShort(java.lang.String key)

Returns a value as short for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsByte

public java.lang.Byte getAsByte(java.lang.String key)

Returns a value as byte for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsObject

public java.lang.Object getAsObject(java.lang.String key,
                                    java.lang.Class<?> objectClass)
                             throws java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.NoSuchMethodException

Returns a value as object for the given key.

Parameters:

key - Key for which the value shall be returned.

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

getAsDoubleList

public java.util.List<java.lang.Double> getAsDoubleList(java.lang.String key)

Returns a value as double list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsDoubleList

public java.util.List<java.lang.Double> getAsDoubleList(java.lang.String key,
                                                        java.lang.String separator)

Returns a value as double list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsIntList

public java.util.List<java.lang.Integer> getAsIntList(java.lang.String key)

Returns a value as integer list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsIntList

public java.util.List<java.lang.Integer> getAsIntList(java.lang.String key,
                                                      java.lang.String separator)

Returns a value as integer list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsStringList

public java.util.List<java.lang.String> getAsStringList(java.lang.String key,
                                                        java.lang.String separator)

Returns a value as string list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsBooleanList

public java.util.List<java.lang.Boolean> getAsBooleanList(java.lang.String key)

Returns a value as boolean list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsBooleanList

public java.util.List<java.lang.Boolean> getAsBooleanList(java.lang.String key,
                                                          java.lang.String separator)

Returns a value as boolean list for the given key.

Parameters:

key - Key for which the value shall be returned.

getAsFile

public java.io.File getAsFile(java.lang.String key)

Returns a value as a File object.

Parameters:

key - Key for which the value shall be returned.

Returns:

The value for the given key as a file.

readKVStoreFromDescription

public void readKVStoreFromDescription(java.lang.String kvDescription)

Reads a KVStore from a string description.

Parameters:

kvDescription - The string description of the kv store.

matches

public boolean matches(java.util.Map<java.lang.String,java.lang.String> selection)

Checks whether particular keys have matching values according to selection.

Parameters:

selection - Map of keys and values to match for. Values may use * as a wildcard.

Returns:

Returns true whether this key value star meets the keys and values in selection.

project

public void project(java.lang.String[] filterKeys)

Reduces the key value store such that it only contains the given keys.

Parameters:

filterKeys - Keys to keep in the key value store.

removeAll

public void removeAll(java.lang.String[] removeKeys)

Removes all the keys provided by removeKeys.

Parameters:

removeKeys - Array of keys that shall be removed from the key value store.

filter

public void filter(java.util.Map<java.lang.String,IKVFilter> filterMap)

Enables filtering values of multiple keys.

Parameters:

filterMap - Map of keys and respective filters to apply.

filter

public void filter(java.lang.String key,
                   IKVFilter filter)

Allows to apply a filter to the value of a specific key.

Parameters:

key - Key to whose value the filter may be applied.

filter - The filter for applying to the value of the given key.

serializeTo

public void serializeTo(java.lang.String fileName)
                 throws java.io.IOException

Serializes the key value store to a file with the given fileName.

Parameters:

fileName - The name of the file, the key value store shall be serialized to.

Throws:

java.io.IOException

serializeTo

public void serializeTo(java.io.File file)
                 throws java.io.IOException

Serializes the key value store to the file with the given fileName.

Parameters:

fileName - The name of the file, the key value store shall be serialized to.

Throws:

java.io.IOException

merge

public void merge(java.lang.String[] fieldKeys,
                  java.lang.String separator,
                  java.lang.String newKey)

Merges a set of keys and concatenates the values of the respective keys.

Parameters:

fieldKeys - Keys of values to be concatenated.

separator - Seperator to separate values of different keys.

newKey - Name of the new key.

prefixAllKeys

public void prefixAllKeys(java.lang.String prefix)

Updates all keys of this key value store and prepends the given prefix.

Parameters:

prefix - The prefix to prepend to key names.

renameKey

public void renameKey(java.lang.String key,
                      java.lang.String newKeyName)

Renames a key by the new key name.

Parameters:

key - The old key name.

newKeyName - The new key name.

getCollection

public KVStoreCollection getCollection()

Returns:

Get the collection this KVStore belongs to.

setCollection

public void setCollection(KVStoreCollection collection)

Assigns the KVStore to a KVStoreCollection.

Parameters:

collection - The collection this KVStore belongs to.

getStringRepresentation

public java.lang.String getStringRepresentation(java.lang.String[] projectionFilter)

Allows to get a string representation of this KVStore incorporating only key value pairs for the named

Parameters:

projectionFilter -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

hashCode in class java.util.AbstractMap<java.lang.String,java.lang.Object>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

equals in class java.util.AbstractMap<java.lang.String,java.lang.Object>