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

Class Trace2objectMatcher

java.lang.Object

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

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

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

All Implemented Interfaces:

ViatraQueryMatcher<Trace2objectMatch>

public class Trace2objectMatcher
extends BaseMatcher<Trace2objectMatch>

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

Original source:

  @QueryExplorer(checked = false)
 pattern trace2object(param, trace : Trace, id) {
        Trace.objects(trace, param);
        Trace.id(trace, id);
 }
 

See Also:

Trace2objectMatch, Trace2objectProcessor, Trace2objectQuerySpecification

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 Trace2objectMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected Trace2objectMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(java.lang.Object pParam, Trace pTrace, java.lang.String pId) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static Trace2objectMatcher	create()
void	forEachMatch(java.lang.Object pParam, Trace pTrace, java.lang.String pId, IMatchProcessor<? super Trace2objectMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(java.lang.Object pParam, Trace pTrace, java.lang.String pId, IMatchProcessor<? super Trace2objectMatch> 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<Trace2objectMatch>	getAllMatches(java.lang.Object pParam, Trace pTrace, java.lang.String pId) 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(java.lang.Object pParam, Trace pTrace) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(Trace2objectMatch partialMatch) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.Object>	getAllValuesOfparam() Retrieve the set of values that occur in matches for param.
java.util.Set<java.lang.Object>	getAllValuesOfparam(Trace2objectMatch partialMatch) Retrieve the set of values that occur in matches for param.
java.util.Set<java.lang.Object>	getAllValuesOfparam(Trace pTrace, java.lang.String pId) Retrieve the set of values that occur in matches for param.
java.util.Set<Trace>	getAllValuesOftrace() Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(java.lang.Object pParam, java.lang.String pId) Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(Trace2objectMatch partialMatch) Retrieve the set of values that occur in matches for trace.
Trace2objectMatch	getOneArbitraryMatch(java.lang.Object pParam, Trace pTrace, java.lang.String pId) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(java.lang.Object pParam, Trace pTrace, java.lang.String pId) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
Trace2objectMatch	newMatch(java.lang.Object pParam, Trace pTrace, java.lang.String pId) Returns a new (partial) match.
static Trace2objectMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<Trace2objectMatcher>	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<java.lang.Object>	rawAccumulateAllValuesOfparam(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for param.
protected java.util.Set<Trace>	rawAccumulateAllValuesOftrace(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for trace.
protected Trace2objectMatch	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 Trace2objectMatcher 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 Trace2objectMatcher 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<Trace2objectMatch> getAllMatches(java.lang.Object pParam,
                                                             Trace pTrace,
                                                             java.lang.String pId)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

Returns:

matches represented as a Trace2objectMatch object.

getOneArbitraryMatch

public Trace2objectMatch getOneArbitraryMatch(java.lang.Object pParam,
                                              Trace pTrace,
                                              java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

Returns:

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

hasMatch

public boolean hasMatch(java.lang.Object pParam,
                        Trace pTrace,
                        java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

Returns:

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

countMatches

public int countMatches(java.lang.Object pParam,
                        Trace pTrace,
                        java.lang.String pId)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(java.lang.Object pParam,
                         Trace pTrace,
                         java.lang.String pId,
                         IMatchProcessor<? super Trace2objectMatch> processor)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(java.lang.Object pParam,
                                    Trace pTrace,
                                    java.lang.String pId,
                                    IMatchProcessor<? super Trace2objectMatch> 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:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

pId - the fixed value of pattern parameter id, 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 Trace2objectMatch newMatch(java.lang.Object pParam,
                                  Trace pTrace,
                                  java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

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

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

Returns:

the (partial) match object.

rawAccumulateAllValuesOfparam

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

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

Returns:

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

getAllValuesOfparam

public java.util.Set<java.lang.Object> getAllValuesOfparam()

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

Returns:

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

getAllValuesOfparam

public java.util.Set<java.lang.Object> getAllValuesOfparam(Trace2objectMatch partialMatch)

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

Returns:

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

getAllValuesOfparam

public java.util.Set<java.lang.Object> getAllValuesOfparam(Trace pTrace,
                                                           java.lang.String pId)

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

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(Trace2objectMatch 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(java.lang.Object pParam,
                                                java.lang.String pId)

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

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(Trace2objectMatch 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(java.lang.Object pParam,
                                                        Trace pTrace)

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

tupleToMatch

protected Trace2objectMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<Trace2objectMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<Trace2objectMatcher> querySpecification()
                                                                   throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded