public class ClassSuperClassMatcher extends org.eclipse.viatra.query.runtime.api.impl.BaseMatcher<ClassSuperClassMatch>
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 ClassSuperClassMatch
.
Original source:
(self.general()->select(oclIsKindOf(Class))->collect(oclAsType(Class))->asSet())
@Surrogate(feature = "superClass")
@QueryExplorer(checked = false)
pattern classSuperClass(source: Class, target: Class) {
find classifierGeneral(source, target);
}
ClassSuperClassMatch
,
ClassSuperClassProcessor
,
ClassSuperClassQuerySpecification
Modifier and Type | Method and Description |
---|---|
int |
countMatches(org.eclipse.uml2.uml.Class pSource,
org.eclipse.uml2.uml.Class pTarget)
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.Class pSource,
org.eclipse.uml2.uml.Class pTarget,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super ClassSuperClassMatch> 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.Class pSource,
org.eclipse.uml2.uml.Class pTarget,
org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super ClassSuperClassMatch> 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<ClassSuperClassMatch> |
getAllMatches(org.eclipse.uml2.uml.Class pSource,
org.eclipse.uml2.uml.Class pTarget)
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.Class> |
getAllValuesOfsource()
Retrieve the set of values that occur in matches for source.
|
java.util.Set<org.eclipse.uml2.uml.Class> |
getAllValuesOfsource(org.eclipse.uml2.uml.Class pTarget)
Retrieve the set of values that occur in matches for source.
|
java.util.Set<org.eclipse.uml2.uml.Class> |
getAllValuesOfsource(ClassSuperClassMatch partialMatch)
Retrieve the set of values that occur in matches for source.
|
java.util.Set<org.eclipse.uml2.uml.Class> |
getAllValuesOftarget()
Retrieve the set of values that occur in matches for target.
|
java.util.Set<org.eclipse.uml2.uml.Class> |
getAllValuesOftarget(org.eclipse.uml2.uml.Class pSource)
Retrieve the set of values that occur in matches for target.
|
java.util.Set<org.eclipse.uml2.uml.Class> |
getAllValuesOftarget(ClassSuperClassMatch partialMatch)
Retrieve the set of values that occur in matches for target.
|
ClassSuperClassMatch |
getOneArbitraryMatch(org.eclipse.uml2.uml.Class pSource,
org.eclipse.uml2.uml.Class pTarget)
Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
|
boolean |
hasMatch(org.eclipse.uml2.uml.Class pSource,
org.eclipse.uml2.uml.Class pTarget)
Indicates whether the given combination of specified pattern parameters constitute a valid pattern match,
under any possible substitution of the unspecified parameters (if any).
|
ClassSuperClassMatch |
newMatch(org.eclipse.uml2.uml.Class pSource,
org.eclipse.uml2.uml.Class pTarget)
Returns a new (partial) match.
|
static ClassSuperClassMatcher |
on(org.eclipse.viatra.query.runtime.api.ViatraQueryEngine engine)
Initializes the pattern matcher within an existing VIATRA Query engine.
|
static org.eclipse.viatra.query.runtime.api.IQuerySpecification<ClassSuperClassMatcher> |
querySpecification() |
countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch
public static ClassSuperClassMatcher on(org.eclipse.viatra.query.runtime.api.ViatraQueryEngine engine) throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
engine
- the existing VIATRA Query engine in which this matcher will be created.org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if an error occurs during pattern matcher creationpublic java.util.Collection<ClassSuperClassMatch> getAllMatches(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.public ClassSuperClassMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.public boolean hasMatch(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.public int countMatches(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.public void forEachMatch(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super ClassSuperClassMatch> processor)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.processor
- the action that will process each pattern match.public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget, org.eclipse.viatra.query.runtime.api.IMatchProcessor<? super ClassSuperClassMatch> processor)
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.processor
- the action that will process the selected match.public ClassSuperClassMatch newMatch(org.eclipse.uml2.uml.Class pSource, org.eclipse.uml2.uml.Class pTarget)
The returned match will be immutable. Use BaseMatcher.newEmptyMatch()
to obtain a mutable match object.
pSource
- the fixed value of pattern parameter source, or null if not bound.pTarget
- the fixed value of pattern parameter target, or null if not bound.public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOfsource()
public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOfsource(ClassSuperClassMatch partialMatch)
public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOfsource(org.eclipse.uml2.uml.Class pTarget)
public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOftarget()
public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOftarget(ClassSuperClassMatch partialMatch)
public java.util.Set<org.eclipse.uml2.uml.Class> getAllValuesOftarget(org.eclipse.uml2.uml.Class pSource)
public static org.eclipse.viatra.query.runtime.api.IQuerySpecification<ClassSuperClassMatcher> querySpecification() throws org.eclipse.viatra.query.runtime.exception.ViatraQueryException
org.eclipse.viatra.query.runtime.exception.ViatraQueryException
- if the pattern definition could not be loaded