org.eclipse.incquery.uml.derivedfeatures

Class NamedElementQualifiedNameMatcher

java.lang.Object

org.eclipse.incquery.runtime.internal.apiimpl.QueryResultWrapper

org.eclipse.incquery.runtime.api.impl.BaseMatcher<NamedElementQualifiedNameMatch>

org.eclipse.incquery.uml.derivedfeatures.NamedElementQualifiedNameMatcher

All Implemented Interfaces:

IncQueryMatcher<NamedElementQualifiedNameMatch>

public class NamedElementQualifiedNameMatcher
extends BaseMatcher<NamedElementQualifiedNameMatch>

Generated pattern matcher API of the org.eclipse.incquery.uml.derivedfeatures.namedElementQualifiedName pattern, providing pattern-specific query methods.

Use the pattern matcher on a given model via on(IncQueryEngine), e.g. in conjunction with IncQueryEngine.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

Constructor Summary

Constructors

Constructor and Description
NamedElementQualifiedNameMatcher(IncQueryEngine engine) Deprecated. use on(IncQueryEngine) instead
NamedElementQualifiedNameMatcher(org.eclipse.emf.common.notify.Notifier emfRoot) Deprecated. use on(IncQueryEngine) instead, e.g. in conjunction with IncQueryEngine.on(Notifier)

Method Summary

Modifier and Type	Method and Description
int	countMatches(org.eclipse.uml2.uml.NamedElement pNamedElement, java.lang.Object pQualifiedName) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
void	forEachMatch(org.eclipse.uml2.uml.NamedElement pNamedElement, java.lang.Object 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.Object 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.Object 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.Object pQualifiedName) Retrieve the set of values that occur in matches for namedElement.
java.util.Set<java.lang.Object>	getAllValuesOfqualifiedName() Retrieve the set of values that occur in matches for qualifiedName.
java.util.Set<java.lang.Object>	getAllValuesOfqualifiedName(org.eclipse.uml2.uml.NamedElement pNamedElement) Retrieve the set of values that occur in matches for qualifiedName.
java.util.Set<java.lang.Object>	getAllValuesOfqualifiedName(NamedElementQualifiedNameMatch partialMatch) Retrieve the set of values that occur in matches for qualifiedName.
NamedElementQualifiedNameMatch	getOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pNamedElement, java.lang.Object 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.Object 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.Object pQualifiedName) Returns a new (partial) match.
static NamedElementQualifiedNameMatcher	on(IncQueryEngine engine) Initializes the pattern matcher within an existing EMF-IncQuery engine.
static IQuerySpecification<NamedElementQualifiedNameMatcher>	querySpecification()

Methods inherited from class org.eclipse.incquery.runtime.api.impl.BaseMatcher

countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedElementQualifiedNameMatcher

@Deprecated
public NamedElementQualifiedNameMatcher(org.eclipse.emf.common.notify.Notifier emfRoot)
                                             throws IncQueryException

Deprecated. use on(IncQueryEngine) instead, e.g. in conjunction with IncQueryEngine.on(Notifier)

Initializes the pattern matcher over a given EMF model root (recommended: Resource or ResourceSet). If a pattern matcher is already constructed with the same root, only a light-weight reference is returned. The scope of pattern matching will be the given EMF model root and below (see FAQ for more precise definition). The match set will be incrementally refreshed upon updates from this scope.

The matcher will be created within the managed IncQueryEngine belonging to the EMF model root, so multiple matchers will reuse the same engine and benefit from increased performance and reduced memory footprint.

Parameters:

emfRoot - the root of the EMF containment hierarchy where the pattern matcher will operate. Recommended: Resource or ResourceSet.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

NamedElementQualifiedNameMatcher

@Deprecated
public NamedElementQualifiedNameMatcher(IncQueryEngine engine)
                                             throws IncQueryException

Deprecated. use on(IncQueryEngine) instead

Initializes the pattern matcher within an existing EMF-IncQuery 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 EMF-IncQuery engine in which this matcher will be created.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

Method Detail

on

public static NamedElementQualifiedNameMatcher on(IncQueryEngine engine)
                                           throws IncQueryException

Initializes the pattern matcher within an existing EMF-IncQuery 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 EMF-IncQuery engine in which this matcher will be created.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

getAllMatches

public java.util.Collection<NamedElementQualifiedNameMatch> getAllMatches(org.eclipse.uml2.uml.NamedElement pNamedElement,
                                                                          java.lang.Object 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.Object 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.Object 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.Object 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.Object 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.Object 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.Object 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.

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, null if no parameter with the given name exists, 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, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfnamedElement

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

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfqualifiedName

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

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfqualifiedName

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

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfqualifiedName

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

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

querySpecification

public static IQuerySpecification<NamedElementQualifiedNameMatcher> querySpecification()
                                                                                throws IncQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

IncQueryException - if the pattern definition could not be loaded