org.eclipse.viatra.integration.uml.derivedfeatures

Class MessageMessageKindMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.MessageMessageKindMatcher

All Implemented Interfaces:

ViatraQueryMatcher<MessageMessageKindMatch>

public class MessageMessageKindMatcher
extends BaseMatcher<MessageMessageKindMatch>

Generated pattern matcher API of the org.eclipse.viatra.integration.uml.derivedfeatures.messageMessageKind 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 MessageMessageKindMatch.

Original source:

 MessageOperations.getMessageKind
 
  @Surrogate(feature = "messageKind")
  @QueryExplorer(checked = false)
 pattern messageMessageKind(self: Message, messageKind: MessageKind) {
     neg find messageSendEvent(self, _);
     neg find messageReceiveEvent(self, _);
     messageKind == MessageKind::unknown;
 } or {
     neg find messageSendEvent(self, _);
     find messageReceiveEvent(self, _);
     messageKind == MessageKind::found;
 } or {
     find messageSendEvent(self, _);
     neg find messageReceiveEvent(self, _);
     messageKind == MessageKind::lost;
 } or {
     find messageSendEvent(self, _);
     find messageReceiveEvent(self, _);
     messageKind == MessageKind::complete;
 }
 

See Also:

MessageMessageKindMatch, MessageMessageKindProcessor, MessageMessageKindQuerySpecification

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 MessageMessageKindMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected MessageMessageKindMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static MessageMessageKindMatcher	create()
void	forEachMatch(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind, IMatchProcessor<? super MessageMessageKindMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind, IMatchProcessor<? super MessageMessageKindMatch> 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<MessageMessageKindMatch>	getAllMatches(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<org.eclipse.uml2.uml.MessageKind>	getAllValuesOfmessageKind() Retrieve the set of values that occur in matches for messageKind.
java.util.Set<org.eclipse.uml2.uml.MessageKind>	getAllValuesOfmessageKind(org.eclipse.uml2.uml.Message pSelf) Retrieve the set of values that occur in matches for messageKind.
java.util.Set<org.eclipse.uml2.uml.MessageKind>	getAllValuesOfmessageKind(MessageMessageKindMatch partialMatch) Retrieve the set of values that occur in matches for messageKind.
java.util.Set<org.eclipse.uml2.uml.Message>	getAllValuesOfself() Retrieve the set of values that occur in matches for self.
java.util.Set<org.eclipse.uml2.uml.Message>	getAllValuesOfself(org.eclipse.uml2.uml.MessageKind pMessageKind) Retrieve the set of values that occur in matches for self.
java.util.Set<org.eclipse.uml2.uml.Message>	getAllValuesOfself(MessageMessageKindMatch partialMatch) Retrieve the set of values that occur in matches for self.
MessageMessageKindMatch	getOneArbitraryMatch(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
MessageMessageKindMatch	newMatch(org.eclipse.uml2.uml.Message pSelf, org.eclipse.uml2.uml.MessageKind pMessageKind) Returns a new (partial) match.
static MessageMessageKindMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<MessageMessageKindMatcher>	querySpecification()
protected java.util.Set<org.eclipse.uml2.uml.MessageKind>	rawAccumulateAllValuesOfmessageKind(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for messageKind.
protected java.util.Set<org.eclipse.uml2.uml.Message>	rawAccumulateAllValuesOfself(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for self.
protected MessageMessageKindMatch	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 MessageMessageKindMatcher 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 MessageMessageKindMatcher 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<MessageMessageKindMatch> getAllMatches(org.eclipse.uml2.uml.Message pSelf,
                                                                   org.eclipse.uml2.uml.MessageKind pMessageKind)

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

Parameters:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

Returns:

matches represented as a MessageMessageKindMatch object.

getOneArbitraryMatch

public MessageMessageKindMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Message pSelf,
                                                    org.eclipse.uml2.uml.MessageKind pMessageKind)

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:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.Message pSelf,
                        org.eclipse.uml2.uml.MessageKind pMessageKind)

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:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

Returns:

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

countMatches

public int countMatches(org.eclipse.uml2.uml.Message pSelf,
                        org.eclipse.uml2.uml.MessageKind pMessageKind)

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

Parameters:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.Message pSelf,
                         org.eclipse.uml2.uml.MessageKind pMessageKind,
                         IMatchProcessor<? super MessageMessageKindMatch> processor)

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

Parameters:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Message pSelf,
                                    org.eclipse.uml2.uml.MessageKind pMessageKind,
                                    IMatchProcessor<? super MessageMessageKindMatch> 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:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, 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 MessageMessageKindMatch newMatch(org.eclipse.uml2.uml.Message pSelf,
                                        org.eclipse.uml2.uml.MessageKind pMessageKind)

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:

pSelf - the fixed value of pattern parameter self, or null if not bound.

pMessageKind - the fixed value of pattern parameter messageKind, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfself

protected java.util.Set<org.eclipse.uml2.uml.Message> rawAccumulateAllValuesOfself(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfself

public java.util.Set<org.eclipse.uml2.uml.Message> getAllValuesOfself()

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

Returns:

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

getAllValuesOfself

public java.util.Set<org.eclipse.uml2.uml.Message> getAllValuesOfself(MessageMessageKindMatch partialMatch)

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

Returns:

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

getAllValuesOfself

public java.util.Set<org.eclipse.uml2.uml.Message> getAllValuesOfself(org.eclipse.uml2.uml.MessageKind pMessageKind)

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

Returns:

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

rawAccumulateAllValuesOfmessageKind

protected java.util.Set<org.eclipse.uml2.uml.MessageKind> rawAccumulateAllValuesOfmessageKind(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfmessageKind

public java.util.Set<org.eclipse.uml2.uml.MessageKind> getAllValuesOfmessageKind()

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

Returns:

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

getAllValuesOfmessageKind

public java.util.Set<org.eclipse.uml2.uml.MessageKind> getAllValuesOfmessageKind(MessageMessageKindMatch partialMatch)

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

Returns:

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

getAllValuesOfmessageKind

public java.util.Set<org.eclipse.uml2.uml.MessageKind> getAllValuesOfmessageKind(org.eclipse.uml2.uml.Message pSelf)

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

Returns:

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

tupleToMatch

protected MessageMessageKindMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<MessageMessageKindMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<MessageMessageKindMatcher> querySpecification()
                                                                         throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded