public class Param2itemMatcher extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<Param2itemMatch>
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);
}
Param2itemMatch
,
Param2itemProcessor
,
Param2itemQuerySpecification
Modifier and Type | Method and Description |
---|---|
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.
|
void |
forEachMatch(java.lang.Object pParam,
Trace pTrace,
Item pItem,
org.eclipse.viatra.query.runtime.api.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,
org.eclipse.viatra.query.runtime.api.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(org.eclipse.viatra.query.runtime.api.ViatraQueryEngine engine)
Initializes the pattern matcher within an existing VIATRA Query engine.
|
static org.eclipse.viatra.query.runtime.api.IQuerySpecification<Param2itemMatcher> |
querySpecification() |
countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch
public static Param2itemMatcher on(org.eclipse.viatra.query.runtime.api.ViatraQueryEngine engine) throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
engine
- the existing VIATRA Query engine in which this matcher will be created.org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if an error occurs during pattern matcher creationpublic java.util.Collection<Param2itemMatch> getAllMatches(java.lang.Object pParam, Trace pTrace, Item pItem)
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.public Param2itemMatch getOneArbitraryMatch(java.lang.Object pParam, Trace pTrace, Item pItem)
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.public boolean hasMatch(java.lang.Object pParam, Trace pTrace, Item pItem)
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.public int countMatches(java.lang.Object pParam, Trace pTrace, Item pItem)
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.public void forEachMatch(java.lang.Object pParam, Trace pTrace, Item pItem, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2itemMatch> processor)
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.public boolean forOneArbitraryMatch(java.lang.Object pParam, Trace pTrace, Item pItem, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2itemMatch> processor)
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.public Param2itemMatch newMatch(java.lang.Object pParam, Trace pTrace, Item pItem)
The returned match will be immutable. Use BaseMatcher.newEmptyMatch()
to obtain a mutable match object.
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.public java.util.Set<java.lang.Object> getAllValuesOfparam()
public java.util.Set<java.lang.Object> getAllValuesOfparam(Param2itemMatch partialMatch)
public java.util.Set<java.lang.Object> getAllValuesOfparam(Trace pTrace, Item pItem)
public java.util.Set<Trace> getAllValuesOftrace()
public java.util.Set<Trace> getAllValuesOftrace(Param2itemMatch partialMatch)
public java.util.Set<Trace> getAllValuesOftrace(java.lang.Object pParam, Item pItem)
public java.util.Set<Item> getAllValuesOfitem()
public java.util.Set<Item> getAllValuesOfitem(Param2itemMatch partialMatch)
public java.util.Set<Item> getAllValuesOfitem(java.lang.Object pParam, Trace pTrace)
public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<Param2itemMatcher> querySpecification() throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if the pattern definition could not be loaded