org.eclipse.viatra.cep.core.engine.compiler

Class FollowsPatternMatcher

java.lang.Object

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

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

org.eclipse.viatra.cep.core.engine.compiler.FollowsPatternMatcher

All Implemented Interfaces:

ViatraQueryMatcher<FollowsPatternMatch>

public class FollowsPatternMatcher
extends BaseMatcher<FollowsPatternMatch>

Generated pattern matcher API of the org.eclipse.viatra.cep.core.engine.compiler.followsPattern 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 FollowsPatternMatch.

Original source:

 pattern followsPattern(eventPattern : ComplexEventPattern) {
        find complexPattern(eventPattern, operator);
        FOLLOWS(operator);
 }
 

See Also:

FollowsPatternMatch, FollowsPatternProcessor, FollowsPatternQuerySpecification

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 FollowsPatternMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected FollowsPatternMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(ComplexEventPattern pEventPattern) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static FollowsPatternMatcher	create()
void	forEachMatch(ComplexEventPattern pEventPattern, IMatchProcessor<? super FollowsPatternMatch> 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, IMatchProcessor<? super FollowsPatternMatch> 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<FollowsPatternMatch>	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.
FollowsPatternMatch	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).
FollowsPatternMatch	newMatch(ComplexEventPattern pEventPattern) Returns a new (partial) match.
static FollowsPatternMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<FollowsPatternMatcher>	querySpecification()
protected java.util.Set<ComplexEventPattern>	rawAccumulateAllValuesOfeventPattern(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for eventPattern.
protected FollowsPatternMatch	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 FollowsPatternMatcher 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 FollowsPatternMatcher 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<FollowsPatternMatch> getAllMatches(ComplexEventPattern pEventPattern)

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

Parameters:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

Returns:

matches represented as a FollowsPatternMatch object.

getOneArbitraryMatch

public FollowsPatternMatch getOneArbitraryMatch(ComplexEventPattern pEventPattern)

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:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

Returns:

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

hasMatch

public 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).

Parameters:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

Returns:

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

countMatches

public int countMatches(ComplexEventPattern pEventPattern)

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

Parameters:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(ComplexEventPattern pEventPattern,
                         IMatchProcessor<? super FollowsPatternMatch> processor)

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

Parameters:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(ComplexEventPattern pEventPattern,
                                    IMatchProcessor<? super FollowsPatternMatch> 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:

pEventPattern - the fixed value of pattern parameter eventPattern, 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 FollowsPatternMatch newMatch(ComplexEventPattern pEventPattern)

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:

pEventPattern - the fixed value of pattern parameter eventPattern, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfeventPattern

protected java.util.Set<ComplexEventPattern> rawAccumulateAllValuesOfeventPattern(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfeventPattern

public java.util.Set<ComplexEventPattern> getAllValuesOfeventPattern()

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

Returns:

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

tupleToMatch

protected FollowsPatternMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<FollowsPatternMatch>

arrayToMatch

protected FollowsPatternMatch 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<FollowsPatternMatch>

arrayToMatchMutable

protected FollowsPatternMatch 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<FollowsPatternMatch>

querySpecification

public static IQuerySpecification<FollowsPatternMatcher> querySpecification()
                                                                     throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded