Package org.aksw.commons.index.core

Class StorageNodeDictionary<D1,C1,D2,C2,V,X extends StorageNodeMutable<D2,C2,V>>

java.lang.Object

org.aksw.commons.index.core.StorageNodeDictionary<D1,C1,D2,C2,V,X>

All Implemented Interfaces:

StorageNode<D1,C1,V>, StorageNodeMutable<D1,C1,V>

public class StorageNodeDictionary<D1,C1,D2,C2,V,X extends StorageNodeMutable<D2,C2,V>>
extends Object
implements StorageNodeMutable<D1,C1,V>

A wrapper for a storage node that adds a dictionary for the components Can be used to map e.g. Nodes to Integers or canonical instances Maybe this fits better on a TupleAccessor? The issue with storage nodes is that they are stateless. So if we wanted to wrap an exiting structure with a dictionary we would end up with: Dictionary<Alt3<...>, Map<Node, Integer> Probably it would not be too bad because we could still easily get the nested map structure out Actually, why shouldn't the storage node have a state? StorageNode<int[], int, ?> intStorage; TupleAccessor intAccessor; TupleAccessor tripleAccessor = TupleAccessorTriple.INSTANCE StorageNodeDictionary<Triple, Node, ?> tripleStorageWrapper = StorageNodeDictionary.wrap(intStorage, nodeAccessor, (dict, c) -> dict.size(), intAccessor) BiMap<Node, Integer> tripleStorageWrapper.getDictionary();

Author:

raven

Field Summary

Fields

Modifier and Type	Field	Description
protected X	delegate
protected com.google.common.collect.BiMap<C1,C2>	dictionary
protected TupleBridge<D1,C1>	sourceTupleAccessor
protected TupleBridge<D2,C2>	targetTupleAccessor

Constructor Summary

Constructors

Constructor	Description
StorageNodeDictionary(X delegate, com.google.common.collect.BiMap<C1,C2> dictionary, TupleBridge<D1,C1> sourceTupleAccessor, TupleBridge<D2,C2> targetTupleAccessor)

Method Summary

Modifier and Type	Method	Description
boolean	add(V store, D1 sourceTuple)
Object	chooseSubStore(V store, int subStoreIdx)
void	clear(V store)	Clear a store's content.
List<? extends StorageNode<D1,C1,?>>	getChildren()	Each node in the storage expression may have 0 or more children
C1	getKeyComponentRaw(Object key, int idx)	Obtain components from the internal representation of key that was used for indexing w.r.t.
int[]	getKeyTupleIdxs()	The component indexes by which this node indexes May be empty but never null
TupleBridge<D1,C1>	getTupleAccessor()	Future: Allow the storageNode to answer how efficiently it can answer the constraints in a given constraint list E.g.
boolean	isEmpty(V store)
protected C2	makeEntry(C1 c1)
D2	mapSourceToTarget(D1 sourceTuple)
D1	mapTargetToSource(D2 targetTuple)
V	newStore()
boolean	remove(V store, D1 sourceTuple)
<T> Stream<?>	streamEntries(V store, T tupleLike, TupleAccessor<? super T,? extends C1> tupleAccessor)	Stream all entries under equality constraints obtained from a tuple-like pattern
<T> Streamer<V,? extends Map.Entry<?,?>>	streamerForKeyAndSubStoreAlts(T pattern, TupleAccessor<? super T,? extends C1> accessor)	The streamer returns entry that hold a tuple-like key and conceptually alternatives of sub-stores The tuple components of the key can be accessed using StorageNode.getKeyComponentRaw(Object, int) There are as many components as the length of StorageNode.getKeyTupleIdxs() If there is 0 components then any invocation of StorageNode.getKeyComponentRaw(Object, int) will fail with a UnsupportedOperationException.
<T> Streamer<V,?>	streamerForKeys(T pattern, TupleAccessor<? super T,? extends C1> accessor)
<T> Streamer<V,C1>	streamerForKeysAsComponent(T pattern, TupleAccessor<? super T,? extends C1> accessor)	Compiles from a given pattern a function that can stream the matching keys from the appropriate store.
<T> Streamer<V,List<C1>>	streamerForKeysAsTuples(T pattern, TupleAccessor<? super T,? extends C1> accessor)	Compiles from a given pattern a function that can stream the matching keys from the appropriate store.
<T> Streamer<V,?>	streamerForValues(T pattern, TupleAccessor<? super T,? extends C1> accessor)	Returns an object that can extract the stream of values at an index node under constraints map: { entry.value | entry in map and entry.key matches condition} leafSet: set.entries.stream() A leaf set does not have any keys that could affect the result stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aksw.commons.index.core.StorageNode

chooseSubStoreRaw, getPublicDelegate, getStoreAsList, getStoreAsMap, getStoreAsSet, holdsDomainTuples, isAltNode, isDelegate, isListNode, isMapNode, isSetNode, streamEntries, streamEntriesRaw, streamEntriesRaw

Methods inherited from interface org.aksw.commons.index.core.StorageNodeMutable

addRaw, clearRaw, isEmptyRaw, removeRaw

Field Details

delegate

protected X extends StorageNodeMutable<D2,C2,V> delegate

dictionary

protected com.google.common.collect.BiMap<C1,C2> dictionary

sourceTupleAccessor

protected TupleBridge<D1,C1> sourceTupleAccessor

targetTupleAccessor

protected TupleBridge<D2,C2> targetTupleAccessor

Constructor Details

StorageNodeDictionary

public StorageNodeDictionary(X delegate,
 com.google.common.collect.BiMap<C1,C2> dictionary,
 TupleBridge<D1,C1> sourceTupleAccessor,
 TupleBridge<D2,C2> targetTupleAccessor)

Method Details

makeEntry

protected C2 makeEntry(C1 c1)

mapSourceToTarget

public D2 mapSourceToTarget(D1 sourceTuple)

mapTargetToSource

public D1 mapTargetToSource(D2 targetTuple)

add

public boolean add(V store,
 D1 sourceTuple)

Specified by:

add in interface StorageNodeMutable<D1,C1,D2>

remove

public boolean remove(V store,
 D1 sourceTuple)

Specified by:

remove in interface StorageNodeMutable<D1,C1,D2>

clear

public void clear(V store)

Description copied from interface: StorageNodeMutable

Clear a store's content. Cascades to any sub-stores.

Specified by:

clear in interface StorageNodeMutable<D1,C1,D2>

newStore

public V newStore()

Specified by:

newStore in interface StorageNodeMutable<D1,C1,D2>

isEmpty

public boolean isEmpty(V store)

Specified by:

isEmpty in interface StorageNodeMutable<D1,C1,D2>

getChildren

public List<? extends StorageNode<D1,C1,?>> getChildren()

Description copied from interface: StorageNode

Each node in the storage expression may have 0 or more children

Specified by:

getChildren in interface StorageNode<D1,C1,D2>

Returns:

getKeyTupleIdxs

public int[] getKeyTupleIdxs()

Description copied from interface: StorageNode

The component indexes by which this node indexes May be empty but never null

Specified by:

getKeyTupleIdxs in interface StorageNode<D1,C1,D2>

Returns:

getTupleAccessor

public TupleBridge<D1,C1> getTupleAccessor()

Description copied from interface: StorageNode

Future: Allow the storageNode to answer how efficiently it can answer the constraints in a given constraint list E.g. O(1) or O(log(n)) or O(n)

Specified by:

getTupleAccessor in interface StorageNode<D1,C1,D2>

Returns:

streamerForKeysAsComponent

public <T> Streamer<V,C1> streamerForKeysAsComponent(T pattern,
 TupleAccessor<? super T,? extends C1> accessor)

Description copied from interface: StorageNode

Compiles from a given pattern a function that can stream the matching keys from the appropriate store. The keys must be instances of the component type otherwise an exception is raised

Specified by:

streamerForKeysAsComponent in interface StorageNode<D1,C1,D2>

Returns:

streamerForKeysAsTuples

public <T> Streamer<V,List<C1>> streamerForKeysAsTuples(T pattern,
 TupleAccessor<? super T,? extends C1> accessor)

Description copied from interface: StorageNode

Compiles from a given pattern a function that can stream the matching keys from the appropriate store. The keys must be instances of the component type otherwise an exception is raised if getKeyTupleIdxs().length == 0 then returns a single tuple that projects no components

Specified by:

streamerForKeysAsTuples in interface StorageNode<D1,C1,D2>

Returns:

streamerForKeys

public <T> Streamer<V,?> streamerForKeys(T pattern,
 TupleAccessor<? super T,? extends C1> accessor)

Specified by:

streamerForKeys in interface StorageNode<D1,C1,D2>

getKeyComponentRaw

public C1 getKeyComponentRaw(Object key,
 int idx)

Description copied from interface: StorageNode

Obtain components from the internal representation of key that was used for indexing w.r.t. StorageNode.getKeyTupleIdxs().

Specified by:

getKeyComponentRaw in interface StorageNode<D1,C1,D2>

idx - In the range 0 to {@link getKeyTupleIdxs().length} (exclusive) If a key has no components calling this method will always raise IndexOutOfBoundsException

Returns:

chooseSubStore

public Object chooseSubStore(V store,
 int subStoreIdx)

Specified by:

chooseSubStore in interface StorageNode<D1,C1,D2>

streamerForValues

public <T> Streamer<V,?> streamerForValues(T pattern,
 TupleAccessor<? super T,? extends C1> accessor)

Description copied from interface: StorageNode

Returns an object that can extract the stream of values at an index node under constraints map: { entry.value | entry in map and entry.key matches condition} leafSet: set.entries.stream() A leaf set does not have any keys that could affect the result stream

Specified by:

streamerForValues in interface StorageNode<D1,C1,D2>

Returns:

streamerForKeyAndSubStoreAlts

public <T> Streamer<V,? extends Map.Entry<?,?>> streamerForKeyAndSubStoreAlts(T pattern,
 TupleAccessor<? super T,? extends C1> accessor)

Description copied from interface: StorageNode

The streamer returns entry that hold a tuple-like key and conceptually alternatives of sub-stores The tuple components of the key can be accessed using StorageNode.getKeyComponentRaw(Object, int) There are as many components as the length of StorageNode.getKeyTupleIdxs() If there is 0 components then any invocation of StorageNode.getKeyComponentRaw(Object, int) will fail with a UnsupportedOperationException. To extract a specific alternative from the substore use StorageNode.chooseSubStore(Object, int). If StorageNode.getChildren() is not empty then there are as many substore indices as there are children If there are no children then there is an implicit single sub store with index 0

Specified by:

streamerForKeyAndSubStoreAlts in interface StorageNode<D1,C1,D2>

Returns:

streamEntries

public <T> Stream<?> streamEntries(V store,
 T tupleLike,
 TupleAccessor<? super T,? extends C1> tupleAccessor)

Description copied from interface: StorageNode

Stream all entries under equality constraints obtained from a tuple-like pattern

Specified by:

streamEntries in interface StorageNode<D1,C1,D2>

Returns: