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

Class Trace2targetMatcher

java.lang.Object

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

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

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

All Implemented Interfaces:

ViatraQueryMatcher<Trace2targetMatch>

public class Trace2targetMatcher
extends BaseMatcher<Trace2targetMatch>

Generated pattern matcher API of the org.eclipse.viatra.transformation.views.traceability.patterns.trace2target 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 Trace2targetMatch.

Original source:

  @QueryExplorer(checked = false)
 pattern trace2target(target : EObject, trace : Trace) {
        Trace.targets(trace, target);
 }
 

See Also:

Trace2targetMatch, Trace2targetProcessor, Trace2targetQuerySpecification

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 Trace2targetMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected Trace2targetMatch	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 pTarget, Trace pTrace) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static Trace2targetMatcher	create()
void	forEachMatch(org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, IMatchProcessor<? super Trace2targetMatch> 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 pTarget, Trace pTrace, IMatchProcessor<? super Trace2targetMatch> 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<Trace2targetMatch>	getAllMatches(org.eclipse.emf.ecore.EObject pTarget, Trace pTrace) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
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(Trace pTrace) Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget(Trace2targetMatch 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 pTarget) Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(Trace2targetMatch partialMatch) Retrieve the set of values that occur in matches for trace.
Trace2targetMatch	getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pTarget, Trace pTrace) 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 pTarget, Trace pTrace) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
Trace2targetMatch	newMatch(org.eclipse.emf.ecore.EObject pTarget, Trace pTrace) Returns a new (partial) match.
static Trace2targetMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<Trace2targetMatcher>	querySpecification()
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 Trace2targetMatch	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 Trace2targetMatcher 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 Trace2targetMatcher 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<Trace2targetMatch> getAllMatches(org.eclipse.emf.ecore.EObject pTarget,
                                                             Trace pTrace)

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

Parameters:

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.

Returns:

matches represented as a Trace2targetMatch object.

getOneArbitraryMatch

public Trace2targetMatch getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pTarget,
                                              Trace pTrace)

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:

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.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace)

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:

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.

Returns:

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

countMatches

public int countMatches(org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace)

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

Parameters:

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.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.emf.ecore.EObject pTarget,
                         Trace pTrace,
                         IMatchProcessor<? super Trace2targetMatch> processor)

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

Parameters:

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.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.emf.ecore.EObject pTarget,
                                    Trace pTrace,
                                    IMatchProcessor<? super Trace2targetMatch> 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:

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.

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 Trace2targetMatch newMatch(org.eclipse.emf.ecore.EObject pTarget,
                                  Trace pTrace)

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:

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.

Returns:

the (partial) match object.

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(Trace2targetMatch 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(Trace pTrace)

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(Trace2targetMatch 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 pTarget)

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

tupleToMatch

protected Trace2targetMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<Trace2targetMatch>

arrayToMatch

protected Trace2targetMatch 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<Trace2targetMatch>

arrayToMatchMutable

protected Trace2targetMatch 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<Trace2targetMatch>

querySpecification

public static IQuerySpecification<Trace2targetMatcher> querySpecification()
                                                                   throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded