org.eclipse.viatra.cep.core.engine.runtime

Class TokenEntersTimedZoneMatcher

java.lang.Object

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

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

org.eclipse.viatra.cep.core.engine.runtime.TokenEntersTimedZoneMatcher

All Implemented Interfaces:

ViatraQueryMatcher<TokenEntersTimedZoneMatch>

public class TokenEntersTimedZoneMatcher
extends BaseMatcher<TokenEntersTimedZoneMatch>

Generated pattern matcher API of the org.eclipse.viatra.cep.core.engine.runtime.tokenEntersTimedZone 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 TokenEntersTimedZoneMatch.

Original source:

 ////////////TIMING PATTERNS////////////
 
 pattern tokenEntersTimedZone(eventToken : EventToken, state : State, timedZone : TimedZone) {
        EventToken.currentState(eventToken, state);
        State.inStateOf(state, timedZone);
 }
 

See Also:

TokenEntersTimedZoneMatch, TokenEntersTimedZoneProcessor, TokenEntersTimedZoneQuerySpecification

Field Summary

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

engine, querySpecification

Fields inherited from class org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper

backend

Method Summary

Modifier and Type	Method and Description
protected TokenEntersTimedZoneMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected TokenEntersTimedZoneMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(EventToken pEventToken, State pState, TimedZone pTimedZone) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static TokenEntersTimedZoneMatcher	create()
void	forEachMatch(EventToken pEventToken, State pState, TimedZone pTimedZone, IMatchProcessor<? super TokenEntersTimedZoneMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(EventToken pEventToken, State pState, TimedZone pTimedZone, IMatchProcessor<? super TokenEntersTimedZoneMatch> 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<TokenEntersTimedZoneMatch>	getAllMatches(EventToken pEventToken, State pState, TimedZone pTimedZone) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<EventToken>	getAllValuesOfeventToken() Retrieve the set of values that occur in matches for eventToken.
java.util.Set<EventToken>	getAllValuesOfeventToken(State pState, TimedZone pTimedZone) Retrieve the set of values that occur in matches for eventToken.
java.util.Set<EventToken>	getAllValuesOfeventToken(TokenEntersTimedZoneMatch partialMatch) Retrieve the set of values that occur in matches for eventToken.
java.util.Set<State>	getAllValuesOfstate() Retrieve the set of values that occur in matches for state.
java.util.Set<State>	getAllValuesOfstate(EventToken pEventToken, TimedZone pTimedZone) Retrieve the set of values that occur in matches for state.
java.util.Set<State>	getAllValuesOfstate(TokenEntersTimedZoneMatch partialMatch) Retrieve the set of values that occur in matches for state.
java.util.Set<TimedZone>	getAllValuesOftimedZone() Retrieve the set of values that occur in matches for timedZone.
java.util.Set<TimedZone>	getAllValuesOftimedZone(EventToken pEventToken, State pState) Retrieve the set of values that occur in matches for timedZone.
java.util.Set<TimedZone>	getAllValuesOftimedZone(TokenEntersTimedZoneMatch partialMatch) Retrieve the set of values that occur in matches for timedZone.
TokenEntersTimedZoneMatch	getOneArbitraryMatch(EventToken pEventToken, State pState, TimedZone pTimedZone) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(EventToken pEventToken, State pState, TimedZone pTimedZone) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
TokenEntersTimedZoneMatch	newMatch(EventToken pEventToken, State pState, TimedZone pTimedZone) Returns a new (partial) match.
static TokenEntersTimedZoneMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<TokenEntersTimedZoneMatcher>	querySpecification()
protected java.util.Set<EventToken>	rawAccumulateAllValuesOfeventToken(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for eventToken.
protected java.util.Set<State>	rawAccumulateAllValuesOfstate(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for state.
protected java.util.Set<TimedZone>	rawAccumulateAllValuesOftimedZone(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for timedZone.
protected TokenEntersTimedZoneMatch	tupleToMatch(Tuple t)

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

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

Methods inherited from class java.lang.Object

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

Method Detail

on

public static TokenEntersTimedZoneMatcher on(ViatraQueryEngine engine)
                                      throws 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:

ViatraQueryException - if an error occurs during pattern matcher creation

create

public static TokenEntersTimedZoneMatcher create()
                                          throws ViatraQueryException

Returns:

an initialized matcher

Throws:

ViatraQueryException - if an error occurs during pattern matcher creation

No Reference:

This method is for internal matcher initialization by the framework, do not call it manually.

getAllMatches

public java.util.Collection<TokenEntersTimedZoneMatch> getAllMatches(EventToken pEventToken,
                                                                     State pState,
                                                                     TimedZone pTimedZone)

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

Parameters:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

Returns:

matches represented as a TokenEntersTimedZoneMatch object.

getOneArbitraryMatch

public TokenEntersTimedZoneMatch getOneArbitraryMatch(EventToken pEventToken,
                                                      State pState,
                                                      TimedZone pTimedZone)

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:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(EventToken pEventToken,
                        State pState,
                        TimedZone pTimedZone)

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:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

Returns:

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

countMatches

public int countMatches(EventToken pEventToken,
                        State pState,
                        TimedZone pTimedZone)

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

Parameters:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(EventToken pEventToken,
                         State pState,
                         TimedZone pTimedZone,
                         IMatchProcessor<? super TokenEntersTimedZoneMatch> processor)

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

Parameters:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(EventToken pEventToken,
                                    State pState,
                                    TimedZone pTimedZone,
                                    IMatchProcessor<? super TokenEntersTimedZoneMatch> 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:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, 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 TokenEntersTimedZoneMatch newMatch(EventToken pEventToken,
                                          State pState,
                                          TimedZone pTimedZone)

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:

pEventToken - the fixed value of pattern parameter eventToken, or null if not bound.

pState - the fixed value of pattern parameter state, or null if not bound.

pTimedZone - the fixed value of pattern parameter timedZone, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfeventToken

protected java.util.Set<EventToken> rawAccumulateAllValuesOfeventToken(java.lang.Object[] parameters)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfeventToken

public java.util.Set<EventToken> getAllValuesOfeventToken()

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfeventToken

public java.util.Set<EventToken> getAllValuesOfeventToken(TokenEntersTimedZoneMatch partialMatch)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfeventToken

public java.util.Set<EventToken> getAllValuesOfeventToken(State pState,
                                                          TimedZone pTimedZone)

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

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOfstate

protected java.util.Set<State> rawAccumulateAllValuesOfstate(java.lang.Object[] parameters)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfstate

public java.util.Set<State> getAllValuesOfstate()

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfstate

public java.util.Set<State> getAllValuesOfstate(TokenEntersTimedZoneMatch partialMatch)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOfstate

public java.util.Set<State> getAllValuesOfstate(EventToken pEventToken,
                                                TimedZone pTimedZone)

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

Returns:

the Set of all values or empty set if there are no matches

rawAccumulateAllValuesOftimedZone

protected java.util.Set<TimedZone> rawAccumulateAllValuesOftimedZone(java.lang.Object[] parameters)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftimedZone

public java.util.Set<TimedZone> getAllValuesOftimedZone()

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftimedZone

public java.util.Set<TimedZone> getAllValuesOftimedZone(TokenEntersTimedZoneMatch partialMatch)

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

Returns:

the Set of all values or empty set if there are no matches

getAllValuesOftimedZone

public java.util.Set<TimedZone> getAllValuesOftimedZone(EventToken pEventToken,
                                                        State pState)

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

Returns:

the Set of all values or empty set if there are no matches

tupleToMatch

protected TokenEntersTimedZoneMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<TokenEntersTimedZoneMatch>

arrayToMatch

protected TokenEntersTimedZoneMatch arrayToMatch(java.lang.Object[] match)

Description copied from class: BaseMatcher

Converts the array representation of a pattern match to an immutable Match object.

Specified by:

arrayToMatch in class BaseMatcher<TokenEntersTimedZoneMatch>

arrayToMatchMutable

protected TokenEntersTimedZoneMatch arrayToMatchMutable(java.lang.Object[] match)

Description copied from class: BaseMatcher

Converts the array representation of a pattern match to a mutable Match object.

Specified by:

arrayToMatchMutable in class BaseMatcher<TokenEntersTimedZoneMatch>

querySpecification

public static IQuerySpecification<TokenEntersTimedZoneMatcher> querySpecification()
                                                                           throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded