public class Param2edgeMatcher extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<Param2edgeMatch>
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 Param2edgeMatch
.
Original source:
@QueryExplorer(checked = false)
pattern param2edge(source, target, trace, edge : Edge) {
Trace.params(trace, source);
Trace.params(trace, target);
Trace.targets(trace, edge);
} or {
Trace.objects(trace, source);
Trace.params(trace, target);
Trace.targets(trace, edge);
} or {
Trace.params(trace, source);
Trace.objects(trace, target);
Trace.targets(trace, edge);
} or {
Trace.objects(trace, source);
Trace.objects(trace, target);
Trace.targets(trace, edge);
}
Param2edgeMatch
,
Param2edgeProcessor
,
Param2edgeQuerySpecification
Modifier and Type | Method and Description |
---|---|
int |
countMatches(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
|
void |
forEachMatch(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2edgeMatch> 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 pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2edgeMatch> 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<Param2edgeMatch> |
getAllMatches(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
|
java.util.Set<Edge> |
getAllValuesOfedge()
Retrieve the set of values that occur in matches for edge.
|
java.util.Set<Edge> |
getAllValuesOfedge(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace)
Retrieve the set of values that occur in matches for edge.
|
java.util.Set<Edge> |
getAllValuesOfedge(Param2edgeMatch partialMatch)
Retrieve the set of values that occur in matches for edge.
|
java.util.Set<java.lang.Object> |
getAllValuesOfsource()
Retrieve the set of values that occur in matches for source.
|
java.util.Set<java.lang.Object> |
getAllValuesOfsource(java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Retrieve the set of values that occur in matches for source.
|
java.util.Set<java.lang.Object> |
getAllValuesOfsource(Param2edgeMatch partialMatch)
Retrieve the set of values that occur in matches for source.
|
java.util.Set<java.lang.Object> |
getAllValuesOftarget()
Retrieve the set of values that occur in matches for target.
|
java.util.Set<java.lang.Object> |
getAllValuesOftarget(java.lang.Object pSource,
Trace pTrace,
Edge pEdge)
Retrieve the set of values that occur in matches for target.
|
java.util.Set<java.lang.Object> |
getAllValuesOftarget(Param2edgeMatch 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(java.lang.Object pSource,
java.lang.Object pTarget,
Edge pEdge)
Retrieve the set of values that occur in matches for trace.
|
java.util.Set<Trace> |
getAllValuesOftrace(Param2edgeMatch partialMatch)
Retrieve the set of values that occur in matches for trace.
|
Param2edgeMatch |
getOneArbitraryMatch(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
hasMatch(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Indicates whether the given combination of specified pattern parameters constitute a valid pattern match,
under any possible substitution of the unspecified parameters (if any).
|
Param2edgeMatch |
newMatch(java.lang.Object pSource,
java.lang.Object pTarget,
Trace pTrace,
Edge pEdge)
Returns a new (partial) match.
|
static Param2edgeMatcher |
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<Param2edgeMatcher> |
querySpecification() |
countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch
public static Param2edgeMatcher 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<Param2edgeMatch> getAllMatches(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.public Param2edgeMatch getOneArbitraryMatch(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.public boolean hasMatch(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.public int countMatches(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.public void forEachMatch(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2edgeMatch> processor)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.processor
- the action that will process each pattern match.public boolean forOneArbitraryMatch(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super Param2edgeMatch> processor)
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.processor
- the action that will process the selected match.public Param2edgeMatch newMatch(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace, Edge pEdge)
The returned match will be immutable. Use BaseMatcher.newEmptyMatch()
to obtain a mutable match object.
pSource
- the fixed value of pattern parameter source, 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.pEdge
- the fixed value of pattern parameter edge, or null if not bound.public java.util.Set<java.lang.Object> getAllValuesOfsource()
public java.util.Set<java.lang.Object> getAllValuesOfsource(Param2edgeMatch partialMatch)
public java.util.Set<java.lang.Object> getAllValuesOfsource(java.lang.Object pTarget, Trace pTrace, Edge pEdge)
public java.util.Set<java.lang.Object> getAllValuesOftarget()
public java.util.Set<java.lang.Object> getAllValuesOftarget(Param2edgeMatch partialMatch)
public java.util.Set<java.lang.Object> getAllValuesOftarget(java.lang.Object pSource, Trace pTrace, Edge pEdge)
public java.util.Set<Trace> getAllValuesOftrace()
public java.util.Set<Trace> getAllValuesOftrace(Param2edgeMatch partialMatch)
public java.util.Set<Trace> getAllValuesOftrace(java.lang.Object pSource, java.lang.Object pTarget, Edge pEdge)
public java.util.Set<Edge> getAllValuesOfedge()
public java.util.Set<Edge> getAllValuesOfedge(Param2edgeMatch partialMatch)
public java.util.Set<Edge> getAllValuesOfedge(java.lang.Object pSource, java.lang.Object pTarget, Trace pTrace)
public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<Param2edgeMatcher> querySpecification() throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if the pattern definition could not be loaded