public class FinishedAutomatonMatcher extends BaseMatcher<FinishedAutomatonMatch>
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 FinishedAutomatonMatch
.
Original source:
////////////TOKEN BASED OPERATIONS////////////
pattern finishedAutomaton(automaton : Automaton, eventToken : EventToken) {
Automaton.finalStates(automaton, finalState);
EventToken.currentState(eventToken, finalState);
}
FinishedAutomatonMatch
,
FinishedAutomatonProcessor
,
FinishedAutomatonQuerySpecification
engine, querySpecification
Modifier and Type | Method and Description |
---|---|
protected FinishedAutomatonMatch |
arrayToMatch(java.lang.Object[] match)
Converts the array representation of a pattern match to an immutable Match object.
|
protected FinishedAutomatonMatch |
arrayToMatchMutable(java.lang.Object[] match)
Converts the array representation of a pattern match to a mutable Match object.
|
int |
countMatches(Automaton pAutomaton,
EventToken pEventToken)
Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
|
static FinishedAutomatonMatcher |
create() |
void |
forEachMatch(Automaton pAutomaton,
EventToken pEventToken,
IMatchProcessor<? super FinishedAutomatonMatch> processor)
Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
forOneArbitraryMatch(Automaton pAutomaton,
EventToken pEventToken,
IMatchProcessor<? super FinishedAutomatonMatch> 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<FinishedAutomatonMatch> |
getAllMatches(Automaton pAutomaton,
EventToken pEventToken)
Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
|
java.util.Set<Automaton> |
getAllValuesOfautomaton()
Retrieve the set of values that occur in matches for automaton.
|
java.util.Set<Automaton> |
getAllValuesOfautomaton(EventToken pEventToken)
Retrieve the set of values that occur in matches for automaton.
|
java.util.Set<Automaton> |
getAllValuesOfautomaton(FinishedAutomatonMatch partialMatch)
Retrieve the set of values that occur in matches for automaton.
|
java.util.Set<EventToken> |
getAllValuesOfeventToken()
Retrieve the set of values that occur in matches for eventToken.
|
java.util.Set<EventToken> |
getAllValuesOfeventToken(Automaton pAutomaton)
Retrieve the set of values that occur in matches for eventToken.
|
java.util.Set<EventToken> |
getAllValuesOfeventToken(FinishedAutomatonMatch partialMatch)
Retrieve the set of values that occur in matches for eventToken.
|
FinishedAutomatonMatch |
getOneArbitraryMatch(Automaton pAutomaton,
EventToken pEventToken)
Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
hasMatch(Automaton pAutomaton,
EventToken pEventToken)
Indicates whether the given combination of specified pattern parameters constitute a valid pattern match,
under any possible substitution of the unspecified parameters (if any).
|
FinishedAutomatonMatch |
newMatch(Automaton pAutomaton,
EventToken pEventToken)
Returns a new (partial) match.
|
static FinishedAutomatonMatcher |
on(ViatraQueryEngine engine)
Initializes the pattern matcher within an existing VIATRA Query engine.
|
static IQuerySpecification<FinishedAutomatonMatcher> |
querySpecification() |
protected java.util.Set<Automaton> |
rawAccumulateAllValuesOfautomaton(java.lang.Object[] parameters)
Retrieve the set of values that occur in matches for automaton.
|
protected java.util.Set<EventToken> |
rawAccumulateAllValuesOfeventToken(java.lang.Object[] parameters)
Retrieve the set of values that occur in matches for eventToken.
|
protected FinishedAutomatonMatch |
tupleToMatch(Tuple t) |
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
public static FinishedAutomatonMatcher on(ViatraQueryEngine engine) throws ViatraQueryException
engine
- the existing VIATRA Query engine in which this matcher will be created.ViatraQueryException
- if an error occurs during pattern matcher creationpublic static FinishedAutomatonMatcher create() throws ViatraQueryException
ViatraQueryException
- if an error occurs during pattern matcher creationpublic java.util.Collection<FinishedAutomatonMatch> getAllMatches(Automaton pAutomaton, EventToken pEventToken)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.public FinishedAutomatonMatch getOneArbitraryMatch(Automaton pAutomaton, EventToken pEventToken)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.public boolean hasMatch(Automaton pAutomaton, EventToken pEventToken)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.public int countMatches(Automaton pAutomaton, EventToken pEventToken)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.public void forEachMatch(Automaton pAutomaton, EventToken pEventToken, IMatchProcessor<? super FinishedAutomatonMatch> processor)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.processor
- the action that will process each pattern match.public boolean forOneArbitraryMatch(Automaton pAutomaton, EventToken pEventToken, IMatchProcessor<? super FinishedAutomatonMatch> processor)
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.processor
- the action that will process the selected match.public FinishedAutomatonMatch newMatch(Automaton pAutomaton, EventToken pEventToken)
The returned match will be immutable. Use BaseMatcher.newEmptyMatch()
to obtain a mutable match object.
pAutomaton
- the fixed value of pattern parameter automaton, or null if not bound.pEventToken
- the fixed value of pattern parameter eventToken, or null if not bound.protected java.util.Set<Automaton> rawAccumulateAllValuesOfautomaton(java.lang.Object[] parameters)
public java.util.Set<Automaton> getAllValuesOfautomaton()
public java.util.Set<Automaton> getAllValuesOfautomaton(FinishedAutomatonMatch partialMatch)
public java.util.Set<Automaton> getAllValuesOfautomaton(EventToken pEventToken)
protected java.util.Set<EventToken> rawAccumulateAllValuesOfeventToken(java.lang.Object[] parameters)
public java.util.Set<EventToken> getAllValuesOfeventToken()
public java.util.Set<EventToken> getAllValuesOfeventToken(FinishedAutomatonMatch partialMatch)
public java.util.Set<EventToken> getAllValuesOfeventToken(Automaton pAutomaton)
protected FinishedAutomatonMatch tupleToMatch(Tuple t)
tupleToMatch
in class BaseMatcher<FinishedAutomatonMatch>
protected FinishedAutomatonMatch arrayToMatch(java.lang.Object[] match)
BaseMatcher
arrayToMatch
in class BaseMatcher<FinishedAutomatonMatch>
protected FinishedAutomatonMatch arrayToMatchMutable(java.lang.Object[] match)
BaseMatcher
arrayToMatchMutable
in class BaseMatcher<FinishedAutomatonMatch>
public static IQuerySpecification<FinishedAutomatonMatcher> querySpecification() throws ViatraQueryException
ViatraQueryException
- if the pattern definition could not be loaded