org.eclipse.viatra.integration.uml.derivedfeatures

Class PropertyIsCompositeMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.PropertyIsCompositeMatcher

All Implemented Interfaces:

ViatraQueryMatcher<PropertyIsCompositeMatch>

public class PropertyIsCompositeMatcher
extends BaseMatcher<PropertyIsCompositeMatch>

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

Original source:

 (aggregation = AggregationKind::composite)
 
  @Surrogate(feature = "isComposite")
  @QueryExplorer(checked = false)
 pattern propertyIsComposite(
     property : Property, isComposite
 ) {
     Property.aggregation(property, AggregationKind::composite);
     isComposite == true;
 } or {
     Property.aggregation(property, aggregation);
     aggregation != AggregationKind::composite;
     isComposite == false;
 }
 

See Also:

PropertyIsCompositeMatch, PropertyIsCompositeProcessor, PropertyIsCompositeQuerySpecification

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

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

Parameters:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, or null if not bound.

Returns:

matches represented as a PropertyIsCompositeMatch object.

getOneArbitraryMatch

public PropertyIsCompositeMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Property pProperty,
                                                     java.lang.Boolean pIsComposite)

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:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.Property pProperty,
                        java.lang.Boolean pIsComposite)

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:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, 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.Property pProperty,
                        java.lang.Boolean pIsComposite)

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

Parameters:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.Property pProperty,
                         java.lang.Boolean pIsComposite,
                         IMatchProcessor<? super PropertyIsCompositeMatch> processor)

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

Parameters:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Property pProperty,
                                    java.lang.Boolean pIsComposite,
                                    IMatchProcessor<? super PropertyIsCompositeMatch> 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:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, 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 PropertyIsCompositeMatch newMatch(org.eclipse.uml2.uml.Property pProperty,
                                         java.lang.Boolean pIsComposite)

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:

pProperty - the fixed value of pattern parameter property, or null if not bound.

pIsComposite - the fixed value of pattern parameter isComposite, or null if not bound.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfproperty

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

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

Returns:

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

getAllValuesOfproperty

public java.util.Set<org.eclipse.uml2.uml.Property> getAllValuesOfproperty()

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

Returns:

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

getAllValuesOfproperty

public java.util.Set<org.eclipse.uml2.uml.Property> getAllValuesOfproperty(PropertyIsCompositeMatch partialMatch)

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

Returns:

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

getAllValuesOfproperty

public java.util.Set<org.eclipse.uml2.uml.Property> getAllValuesOfproperty(java.lang.Boolean pIsComposite)

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

Returns:

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

rawAccumulateAllValuesOfisComposite

protected java.util.Set<java.lang.Boolean> rawAccumulateAllValuesOfisComposite(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfisComposite

public java.util.Set<java.lang.Boolean> getAllValuesOfisComposite()

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

Returns:

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

getAllValuesOfisComposite

public java.util.Set<java.lang.Boolean> getAllValuesOfisComposite(PropertyIsCompositeMatch partialMatch)

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

Returns:

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

getAllValuesOfisComposite

public java.util.Set<java.lang.Boolean> getAllValuesOfisComposite(org.eclipse.uml2.uml.Property pProperty)

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

Returns:

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

tupleToMatch

protected PropertyIsCompositeMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<PropertyIsCompositeMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<PropertyIsCompositeMatcher> querySpecification()
                                                                          throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded