org.eclipse.viatra.cep.core.metamodels.derived

Class InitialStateMatcher

java.lang.Object

org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper

org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<InitialStateMatch>

org.eclipse.viatra.cep.core.metamodels.derived.InitialStateMatcher

All Implemented Interfaces:

org.eclipse.viatra.query.runtime.api.ViatraQueryMatcher<InitialStateMatch>

public class InitialStateMatcher
extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<InitialStateMatch>

Generated pattern matcher API of the org.eclipse.viatra.cep.core.metamodels.derived.initialState pattern, providing pattern-specific query methods.

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 InitialStateMatch.

Original source:

 @QueryBasedFeature
 pattern initialState(this : Automaton, initState : InitState){
        Automaton.states(this, initState);
 }
 

See Also:

InitialStateMatch, InitialStateProcessor, InitialStateQuerySpecification

Method Summary

Methods

Modifier and Type	Method and Description
int	countMatches(Automaton pThis, InitState pInitState) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
void	forEachMatch(Automaton pThis, InitState pInitState, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super InitialStateMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(Automaton pThis, InitState pInitState, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super InitialStateMatch> 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<InitialStateMatch>	getAllMatches(Automaton pThis, InitState pInitState) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<InitState>	getAllValuesOfinitState() Retrieve the set of values that occur in matches for initState.
java.util.Set<InitState>	getAllValuesOfinitState(Automaton pThis) Retrieve the set of values that occur in matches for initState.
java.util.Set<InitState>	getAllValuesOfinitState(InitialStateMatch partialMatch) Retrieve the set of values that occur in matches for initState.
java.util.Set<Automaton>	getAllValuesOfthis() Retrieve the set of values that occur in matches for this.
java.util.Set<Automaton>	getAllValuesOfthis(InitialStateMatch partialMatch) Retrieve the set of values that occur in matches for this.
java.util.Set<Automaton>	getAllValuesOfthis(InitState pInitState) Retrieve the set of values that occur in matches for this.
InitialStateMatch	getOneArbitraryMatch(Automaton pThis, InitState pInitState) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(Automaton pThis, InitState pInitState) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
InitialStateMatch	newMatch(Automaton pThis, InitState pInitState) Returns a new (partial) match.
static InitialStateMatcher	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<InitialStateMatcher>	querySpecification()

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseMatcher

countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

on

public static InitialStateMatcher on(org.eclipse.viatra.query.runtime.api.ViatraQueryEngine engine)
                              throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException

Initializes the pattern matcher within an existing VIATRA Query engine. If the pattern matcher is already constructed in the engine, only a light-weight reference is returned. The match set will be incrementally refreshed upon updates.

Parameters:

engine - the existing VIATRA Query engine in which this matcher will be created.

Throws:

org.eclipse.viatra.query.runtime.exception.ViatraQueryException - if an error occurs during pattern matcher creation

getAllMatches

public java.util.Collection<InitialStateMatch> getAllMatches(Automaton pThis,
                                                    InitState pInitState)

Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

Returns:

matches represented as a InitialStateMatch object.

getOneArbitraryMatch

public InitialStateMatch getOneArbitraryMatch(Automaton pThis,
                                     InitState pInitState)

Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

Returns:

a match represented as a InitialStateMatch object, or null if no match is found.

hasMatch

public boolean hasMatch(Automaton pThis,
               InitState pInitState)

Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

Returns:

true if the input is a valid (partial) match of the pattern.

countMatches

public int countMatches(Automaton pThis,
               InitState pInitState)

Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(Automaton pThis,
                InitState pInitState,
                org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super InitialStateMatch> processor)

Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(Automaton pThis,
                           InitState pInitState,
                           org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super InitialStateMatch> processor)

Executes the given processor on an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

processor - the action that will process the selected match.

Returns:

true if the pattern has at least one match with the given parameter values, false if the processor was not invoked

newMatch

public InitialStateMatch newMatch(Automaton pThis,
                         InitState pInitState)

Returns a new (partial) match. This can be used e.g. to call the matcher with a partial match.

The returned match will be immutable. Use BaseMatcher.newEmptyMatch() to obtain a mutable match object.

Parameters:

pThis - the fixed value of pattern parameter this, or null if not bound.

pInitState - the fixed value of pattern parameter initState, or null if not bound.

Returns:

the (partial) match object.

getAllValuesOfthis

public java.util.Set<Automaton> getAllValuesOfthis()

Retrieve the set of values that occur in matches for this.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfthis

public java.util.Set<Automaton> getAllValuesOfthis(InitialStateMatch partialMatch)

Retrieve the set of values that occur in matches for this.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfthis

public java.util.Set<Automaton> getAllValuesOfthis(InitState pInitState)

Retrieve the set of values that occur in matches for this.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfinitState

public java.util.Set<InitState> getAllValuesOfinitState()

Retrieve the set of values that occur in matches for initState.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfinitState

public java.util.Set<InitState> getAllValuesOfinitState(InitialStateMatch partialMatch)

Retrieve the set of values that occur in matches for initState.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfinitState

public java.util.Set<InitState> getAllValuesOfinitState(Automaton pThis)

Retrieve the set of values that occur in matches for initState.

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

querySpecification

public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<InitialStateMatcher> querySpecification()
                                                                                                        throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

org.eclipse.viatra.query.runtime.exception.ViatraQueryException - if the pattern definition could not be loaded