org.eclipse.viatra.query.runtime.emf

Class EMFQueryRuntimeContext

java.lang.Object

org.eclipse.viatra.query.runtime.matchers.context.AbstractQueryRuntimeContext

org.eclipse.viatra.query.runtime.emf.EMFQueryRuntimeContext

All Implemented Interfaces:

IQueryRuntimeContext

Direct Known Subclasses:

DynamicEMFQueryRuntimeContext

public class EMFQueryRuntimeContext
extends AbstractQueryRuntimeContext

The EMF-based runtime query context, backed by an IQBase NavigationHelper.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
protected NavigationHelper	baseIndex
protected java.util.Map<org.eclipse.emf.ecore.EClass,java.util.EnumSet<IndexingService>>	indexedClasses
protected java.util.Map<org.eclipse.emf.ecore.EDataType,java.util.EnumSet<IndexingService>>	indexedDataTypes
protected java.util.Map<org.eclipse.emf.ecore.EStructuralFeature,java.util.EnumSet<IndexingService>>	indexedFeatures
protected org.apache.log4j.Logger	logger
protected EMFQueryMetaContext	metaContext

Constructor Summary

Constructors

Constructor and Description
EMFQueryRuntimeContext(NavigationHelper baseIndex, org.apache.log4j.Logger logger, EMFScope emfScope)

Method Summary

Modifier and Type	Method and Description
void	addUpdateListener(IInputKey key, Tuple seed, IQueryRuntimeContextListener listener) Subscribes for updates in the extensional relation identified by the input key, optionally seeded with the given tuple.
<V> V	coalesceTraversals(java.util.concurrent.Callable<V> callable) The given callable will be executed, and all model traversals will be delayed until the execution is done.
boolean	containsTuple(IInputKey key, Tuple seed) Simpler form of IQueryRuntimeContext.enumerateTuples(IInputKey, Tuple) in the case where all values of the tuples are bound by the seed.
int	countTuples(IInputKey key, Tuple seed) Returns the number of tuples in the extensional relation identified by the input key, optionally seeded with the given tuple.
void	dispose()
void	ensureEnumerableKey(IInputKey key)
void	ensureIndexed(org.eclipse.emf.ecore.EClass eClass) Deprecated. use ensureIndexed(EClass, IndexingService) instead
void	ensureIndexed(org.eclipse.emf.ecore.EClass eClass, IndexingService service)
void	ensureIndexed(org.eclipse.emf.ecore.EDataType eDataType) Deprecated. use ensureIndexed(EDataType, IndexingService) instead
void	ensureIndexed(org.eclipse.emf.ecore.EDataType eDataType, IndexingService service)
void	ensureIndexed(org.eclipse.emf.ecore.EStructuralFeature feature) Deprecated. use ensureIndexed(EStructuralFeature, IndexingService) instead
void	ensureIndexed(org.eclipse.emf.ecore.EStructuralFeature feature, IndexingService service)
void	ensureIndexed(IInputKey key) If the given (enumerable) input key is not yet indexed, the model will be traversed (after the end of the outermost coalescing block, see IQueryRuntimeContext.coalesceTraversals(Callable)) so that the index can be built.
void	ensureIndexed(IInputKey key, IndexingService service) If the given (enumerable) input key is not yet indexed, the model will be traversed (after the end of the outermost coalescing block, see IQueryRuntimeContext.coalesceTraversals(Callable)) so that the index can be built.
void	ensureValidKey(IInputKey key)
void	ensureWildcardIndexing(IndexingService service) Starts wildcard indexing for the given service.
java.lang.Iterable<Tuple>	enumerateTuples(IInputKey key, Tuple seed) Returns the tuples in the extensional relation identified by the input key, optionally seeded with the given tuple.
java.lang.Iterable<? extends java.lang.Object>	enumerateValues(IInputKey key, Tuple seed) Simpler form of IQueryRuntimeContext.enumerateTuples(IInputKey, Tuple) in the case where all values of the tuples are bound by the seed except for one.
void	executeAfterTraversal(java.lang.Runnable runnable) Execute the given runnable after traversal.
protected java.util.EnumSet<IndexingService>	getCurrentIndexingServiceFor(IInputKey key) Retrieve the current registered indexing services for the given key.
EMFScope	getEmfScope()
IQueryMetaContext	getMetaContext() Provides metamodel-specific info independent of the runtime instance model.
void	illegalEnumerateValues(Tuple seed)
void	illegalInputKey(IInputKey key)
boolean	isCoalescing()
boolean	isIndexed(IInputKey key)
boolean	isIndexed(IInputKey key, IndexingService service) Returns true if index is available for the given key providing the given service.
void	removeUpdateListener(IInputKey key, Tuple seed, IQueryRuntimeContextListener listener) Unsubscribes from updates in the extensional relation identified by the input key, optionally seeded with the given tuple.
java.lang.Object	unwrapElement(java.lang.Object internalElement) Unwraps the internal representation of the element into its original form
Tuple	unwrapTuple(Tuple internalElements) Unwraps the tuple of internal representations of elements into their original forms
java.lang.Object	wrapElement(java.lang.Object externalElement) Wraps the external element into the internal representation that is to be used by the query backend
Tuple	wrapTuple(Tuple externalElements) Unwraps the tuple of elements into the internal representation that is to be used by the query backend

Methods inherited from class java.lang.Object

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

Field Detail

baseIndex

protected final NavigationHelper baseIndex

indexedClasses

protected final java.util.Map<org.eclipse.emf.ecore.EClass,java.util.EnumSet<IndexingService>> indexedClasses

indexedDataTypes

protected final java.util.Map<org.eclipse.emf.ecore.EDataType,java.util.EnumSet<IndexingService>> indexedDataTypes

indexedFeatures

protected final java.util.Map<org.eclipse.emf.ecore.EStructuralFeature,java.util.EnumSet<IndexingService>> indexedFeatures

metaContext

protected final EMFQueryMetaContext metaContext

logger

protected org.apache.log4j.Logger logger

Constructor Detail

EMFQueryRuntimeContext

public EMFQueryRuntimeContext(NavigationHelper baseIndex,
                              org.apache.log4j.Logger logger,
                              EMFScope emfScope)

Method Detail

getEmfScope

public EMFScope getEmfScope()

dispose

public void dispose()

coalesceTraversals

public <V> V coalesceTraversals(java.util.concurrent.Callable<V> callable)
                         throws java.lang.reflect.InvocationTargetException

Description copied from interface: IQueryRuntimeContext

The given callable will be executed, and all model traversals will be delayed until the execution is done. If there are any outstanding information to be read from the model, a single coalesced model traversal will initialize the caches and deliver the notifications.

Calls may be nested. A single coalesced traversal will happen at the end of the outermost call.

Caution: results returned by the runtime context may be incomplete during the coalescing period, to be corrected by notifications sent during the final coalesced traversal. For example, if a certain input key is not cached yet, an empty relation may be reported during callable.call(); the cache will be constructed after the call terminates and notifications will deliver the entire content of the relation. Non-incremental query backends should therefore never enumerate input keys while coalesced (verify using IQueryRuntimeContext.isCoalescing()).

Throws:

java.lang.reflect.InvocationTargetException

isCoalescing

public boolean isCoalescing()

Returns:

true iff currently within a coalescing section (i.e. within the callable of a call to IQueryRuntimeContext.coalesceTraversals(Callable)).

getMetaContext

public IQueryMetaContext getMetaContext()

Description copied from interface: IQueryRuntimeContext

Provides metamodel-specific info independent of the runtime instance model.

ensureIndexed

public void ensureIndexed(IInputKey key,
                          IndexingService service)

Description copied from interface: IQueryRuntimeContext

If the given (enumerable) input key is not yet indexed, the model will be traversed (after the end of the outermost coalescing block, see IQueryRuntimeContext.coalesceTraversals(Callable)) so that the index can be built. It is possible that the base indexer will select a higher indexing level merging multiple indexing requests to an appropriate level.

Postcondition: After invoking this method, #getIndexed(IInputKey, IndexingService) for the same key and service will be guaranteed to return the requested or a highing indexing level as soon as IQueryRuntimeContext.isCoalescing() first returns false.

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

Specified by:

ensureIndexed in interface IQueryRuntimeContext

Overrides:

ensureIndexed in class AbstractQueryRuntimeContext

ensureIndexed

public void ensureIndexed(IInputKey key)

Description copied from interface: IQueryRuntimeContext

If the given (enumerable) input key is not yet indexed, the model will be traversed (after the end of the outermost coalescing block, see IQueryRuntimeContext.coalesceTraversals(Callable)) so that the index can be built.

Postcondition: After invoking this method, IQueryRuntimeContext.isIndexed(IInputKey) for the same key will be guaranteed to return true as soon as IQueryRuntimeContext.isCoalescing() first returns false.

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

getCurrentIndexingServiceFor

protected java.util.EnumSet<IndexingService> getCurrentIndexingServiceFor(IInputKey key)

Retrieve the current registered indexing services for the given key. May not return null, returns an empty set if no indexing is registered.

Since:

1.4

isIndexed

public boolean isIndexed(IInputKey key,
                         IndexingService service)

Description copied from interface: IQueryRuntimeContext

Returns true if index is available for the given key providing the given service.

Specified by:

isIndexed in interface IQueryRuntimeContext

Overrides:

isIndexed in class AbstractQueryRuntimeContext

isIndexed

public boolean isIndexed(IInputKey key)

Returns:

true iff the given input key is already indexed, and contents are available without costly model traversal.

containsTuple

public boolean containsTuple(IInputKey key,
                             Tuple seed)

Description copied from interface: IQueryRuntimeContext

Simpler form of IQueryRuntimeContext.enumerateTuples(IInputKey, Tuple) in the case where all values of the tuples are bound by the seed.

Returns whether the given tuple is in the extensional relation identified by the input key.

Note: this call works for non-enumerable input keys as well.

Parameters:

key - an input key

seed - a tuple with matching arity, consisting of non-null elements (null can be used in the 0-ary case).

Returns:

true iff the seed tuple is contained in the relation

enumerateTuples

public java.lang.Iterable<Tuple> enumerateTuples(IInputKey key,
                                                 Tuple seed)

Description copied from interface: IQueryRuntimeContext

Returns the tuples in the extensional relation identified by the input key, optionally seeded with the given tuple.

Parameters:

key - an input key

seed - can be null or a tuple with matching arity; if non-null, only those tuples in the model are enumerated that match the seed at positions where the seed is non-null.

Returns:

the tuples in the model for the given key and seed

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

enumerateValues

public java.lang.Iterable<? extends java.lang.Object> enumerateValues(IInputKey key,
                                                                      Tuple seed)

Description copied from interface: IQueryRuntimeContext

Simpler form of IQueryRuntimeContext.enumerateTuples(IInputKey, Tuple) in the case where all values of the tuples are bound by the seed except for one.

Selects the tuples in the extensional relation identified by the input key, optionally seeded with the given tuple, and then returns the single value from each tuple which corresponds to the only null value in the seed.

Parameters:

key - an input key

seed - can be null (if key is unary) or a tuple with matching arity; if non-null, only those tuples in the model are enumerated that match the seed at positions where the seed is non-null; the seed is null at exactly one position.

Returns:

the objects in the model for the given key and seed

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

countTuples

public int countTuples(IInputKey key,
                       Tuple seed)

Description copied from interface: IQueryRuntimeContext

Returns the number of tuples in the extensional relation identified by the input key, optionally seeded with the given tuple.

Parameters:

key - an input key

seed - can be null or a tuple with matching arity; if non-null, only those tuples in the model are counted that match the seed at positions where the seed is non-null.

Returns:

the number of tuples in the model for the given key and seed

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

ensureEnumerableKey

public void ensureEnumerableKey(IInputKey key)

ensureValidKey

public void ensureValidKey(IInputKey key)

illegalInputKey

public void illegalInputKey(IInputKey key)

illegalEnumerateValues

public void illegalEnumerateValues(Tuple seed)

ensureIndexed

@Deprecated
public void ensureIndexed(org.eclipse.emf.ecore.EClass eClass)

Deprecated. use ensureIndexed(EClass, IndexingService) instead

Parameters:

eClass -

ensureIndexed

public void ensureIndexed(org.eclipse.emf.ecore.EClass eClass,
                          IndexingService service)

Since:

1.4

ensureIndexed

@Deprecated
public void ensureIndexed(org.eclipse.emf.ecore.EDataType eDataType)

Deprecated. use ensureIndexed(EDataType, IndexingService) instead

Parameters:

eDataType -

ensureIndexed

public void ensureIndexed(org.eclipse.emf.ecore.EDataType eDataType,
                          IndexingService service)

Since:

1.4

ensureIndexed

@Deprecated
public void ensureIndexed(org.eclipse.emf.ecore.EStructuralFeature feature)

Deprecated. use ensureIndexed(EStructuralFeature, IndexingService) instead

Parameters:

feature -

ensureIndexed

public void ensureIndexed(org.eclipse.emf.ecore.EStructuralFeature feature,
                          IndexingService service)

Since:

1.4

addUpdateListener

public void addUpdateListener(IInputKey key,
                              Tuple seed,
                              IQueryRuntimeContextListener listener)

Description copied from interface: IQueryRuntimeContext

Subscribes for updates in the extensional relation identified by the input key, optionally seeded with the given tuple.

This should be called after invoking

Parameters:

key - an input key

seed - can be null or a tuple with matching arity; if non-null, only those updates in the model are notified about that match the seed at positions where the seed is non-null.

listener - will be notified of future changes

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

removeUpdateListener

public void removeUpdateListener(IInputKey key,
                                 Tuple seed,
                                 IQueryRuntimeContextListener listener)

Description copied from interface: IQueryRuntimeContext

Unsubscribes from updates in the extensional relation identified by the input key, optionally seeded with the given tuple.

Parameters:

key - an input key

seed - can be null or a tuple with matching arity; if non-null, only those updates in the model are notified about that match the seed at positions where the seed is non-null.

listener - will no longer be notified of future changes

Precondition: the given key is enumerable, see IQueryMetaContext.isEnumerable(IInputKey).

unwrapElement

public java.lang.Object unwrapElement(java.lang.Object internalElement)

Description copied from interface: IQueryRuntimeContext

Unwraps the internal representation of the element into its original form

internal object -> model element

null must be mapped to null.

unwrapTuple

public Tuple unwrapTuple(Tuple internalElements)

Description copied from interface: IQueryRuntimeContext

Unwraps the tuple of internal representations of elements into their original forms

internal objects -> model elements

null must be mapped to null.

wrapElement

public java.lang.Object wrapElement(java.lang.Object externalElement)

Description copied from interface: IQueryRuntimeContext

Wraps the external element into the internal representation that is to be used by the query backend

model element -> internal object.

null must be mapped to null.

wrapTuple

public Tuple wrapTuple(Tuple externalElements)

Description copied from interface: IQueryRuntimeContext

Unwraps the tuple of elements into the internal representation that is to be used by the query backend

model elements -> internal objects

null must be mapped to null.

ensureWildcardIndexing

public void ensureWildcardIndexing(IndexingService service)

Description copied from interface: IQueryRuntimeContext

Starts wildcard indexing for the given service. After this call, no registration is required for this IndexingService. a previously set wildcard level cannot be lowered, only extended.

Since:

1.4

executeAfterTraversal

public void executeAfterTraversal(java.lang.Runnable runnable)
                           throws java.lang.reflect.InvocationTargetException

Description copied from interface: IQueryRuntimeContext

Execute the given runnable after traversal. It is guaranteed that the runnable is executed as soon as the indexing is finished. The callback is executed only once, then is removed from the callback queue.

Throws:

java.lang.reflect.InvocationTargetException

Since:

1.4