NamedElementClientDependencyMatcher

java.lang.Object
- org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper
- - org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<NamedElementClientDependencyMatch>
  - - org.eclipse.viatra.integration.uml.derivedfeatures.NamedElementClientDependencyMatcher

All Implemented Interfaces:: ViatraQueryMatcher<NamedElementClientDependencyMatch>

public class NamedElementClientDependencyMatcher
extends BaseMatcher<NamedElementClientDependencyMatch>

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

Original source:

 (ownedAttribute- >select(oclIsKindOf(Port))- >collect(oclAsType(Port))- >asOrderedSet())
 
 // Can't compile OCL to VIATRA Query because of java.lang.UnsupportedOperationException: asOrderedSet
 // @Surrogate(feature = "ownedPort")
 // @QueryExplorer(checked = false)
 //pattern encapsulatedClassifierOwnedPort(source: EncapsulatedClassifier, target: Port) {}
 
 
 (ownedEnd.lowerBound() = 1)
 
 // Can't compile OCL to VIATRA Query because of org.eclipse.ocl.SemanticException: Cannot find operation (=(Integer)) for the type (Sequence(Integer))
 // @Surrogate(feature = "isRequired")
 // @QueryExplorer(checked = false)
 //pattern extensionIsRequired(source: Extension, target: Boolean) {}
 
 
 (metaclassEnd().type.oclAsType(Class))
 
 // Can't compile OCL to VIATRA Query because of java.lang.UnsupportedOperationException: metaclassEnd
 // @Surrogate(feature = "metaclass")
 // @QueryExplorer(checked = false)
 //pattern extensionMetaclass(source: Extension, target: Class) {}
 
 
 (lowerBound())
 
 // Can't compile OCL to VIATRA Query because of java.lang.UnsupportedOperationException: lowerBound
 // @Surrogate(feature = "lower")
 // @QueryExplorer(checked = false)
 //pattern multiplicityElementLower(source: MultiplicityElement, target: Integer) {}
 
 
 (upperBound())
 
 // Can't compile OCL to VIATRA Query because of java.lang.UnsupportedOperationException: upperBound
 // @Surrogate(feature = "upper")
 // @QueryExplorer(checked = false)
 //pattern multiplicityElementUpper(source: MultiplicityElement, target: UnlimitedNatural) {}
 
 
 (Dependency.allInstances()- >select(d | d.client- >includes(self)))
 
  @Surrogate(feature = "clientDependency")
  @QueryExplorer(checked = false)
 pattern namedElementClientDependency(
     self : NamedElement,
     d : Dependency
 ) {
     Dependency.client(d, namedElement);
     namedElement == self;
     Dependency(dependency);
     d == dependency;
 }

See Also:: NamedElementClientDependencyMatch, NamedElementClientDependencyProcessor, NamedElementClientDependencyQuerySpecification

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected NamedElementClientDependencyMatch`	`arrayToMatch(java.lang.Object[] match)` Converts the array representation of a pattern match to an immutable Match object.
`protected NamedElementClientDependencyMatch`	`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 pSelf, org.eclipse.uml2.uml.Dependency pD)` Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
`static NamedElementClientDependencyMatcher`	`create()`
`void`	`forEachMatch(org.eclipse.uml2.uml.NamedElement pSelf, org.eclipse.uml2.uml.Dependency pD, IMatchProcessor<? super NamedElementClientDependencyMatch> 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 pSelf, org.eclipse.uml2.uml.Dependency pD, IMatchProcessor<? super NamedElementClientDependencyMatch> 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<NamedElementClientDependencyMatch>`	`getAllMatches(org.eclipse.uml2.uml.NamedElement pSelf, org.eclipse.uml2.uml.Dependency pD)` 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.Dependency>`	`getAllValuesOfd()` Retrieve the set of values that occur in matches for d.
`java.util.Set<org.eclipse.uml2.uml.Dependency>`	`getAllValuesOfd(org.eclipse.uml2.uml.NamedElement pSelf)` Retrieve the set of values that occur in matches for d.
`java.util.Set<org.eclipse.uml2.uml.Dependency>`	`getAllValuesOfd(NamedElementClientDependencyMatch partialMatch)` Retrieve the set of values that occur in matches for d.
`java.util.Set<org.eclipse.uml2.uml.NamedElement>`	`getAllValuesOfself()` Retrieve the set of values that occur in matches for self.
`java.util.Set<org.eclipse.uml2.uml.NamedElement>`	`getAllValuesOfself(org.eclipse.uml2.uml.Dependency pD)` Retrieve the set of values that occur in matches for self.
`java.util.Set<org.eclipse.uml2.uml.NamedElement>`	`getAllValuesOfself(NamedElementClientDependencyMatch partialMatch)` Retrieve the set of values that occur in matches for self.
`NamedElementClientDependencyMatch`	`getOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pSelf, org.eclipse.uml2.uml.Dependency pD)` 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 pSelf, org.eclipse.uml2.uml.Dependency pD)` Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
`NamedElementClientDependencyMatch`	`newMatch(org.eclipse.uml2.uml.NamedElement pSelf, org.eclipse.uml2.uml.Dependency pD)` Returns a new (partial) match.
`static NamedElementClientDependencyMatcher`	`on(ViatraQueryEngine engine)` Initializes the pattern matcher within an existing VIATRA Query engine.
`static IQuerySpecification<NamedElementClientDependencyMatcher>`	`querySpecification()`
`protected java.util.Set<org.eclipse.uml2.uml.Dependency>`	`rawAccumulateAllValuesOfd(java.lang.Object[] parameters)` Retrieve the set of values that occur in matches for d.
`protected java.util.Set<org.eclipse.uml2.uml.NamedElement>`	`rawAccumulateAllValuesOfself(java.lang.Object[] parameters)` Retrieve the set of values that occur in matches for self.
`protected NamedElementClientDependencyMatch`	`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 NamedElementClientDependencyMatcher 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 NamedElementClientDependencyMatcher 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<NamedElementClientDependencyMatch> getAllMatches(org.eclipse.uml2.uml.NamedElement pSelf,
                                                                             org.eclipse.uml2.uml.Dependency pD)
```
    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.
    
    pD - the fixed value of pattern parameter d, or null if not bound.
    
    Returns:
    
    matches represented as a NamedElementClientDependencyMatch object.
  - getOneArbitraryMatch
```
public NamedElementClientDependencyMatch getOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pSelf,
                                                              org.eclipse.uml2.uml.Dependency pD)
```
    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.
    
    pD - the fixed value of pattern parameter d, or null if not bound.
    
    Returns:
    
    a match represented as a NamedElementClientDependencyMatch object, or null if no match is found.
  - hasMatch
```
public boolean hasMatch(org.eclipse.uml2.uml.NamedElement pSelf,
                        org.eclipse.uml2.uml.Dependency pD)
```
    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.
    
    pD - the fixed value of pattern parameter d, 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 pSelf,
                        org.eclipse.uml2.uml.Dependency pD)
```
    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.
    
    pD - the fixed value of pattern parameter d, or null if not bound.
    
    Returns:
    
    the number of pattern matches found.
  - forEachMatch
```
public void forEachMatch(org.eclipse.uml2.uml.NamedElement pSelf,
                         org.eclipse.uml2.uml.Dependency pD,
                         IMatchProcessor<? super NamedElementClientDependencyMatch> 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.
    
    pD - the fixed value of pattern parameter d, or null if not bound.
    
    processor - the action that will process each pattern match.
  - forOneArbitraryMatch
```
public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.NamedElement pSelf,
                                    org.eclipse.uml2.uml.Dependency pD,
                                    IMatchProcessor<? super NamedElementClientDependencyMatch> 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.
    
    pD - the fixed value of pattern parameter d, 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 NamedElementClientDependencyMatch newMatch(org.eclipse.uml2.uml.NamedElement pSelf,
                                                  org.eclipse.uml2.uml.Dependency pD)
```
    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.
    
    pD - the fixed value of pattern parameter d, or null if not bound.
    
    Returns:
    
    the (partial) match object.
  - rawAccumulateAllValuesOfself
```
protected java.util.Set<org.eclipse.uml2.uml.NamedElement> 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.NamedElement> 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.NamedElement> getAllValuesOfself(NamedElementClientDependencyMatch 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.NamedElement> getAllValuesOfself(org.eclipse.uml2.uml.Dependency pD)
```
    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
  - rawAccumulateAllValuesOfd
```
protected java.util.Set<org.eclipse.uml2.uml.Dependency> rawAccumulateAllValuesOfd(java.lang.Object[] parameters)
```
    Retrieve the set of values that occur in matches for d.
    
    Returns:
    
    the Set of all values or empty set if there are no matches
  - getAllValuesOfd
```
public java.util.Set<org.eclipse.uml2.uml.Dependency> getAllValuesOfd()
```
    Retrieve the set of values that occur in matches for d.
    
    Returns:
    
    the Set of all values or empty set if there are no matches
  - getAllValuesOfd
```
public java.util.Set<org.eclipse.uml2.uml.Dependency> getAllValuesOfd(NamedElementClientDependencyMatch partialMatch)
```
    Retrieve the set of values that occur in matches for d.
    
    Returns:
    
    the Set of all values or empty set if there are no matches
  - getAllValuesOfd
```
public java.util.Set<org.eclipse.uml2.uml.Dependency> getAllValuesOfd(org.eclipse.uml2.uml.NamedElement pSelf)
```
    Retrieve the set of values that occur in matches for d.
    
    Returns:
    
    the Set of all values or empty set if there are no matches
  - tupleToMatch
```
protected NamedElementClientDependencyMatch tupleToMatch(Tuple t)
```
    Specified by:
    
    tupleToMatch in class BaseMatcher<NamedElementClientDependencyMatch>
  - arrayToMatch
```
protected NamedElementClientDependencyMatch 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<NamedElementClientDependencyMatch>
  - arrayToMatchMutable
```
protected NamedElementClientDependencyMatch 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<NamedElementClientDependencyMatch>
  - querySpecification
```
public static IQuerySpecification<NamedElementClientDependencyMatcher> querySpecification()
                                                                                   throws ViatraQueryException
```
    Returns:
    
    the singleton instance of the query specification of this pattern
    
    Throws:
    
    ViatraQueryException - if the pattern definition could not be loaded

Class NamedElementClientDependencyMatcher

Field Summary

Fields inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseMatcher

Fields inherited from class org.eclipse.viatra.query.runtime.internal.apiimpl.QueryResultWrapper

Method Summary

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseMatcher

Methods inherited from class java.lang.Object

Method Detail

on

create

getAllMatches

getOneArbitraryMatch

hasMatch

countMatches

forEachMatch

forOneArbitraryMatch

newMatch

rawAccumulateAllValuesOfself

getAllValuesOfself

getAllValuesOfself

getAllValuesOfself

rawAccumulateAllValuesOfd

getAllValuesOfd

getAllValuesOfd

getAllValuesOfd

tupleToMatch

arrayToMatch

arrayToMatchMutable

querySpecification