public class OrPatternMatcher extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<OrPatternMatch>
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 OrPatternMatch
.
Original source:
pattern orPattern(eventPattern : ComplexEventPattern) {
find complexPattern(eventPattern, operator);
OR(operator);
}
OrPatternMatch
,
OrPatternProcessor
,
OrPatternQuerySpecification
Modifier and Type | Method and Description |
---|---|
int |
countMatches(ComplexEventPattern pEventPattern)
Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
|
void |
forEachMatch(ComplexEventPattern pEventPattern,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super OrPatternMatch> processor)
Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
forOneArbitraryMatch(ComplexEventPattern pEventPattern,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super OrPatternMatch> 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<OrPatternMatch> |
getAllMatches(ComplexEventPattern pEventPattern)
Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
|
java.util.Set<ComplexEventPattern> |
getAllValuesOfeventPattern()
Retrieve the set of values that occur in matches for eventPattern.
|
OrPatternMatch |
getOneArbitraryMatch(ComplexEventPattern pEventPattern)
Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
hasMatch(ComplexEventPattern pEventPattern)
Indicates whether the given combination of specified pattern parameters constitute a valid pattern match,
under any possible substitution of the unspecified parameters (if any).
|
OrPatternMatch |
newMatch(ComplexEventPattern pEventPattern)
Returns a new (partial) match.
|
static OrPatternMatcher |
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<OrPatternMatcher> |
querySpecification() |
countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch
public static OrPatternMatcher 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<OrPatternMatch> getAllMatches(ComplexEventPattern pEventPattern)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.public OrPatternMatch getOneArbitraryMatch(ComplexEventPattern pEventPattern)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.public boolean hasMatch(ComplexEventPattern pEventPattern)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.public int countMatches(ComplexEventPattern pEventPattern)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.public void forEachMatch(ComplexEventPattern pEventPattern, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super OrPatternMatch> processor)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.processor
- the action that will process each pattern match.public boolean forOneArbitraryMatch(ComplexEventPattern pEventPattern, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super OrPatternMatch> processor)
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.processor
- the action that will process the selected match.public OrPatternMatch newMatch(ComplexEventPattern pEventPattern)
The returned match will be immutable. Use BaseMatcher.newEmptyMatch()
to obtain a mutable match object.
pEventPattern
- the fixed value of pattern parameter eventPattern, or null if not bound.public java.util.Set<ComplexEventPattern> getAllValuesOfeventPattern()
public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<OrPatternMatcher> querySpecification() throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if the pattern definition could not be loaded