public class TraceMatcher extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<TraceMatch>
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 TraceMatch
.
Original source:
@QueryExplorer(checked = false)
pattern trace(source : EObject, id, target : EObject, trace : Trace, traceabilityId) {
Trace.params(trace, source);
Trace.targets(trace, target);
Trace.id(trace,id);
Traceability.id(traceability,traceabilityId);
Traceability.traces(traceability,trace);
} or {
Trace.objects(trace, source);
Trace.targets(trace, target);
Trace.id(trace,id);
Traceability.id(traceability,traceabilityId);
Traceability.traces(traceability,trace);
}
TraceMatch
,
TraceProcessor
,
TraceQuerySpecification
Modifier and Type | Method and Description |
---|---|
int |
countMatches(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
|
void |
forEachMatch(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super TraceMatch> 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 pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super TraceMatch> 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<TraceMatch> |
getAllMatches(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
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(org.eclipse.emf.ecore.EObject pSource,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
Retrieve the set of values that occur in matches for id.
|
java.util.Set<java.lang.String> |
getAllValuesOfid(TraceMatch partialMatch)
Retrieve the set of values that occur in matches for id.
|
java.util.Set<org.eclipse.emf.ecore.EObject> |
getAllValuesOfsource()
Retrieve the set of values that occur in matches for source.
|
java.util.Set<org.eclipse.emf.ecore.EObject> |
getAllValuesOfsource(java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
Retrieve the set of values that occur in matches for source.
|
java.util.Set<org.eclipse.emf.ecore.EObject> |
getAllValuesOfsource(TraceMatch partialMatch)
Retrieve the set of values that occur in matches for source.
|
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(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
Trace pTrace,
java.lang.String pTraceabilityId)
Retrieve the set of values that occur in matches for target.
|
java.util.Set<org.eclipse.emf.ecore.EObject> |
getAllValuesOftarget(TraceMatch 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 pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
java.lang.String pTraceabilityId)
Retrieve the set of values that occur in matches for trace.
|
java.util.Set<Trace> |
getAllValuesOftrace(TraceMatch partialMatch)
Retrieve the set of values that occur in matches for trace.
|
java.util.Set<java.lang.String> |
getAllValuesOftraceabilityId()
Retrieve the set of values that occur in matches for traceabilityId.
|
java.util.Set<java.lang.String> |
getAllValuesOftraceabilityId(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace)
Retrieve the set of values that occur in matches for traceabilityId.
|
java.util.Set<java.lang.String> |
getAllValuesOftraceabilityId(TraceMatch partialMatch)
Retrieve the set of values that occur in matches for traceabilityId.
|
TraceMatch |
getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
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 pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
Indicates whether the given combination of specified pattern parameters constitute a valid pattern match,
under any possible substitution of the unspecified parameters (if any).
|
TraceMatch |
newMatch(org.eclipse.emf.ecore.EObject pSource,
java.lang.String pId,
org.eclipse.emf.ecore.EObject pTarget,
Trace pTrace,
java.lang.String pTraceabilityId)
Returns a new (partial) match.
|
static TraceMatcher |
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<TraceMatcher> |
querySpecification() |
countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch
public static TraceMatcher 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<TraceMatch> getAllMatches(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.public TraceMatch getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.public boolean hasMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.public int countMatches(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.public void forEachMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super TraceMatch> processor)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.processor
- the action that will process each pattern match.public boolean forOneArbitraryMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super TraceMatch> processor)
pSource
- the fixed value of pattern parameter source, or null if not bound.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.processor
- the action that will process the selected match.public TraceMatch newMatch(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
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.pId
- the fixed value of pattern parameter id, 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.pTraceabilityId
- the fixed value of pattern parameter traceabilityId, or null if not bound.public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource()
public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource(TraceMatch partialMatch)
public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfsource(java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
public java.util.Set<java.lang.String> getAllValuesOfid()
public java.util.Set<java.lang.String> getAllValuesOfid(TraceMatch partialMatch)
public java.util.Set<java.lang.String> getAllValuesOfid(org.eclipse.emf.ecore.EObject pSource, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId)
public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget()
public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget(TraceMatch partialMatch)
public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, Trace pTrace, java.lang.String pTraceabilityId)
public java.util.Set<Trace> getAllValuesOftrace()
public java.util.Set<Trace> getAllValuesOftrace(TraceMatch partialMatch)
public java.util.Set<Trace> getAllValuesOftrace(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, java.lang.String pTraceabilityId)
public java.util.Set<java.lang.String> getAllValuesOftraceabilityId()
public java.util.Set<java.lang.String> getAllValuesOftraceabilityId(TraceMatch partialMatch)
public java.util.Set<java.lang.String> getAllValuesOftraceabilityId(org.eclipse.emf.ecore.EObject pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace)
public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<TraceMatcher> querySpecification() throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if the pattern definition could not be loaded