org.eclipse.viatra.addon.viewers.runtime.model.patterns

Class Param2itemMatcher

java.lang.Object

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

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

org.eclipse.viatra.addon.viewers.runtime.model.patterns.Param2itemMatcher

All Implemented Interfaces:

ViatraQueryMatcher<Param2itemMatch>

public class Param2itemMatcher
extends BaseMatcher<Param2itemMatch>

Generated pattern matcher API of the org.eclipse.viatra.addon.viewers.runtime.model.patterns.param2item 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 Param2itemMatch.

Original source:

  @QueryExplorer(checked = false)
 pattern param2item(param, trace : Trace, item : Item) {
        Trace.params(trace, param);
        Trace.targets(trace, item);
 } or {
        Trace.objects(trace, param);
        Trace.targets(trace, item);
 }
 

See Also:

Param2itemMatch, Param2itemProcessor, Param2itemQuerySpecification

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

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.

pItem - the fixed value of pattern parameter item, or null if not bound.

Returns:

matches represented as a Param2itemMatch object.

getOneArbitraryMatch

public Param2itemMatch getOneArbitraryMatch(java.lang.Object pParam,
                                            Trace pTrace,
                                            Item pItem)

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.

pItem - the fixed value of pattern parameter item, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(java.lang.Object pParam,
                        Trace pTrace,
                        Item pItem)

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.

pItem - the fixed value of pattern parameter item, 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,
                        Item pItem)

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.

pItem - the fixed value of pattern parameter item, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(java.lang.Object pParam,
                         Trace pTrace,
                         Item pItem,
                         IMatchProcessor<? super Param2itemMatch> 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.

pItem - the fixed value of pattern parameter item, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(java.lang.Object pParam,
                                    Trace pTrace,
                                    Item pItem,
                                    IMatchProcessor<? super Param2itemMatch> 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.

pItem - the fixed value of pattern parameter item, 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 Param2itemMatch newMatch(java.lang.Object pParam,
                                Trace pTrace,
                                Item pItem)

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.

pItem - the fixed value of pattern parameter item, 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(Param2itemMatch 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,
                                                           Item pItem)

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(Param2itemMatch 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,
                                                Item pItem)

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

rawAccumulateAllValuesOfitem

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

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

Returns:

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

getAllValuesOfitem

public java.util.Set<Item> getAllValuesOfitem()

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

Returns:

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

getAllValuesOfitem

public java.util.Set<Item> getAllValuesOfitem(Param2itemMatch partialMatch)

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

Returns:

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

getAllValuesOfitem

public java.util.Set<Item> getAllValuesOfitem(java.lang.Object pParam,
                                              Trace pTrace)

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

Returns:

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

tupleToMatch

protected Param2itemMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<Param2itemMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<Param2itemMatcher> querySpecification()
                                                                 throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded