org.eclipse.viatra.transformation.views.traceability.patterns

Class TraceMatcher

java.lang.Object

org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper

org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<TraceMatch>

org.eclipse.viatra.transformation.views.traceability.patterns.TraceMatcher

All Implemented Interfaces:

ViatraQueryMatcher<TraceMatch>

public class TraceMatcher
extends BaseMatcher<TraceMatch>

Generated pattern matcher API of the org.eclipse.viatra.transformation.views.traceability.patterns.trace pattern, providing pattern-specific query methods.

Use the pattern matcher on a given model via on(ViatraQueryEngine), e.g. in conjunction with ViatraQueryEngine#on(Notifier).

Matches of the pattern will be represented as TraceMatch.

Original source:

  @QueryExplorer(checked = false)
 pattern trace(source : EObject, id, target : EObject, trace : Trace, traceabilityId) {
        Trace.params(trace, source);
        Trace.targets(trace, target);
        Trace.id(trace,id);
        Traceability.id(traceability,traceabilityId);
        Traceability.traces(traceability,trace);
 } or {
        Trace.objects(trace, source);
        Trace.targets(trace, target);
        Trace.id(trace,id);
        Traceability.id(traceability,traceabilityId);
        Traceability.traces(traceability,trace);
 }
 

See Also:

TraceMatch, TraceProcessor, TraceQuerySpecification

Field Summary

Fields inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseMatcher

engine, querySpecification

Fields inherited from class org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper

backend

Method Summary

Modifier and Type	Method and Description
protected TraceMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected TraceMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static TraceMatcher	create()
void	forEachMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, IMatchProcessor<? super TraceMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, IMatchProcessor<? super TraceMatch> processor) Executes the given processor on an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
java.util.Collection<TraceMatch>	getAllMatches(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<java.lang.String>	getAllValuesOfid() Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(org.eclipse.emf.ecore.EObject pSource, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(TraceMatch partialMatch) Retrieve the set of values that occur in matches for id.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfsource() Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfsource(java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfsource(TraceMatch partialMatch) Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget() Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget(TraceMatch partialMatch) Retrieve the set of values that occur in matches for target.
java.util.Set<Trace>	getAllValuesOftrace() Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(TraceMatch partialMatch) Retrieve the set of values that occur in matches for trace.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId() Retrieve the set of values that occur in matches for traceabilityId.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace) Retrieve the set of values that occur in matches for traceabilityId.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId(TraceMatch partialMatch) Retrieve the set of values that occur in matches for traceabilityId.
TraceMatch	getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
TraceMatch	newMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns a new (partial) match.
static TraceMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<TraceMatcher>	querySpecification()
protected java.util.Set<java.lang.String>	rawAccumulateAllValuesOfid(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for id.
protected java.util.Set<org.eclipse.emf.ecore.EObject>	rawAccumulateAllValuesOfsource(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for source.
protected java.util.Set<org.eclipse.emf.ecore.EObject>	rawAccumulateAllValuesOftarget(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for target.
protected java.util.Set<Trace>	rawAccumulateAllValuesOftrace(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for trace.
protected java.util.Set<java.lang.String>	rawAccumulateAllValuesOftraceabilityId(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for traceabilityId.
protected TraceMatch	tupleToMatch(Tuple t)

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseMatcher

countMatches, countMatches, emptyArray, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getCapabilities, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, matchToArray, newEmptyMatch, newMatch, rawAccumulateAllValues, rawCountMatches, rawForEachMatch, rawForOneArbitraryMatch, rawGetAllMatches, rawGetAllValues, rawGetOneArbitraryMatch, rawHasMatch, setBackend

Methods inherited from class java.lang.Object

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

Method Detail

on

public static TraceMatcher on(ViatraQueryEngine engine)
                       throws ViatraQueryException

Initializes the pattern matcher within an existing VIATRA Query engine. If the pattern matcher is already constructed in the engine, only a light-weight reference is returned. The match set will be incrementally refreshed upon updates.

Parameters:

engine - the existing VIATRA Query engine in which this matcher will be created.

Throws:

ViatraQueryException - if an error occurs during pattern matcher creation

create

public static TraceMatcher create()
                           throws ViatraQueryException

Returns:

an initialized matcher

Throws:

ViatraQueryException - if an error occurs during pattern matcher creation

No Reference:

This method is for internal matcher initialization by the framework, do not call it manually.

getAllMatches

public java.util.Collection<TraceMatch> getAllMatches(org.eclipse.emf.ecore.EObject pSource,
                                                      java.lang.String pId,
                                                      org.eclipse.emf.ecore.EObject pTarget,
                                                      Trace pTrace,
                                                      java.lang.String pTraceabilityId)

Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

matches represented as a TraceMatch object.

getOneArbitraryMatch

public TraceMatch getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource,
                                       java.lang.String pId,
                                       org.eclipse.emf.ecore.EObject pTarget,
                                       Trace pTrace,
                                       java.lang.String pTraceabilityId)

Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

a match represented as a TraceMatch object, or null if no match is found.

hasMatch

public boolean hasMatch(org.eclipse.emf.ecore.EObject pSource,
                        java.lang.String pId,
                        org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace,
                        java.lang.String pTraceabilityId)

Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

true if the input is a valid (partial) match of the pattern.

countMatches

public int countMatches(org.eclipse.emf.ecore.EObject pSource,
                        java.lang.String pId,
                        org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace,
                        java.lang.String pTraceabilityId)

Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.emf.ecore.EObject pSource,
                         java.lang.String pId,
                         org.eclipse.emf.ecore.EObject pTarget,
                         Trace pTrace,
                         java.lang.String pTraceabilityId,
                         IMatchProcessor<? super TraceMatch> processor)

Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource,
                                    java.lang.String pId,
                                    org.eclipse.emf.ecore.EObject pTarget,
                                    Trace pTrace,
                                    java.lang.String pTraceabilityId,
                                    IMatchProcessor<? super TraceMatch> processor)

Executes the given processor on an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

processor - the action that will process the selected match.

Returns:

true if the pattern has at least one match with the given parameter values, false if the processor was not invoked

newMatch

public TraceMatch newMatch(org.eclipse.emf.ecore.EObject pSource,
                           java.lang.String pId,
                           org.eclipse.emf.ecore.EObject pTarget,
                           Trace pTrace,
                           java.lang.String pTraceabilityId)

Returns a new (partial) match. This can be used e.g. to call the matcher with a partial match.

The returned match will be immutable. Use BaseMatcher.newEmptyMatch() to obtain a mutable match object.

Parameters:

pSource - the fixed value of pattern parameter source, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

pTarget - the fixed value of pattern parameter target, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfsource

protected java.util.Set<org.eclipse.emf.ecore.EObject> rawAccumulateAllValuesOfsource(java.lang.Object[] parameters)

Retrieve the set of values that occur in matches for source.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfsource

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource()

Retrieve the set of values that occur in matches for source.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfsource

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource(TraceMatch partialMatch)

Retrieve the set of values that occur in matches for source.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfsource

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource(java.lang.String pId,
                                                                         org.eclipse.emf.ecore.EObject pTarget,
                                                                         Trace pTrace,
                                                                         java.lang.String pTraceabilityId)

Retrieve the set of values that occur in matches for source.

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOfid

protected java.util.Set<java.lang.String> rawAccumulateAllValuesOfid(java.lang.Object[] parameters)

Retrieve the set of values that occur in matches for id.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid()

Retrieve the set of values that occur in matches for id.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid(TraceMatch partialMatch)

Retrieve the set of values that occur in matches for id.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid(org.eclipse.emf.ecore.EObject pSource,
                                                        org.eclipse.emf.ecore.EObject pTarget,
                                                        Trace pTrace,
                                                        java.lang.String pTraceabilityId)

Retrieve the set of values that occur in matches for id.

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOftarget

protected java.util.Set<org.eclipse.emf.ecore.EObject> rawAccumulateAllValuesOftarget(java.lang.Object[] parameters)

Retrieve the set of values that occur in matches for target.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftarget

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget()

Retrieve the set of values that occur in matches for target.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftarget

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget(TraceMatch partialMatch)

Retrieve the set of values that occur in matches for target.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftarget

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget(org.eclipse.emf.ecore.EObject pSource,
                                                                         java.lang.String pId,
                                                                         Trace pTrace,
                                                                         java.lang.String pTraceabilityId)

Retrieve the set of values that occur in matches for target.

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOftrace

protected java.util.Set<Trace> rawAccumulateAllValuesOftrace(java.lang.Object[] parameters)

Retrieve the set of values that occur in matches for trace.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace()

Retrieve the set of values that occur in matches for trace.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace(TraceMatch partialMatch)

Retrieve the set of values that occur in matches for trace.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace(org.eclipse.emf.ecore.EObject pSource,
                                                java.lang.String pId,
                                                org.eclipse.emf.ecore.EObject pTarget,
                                                java.lang.String pTraceabilityId)

Retrieve the set of values that occur in matches for trace.

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOftraceabilityId

protected java.util.Set<java.lang.String> rawAccumulateAllValuesOftraceabilityId(java.lang.Object[] parameters)

Retrieve the set of values that occur in matches for traceabilityId.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftraceabilityId

public java.util.Set<java.lang.String> getAllValuesOftraceabilityId()

Retrieve the set of values that occur in matches for traceabilityId.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftraceabilityId

public java.util.Set<java.lang.String> getAllValuesOftraceabilityId(TraceMatch partialMatch)

Retrieve the set of values that occur in matches for traceabilityId.

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftraceabilityId

public java.util.Set<java.lang.String> getAllValuesOftraceabilityId(org.eclipse.emf.ecore.EObject pSource,
                                                                    java.lang.String pId,
                                                                    org.eclipse.emf.ecore.EObject pTarget,
                                                                    Trace pTrace)

Retrieve the set of values that occur in matches for traceabilityId.

Returns:

the Set of all values or empty set if there are no matches

tupleToMatch

protected TraceMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<TraceMatch>

arrayToMatch

protected TraceMatch arrayToMatch(java.lang.Object[] match)

Description copied from class: BaseMatcher

Converts the array representation of a pattern match to an immutable Match object.

Specified by:

arrayToMatch in class BaseMatcher<TraceMatch>

arrayToMatchMutable

protected TraceMatch arrayToMatchMutable(java.lang.Object[] match)

Description copied from class: BaseMatcher

Converts the array representation of a pattern match to a mutable Match object.

Specified by:

arrayToMatchMutable in class BaseMatcher<TraceMatch>

querySpecification

public static IQuerySpecification<TraceMatcher> querySpecification()
                                                            throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded