org.eclipse.viatra.integration.uml.derivedfeatures

Class ConnectorKindMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.ConnectorKindMatcher

All Implemented Interfaces:

ViatraQueryMatcher<ConnectorKindMatch>

public class ConnectorKindMatcher
extends BaseMatcher<ConnectorKindMatch>

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

Original source:

 //  Fixed
 
 
 (if end- >exists(
         role.oclIsKindOf(Port) 
         and partWithPort- >isEmpty()
         and not role.oclAsType(Port).isBehavior)
 then ConnectorKind::delegation 
 else ConnectorKind::assembly 
 endif)
 
  @Surrogate(feature = "kind")
  @QueryExplorer(checked = false)
 pattern connectorKind(
     self : Connector,
     kind : ConnectorKind
 ) {
     find connectorKindDelegation(self);
     kind == ConnectorKind::delegation;
 } or {
     neg find connectorKindDelegation(self);
     kind == ConnectorKind::assembly;
 }
 

See Also:

ConnectorKindMatch, ConnectorKindProcessor, ConnectorKindQuerySpecification

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

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.

pKind - the fixed value of pattern parameter kind, or null if not bound.

Returns:

matches represented as a ConnectorKindMatch object.

getOneArbitraryMatch

public ConnectorKindMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Connector pSelf,
                                               org.eclipse.uml2.uml.ConnectorKind pKind)

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.

pKind - the fixed value of pattern parameter kind, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.Connector pSelf,
                        org.eclipse.uml2.uml.ConnectorKind pKind)

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.

pKind - the fixed value of pattern parameter kind, 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.Connector pSelf,
                        org.eclipse.uml2.uml.ConnectorKind pKind)

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.

pKind - the fixed value of pattern parameter kind, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.Connector pSelf,
                         org.eclipse.uml2.uml.ConnectorKind pKind,
                         IMatchProcessor<? super ConnectorKindMatch> 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.

pKind - the fixed value of pattern parameter kind, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Connector pSelf,
                                    org.eclipse.uml2.uml.ConnectorKind pKind,
                                    IMatchProcessor<? super ConnectorKindMatch> 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.

pKind - the fixed value of pattern parameter kind, 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 ConnectorKindMatch newMatch(org.eclipse.uml2.uml.Connector pSelf,
                                   org.eclipse.uml2.uml.ConnectorKind pKind)

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.

pKind - the fixed value of pattern parameter kind, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfself

protected java.util.Set<org.eclipse.uml2.uml.Connector> 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.Connector> 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.Connector> getAllValuesOfself(ConnectorKindMatch 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.Connector> getAllValuesOfself(org.eclipse.uml2.uml.ConnectorKind pKind)

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

rawAccumulateAllValuesOfkind

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

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

Returns:

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

getAllValuesOfkind

public java.util.Set<org.eclipse.uml2.uml.ConnectorKind> getAllValuesOfkind()

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

Returns:

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

getAllValuesOfkind

public java.util.Set<org.eclipse.uml2.uml.ConnectorKind> getAllValuesOfkind(ConnectorKindMatch partialMatch)

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

Returns:

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

getAllValuesOfkind

public java.util.Set<org.eclipse.uml2.uml.ConnectorKind> getAllValuesOfkind(org.eclipse.uml2.uml.Connector pSelf)

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

Returns:

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

tupleToMatch

protected ConnectorKindMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<ConnectorKindMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<ConnectorKindMatcher> querySpecification()
                                                                    throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded