org.eclipse.viatra.integration.uml.derivedfeatures

Class NamedElementQualifiedNameMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.NamedElementQualifiedNameMatcher

All Implemented Interfaces:

ViatraQueryMatcher<NamedElementQualifiedNameMatch>

public class NamedElementQualifiedNameMatcher
extends BaseMatcher<NamedElementQualifiedNameMatch>

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

Original source:

 (if self.name  < > null and self.allNamespaces()- >select( ns | ns.name=null )- >isEmpty()
 then 
     self.allNamespaces()- >iterate( ns : Namespace; agg: String = self.name | ns.name.concat(self.separator()).concat(agg))
 else
    null
 endif)
 
  @Surrogate(feature = "qualifiedName")
  @QueryExplorer(checked = false)
 pattern namedElementQualifiedName(namedElement: NamedElement, qualifiedName) {
     neg find internalNamedElementNamespace(namedElement, _);
     NamedElement.name(namedElement, qualifiedName);
     // qualifiedName is null if any of the names are empty!
     qualifiedName != "";
 } or {
     find internalNamedElementNamespace(namedElement, namespace);
     NamedElement.name(namedElement, name);
     // qualifiedName is null if any of the names are empty!
     name != "";
     find namedElementQualifiedName(namespace, namespaceQualifiedName);
     qualifiedName == eval(namespaceQualifiedName + "::" + name); // XXX is separator always this?
 }
 

See Also:

NamedElementQualifiedNameMatch, NamedElementQualifiedNameProcessor, NamedElementQualifiedNameQuerySpecification

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

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

Parameters:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, or null if not bound.

Returns:

matches represented as a NamedElementQualifiedNameMatch object.

getOneArbitraryMatch

public NamedElementQualifiedNameMatch getOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pNamedElement,
                                                           java.lang.String pQualifiedName)

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:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.NamedElement pNamedElement,
                        java.lang.String pQualifiedName)

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:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, 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.NamedElement pNamedElement,
                        java.lang.String pQualifiedName)

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

Parameters:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.NamedElement pNamedElement,
                         java.lang.String pQualifiedName,
                         IMatchProcessor<? super NamedElementQualifiedNameMatch> processor)

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

Parameters:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pNamedElement,
                                    java.lang.String pQualifiedName,
                                    IMatchProcessor<? super NamedElementQualifiedNameMatch> 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:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, 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 NamedElementQualifiedNameMatch newMatch(org.eclipse.uml2.uml.NamedElement pNamedElement,
                                               java.lang.String pQualifiedName)

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:

pNamedElement - the fixed value of pattern parameter namedElement, or null if not bound.

pQualifiedName - the fixed value of pattern parameter qualifiedName, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfnamedElement

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

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

Returns:

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

getAllValuesOfnamedElement

public java.util.Set<org.eclipse.uml2.uml.NamedElement> getAllValuesOfnamedElement()

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

Returns:

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

getAllValuesOfnamedElement

public java.util.Set<org.eclipse.uml2.uml.NamedElement> getAllValuesOfnamedElement(NamedElementQualifiedNameMatch partialMatch)

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

Returns:

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

getAllValuesOfnamedElement

public java.util.Set<org.eclipse.uml2.uml.NamedElement> getAllValuesOfnamedElement(java.lang.String pQualifiedName)

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

Returns:

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

rawAccumulateAllValuesOfqualifiedName

protected java.util.Set<java.lang.String> rawAccumulateAllValuesOfqualifiedName(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfqualifiedName

public java.util.Set<java.lang.String> getAllValuesOfqualifiedName()

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

Returns:

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

getAllValuesOfqualifiedName

public java.util.Set<java.lang.String> getAllValuesOfqualifiedName(NamedElementQualifiedNameMatch partialMatch)

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

Returns:

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

getAllValuesOfqualifiedName

public java.util.Set<java.lang.String> getAllValuesOfqualifiedName(org.eclipse.uml2.uml.NamedElement pNamedElement)

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

Returns:

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

tupleToMatch

protected NamedElementQualifiedNameMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<NamedElementQualifiedNameMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<NamedElementQualifiedNameMatcher> querySpecification()
                                                                                throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded