org.eclipse.viatra.integration.uml.derivedfeatures

Class PackageNestingPackageMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.PackageNestingPackageMatcher

All Implemented Interfaces:

ViatraQueryMatcher<PackageNestingPackageMatch>

public class PackageNestingPackageMatcher
extends BaseMatcher<PackageNestingPackageMatch>

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

Original source:

  @Surrogate(feature = "nestingPackage")
  @QueryExplorer(checked = false)
 pattern packageNestingPackage(nested: Package, nesting: Package) {
     find packageNestedPackage(nesting, nested);
 }
 

See Also:

PackageNestingPackageMatch, PackageNestingPackageProcessor, PackageNestingPackageQuerySpecification

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

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

Parameters:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, or null if not bound.

Returns:

matches represented as a PackageNestingPackageMatch object.

getOneArbitraryMatch

public PackageNestingPackageMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Package pNested,
                                                       org.eclipse.uml2.uml.Package pNesting)

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:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.Package pNested,
                        org.eclipse.uml2.uml.Package pNesting)

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:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, 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.Package pNested,
                        org.eclipse.uml2.uml.Package pNesting)

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

Parameters:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.Package pNested,
                         org.eclipse.uml2.uml.Package pNesting,
                         IMatchProcessor<? super PackageNestingPackageMatch> processor)

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

Parameters:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Package pNested,
                                    org.eclipse.uml2.uml.Package pNesting,
                                    IMatchProcessor<? super PackageNestingPackageMatch> 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:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, 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 PackageNestingPackageMatch newMatch(org.eclipse.uml2.uml.Package pNested,
                                           org.eclipse.uml2.uml.Package pNesting)

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:

pNested - the fixed value of pattern parameter nested, or null if not bound.

pNesting - the fixed value of pattern parameter nesting, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfnested

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

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

Returns:

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

getAllValuesOfnested

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnested()

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

Returns:

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

getAllValuesOfnested

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnested(PackageNestingPackageMatch partialMatch)

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

Returns:

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

getAllValuesOfnested

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnested(org.eclipse.uml2.uml.Package pNesting)

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

Returns:

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

rawAccumulateAllValuesOfnesting

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

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

Returns:

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

getAllValuesOfnesting

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnesting()

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

Returns:

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

getAllValuesOfnesting

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnesting(PackageNestingPackageMatch partialMatch)

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

Returns:

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

getAllValuesOfnesting

public java.util.Set<org.eclipse.uml2.uml.Package> getAllValuesOfnesting(org.eclipse.uml2.uml.Package pNested)

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

Returns:

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

tupleToMatch

protected PackageNestingPackageMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<PackageNestingPackageMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<PackageNestingPackageMatcher> querySpecification()
                                                                            throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded