com.github.protobufel.multikeymap

Interface MultiKeyMap<T,K extends java.lang.Iterable<T>,V>

Type Parameters:

T - the type of a sub-key the key consist of

K - the type of a full key, which is an Iterable of its sub-keys, with usage as in a regular Map

V - the type of a value which stored in the MultiKeyMap under the corresponding key

All Superinterfaces:

java.util.Map<K,V>

public interface MultiKeyMap<T,K extends java.lang.Iterable<T>,V>
extends java.util.Map<K,V>

Represents a generic Map of composite keys plus the methods to query it by any combination of sub-keys.

NOTE: All implementations assumed to support only @NotNullable values unless specifically stated!

See Also:

Map

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
default java.util.stream.Stream<java.util.Map.Entry<K,V>>	getEntriesByPartialKey(java.lang.Iterable<? extends T> partialKey) Gets all entries for which their full keys contain the partial key set in any order.
default java.util.stream.Stream<java.util.Map.Entry<K,V>>	getEntriesByPartialKey(java.lang.Iterable<? extends T> partialKey, java.lang.Iterable<java.lang.Integer> positions) Gets all entries for which their full keys contain the partial key according to the specified positions.
java.util.stream.Stream<K>	getFullKeysByPartialKey(java.lang.Iterable<? extends T> partialKey) Gets all full keys that contain the partial key set in any order.
default java.util.stream.Stream<K>	getFullKeysByPartialKey(java.lang.Iterable<? extends T> partialKey, java.lang.Iterable<java.lang.Integer> positions) Gets all full keys that contain the partial key according to the specified positions.
default java.util.stream.Stream<V>	getValuesByPartialKey(java.lang.Iterable<? extends T> partialKey) Gets all values for which their full keys contain the partial key set in any order.
default java.util.stream.Stream<V>	getValuesByPartialKey(java.lang.Iterable<? extends T> partialKey, java.lang.Iterable<java.lang.Integer> positions) Gets all values for which their full keys contain the partial key according to the specified positions.

Methods inherited from interface java.util.Map

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

Method Detail

getFullKeysByPartialKey

java.util.stream.Stream<K> getFullKeysByPartialKey(java.lang.Iterable<? extends T> partialKey)

Gets all full keys that contain the partial key set in any order.

Parameters:

partialKey - the combination of the sub-keys to search for.

Returns:

a stream of the full keys satisfying the partial key criteria, otherwise, the empty stream.

getValuesByPartialKey

default java.util.stream.Stream<V> getValuesByPartialKey(java.lang.Iterable<? extends T> partialKey)

Gets all values for which their full keys contain the partial key set in any order.

Parameters:

partialKey - the combination of the sub-keys to search for.

Returns:

a stream of the values satisfying the partial key criteria, otherwise, the empty stream.

getEntriesByPartialKey

default java.util.stream.Stream<java.util.Map.Entry<K,V>> getEntriesByPartialKey(java.lang.Iterable<? extends T> partialKey)

Gets all entries for which their full keys contain the partial key set in any order.

Parameters:

partialKey - the combination of the sub-keys to search for.

Returns:

a stream of the entries satisfying the partial key criteria, otherwise, the empty stream.

getValuesByPartialKey

default java.util.stream.Stream<V> getValuesByPartialKey(java.lang.Iterable<? extends T> partialKey,
                                                         java.lang.Iterable<java.lang.Integer> positions)

Gets all values for which their full keys contain the partial key according to the specified positions.

Parameters:

partialKey - the combination of the sub-keys to search for.

positions - the sequence of positions corresponding to the sequence of partialKey's sub-keys, wherein the negative position signifies a non-positional sub-key to search for anywhere within the full key, otherwise, its exact position within the full key. The size of this list can be smaller than the partialKey list, meaning the rest of the partialKey sub-keys are non-positional.

Returns:

a stream of the values satisfying the partial key criteria, otherwise, the empty stream.

getEntriesByPartialKey

default java.util.stream.Stream<java.util.Map.Entry<K,V>> getEntriesByPartialKey(java.lang.Iterable<? extends T> partialKey,
                                                                                 java.lang.Iterable<java.lang.Integer> positions)

Gets all entries for which their full keys contain the partial key according to the specified positions.

Parameters:

partialKey - the combination of the sub-keys to search for.

positions - the sequence of positions corresponding to the sequence of partialKey's sub-keys, wherein the negative position signifies a non-positional sub-key to search for anywhere within the full key, otherwise, its exact position within the full key. The size of this list can be smaller than the partialKey list, meaning the rest of the partialKey sub-keys are non-positional.

Returns:

a stream of the entries satisfying the partial key criteria, otherwise, the empty stream.

getFullKeysByPartialKey

default java.util.stream.Stream<K> getFullKeysByPartialKey(java.lang.Iterable<? extends T> partialKey,
                                                           java.lang.Iterable<java.lang.Integer> positions)

Gets all full keys that contain the partial key according to the specified positions.

Parameters:

partialKey - the combination of the sub-keys to search for.

positions - the sequence of positions corresponding to the sequence of partialKey's sub-keys, wherein the negative position signifies a non-positional sub-key to search for anywhere within the full key, otherwise, its exact position within the full key. The size of this list can be smaller than the partialKey list, meaning the rest of the partialKey sub-keys are non-positional.

Returns:

a stream of the full keys satisfying the partial key criteria, otherwise, the empty stream.