org.eclipse.viatra.integration.uml.derivedfeatures

Class ActionOutputMatcher

java.lang.Object

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

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

org.eclipse.viatra.integration.uml.derivedfeatures.ActionOutputMatcher

All Implemented Interfaces:

ViatraQueryMatcher<ActionOutputMatch>

public class ActionOutputMatcher
extends BaseMatcher<ActionOutputMatch>

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

Original source:

  @Surrogate(feature = "output")
  @QueryExplorer(checked = false)
 pattern actionOutput(source: Action, target: OutputPin)
 { AcceptCallAction.returnInformation(source, target); } or 
 { AcceptEventAction.result(source, target); } or 
 { CallAction.result(source, target); } or 
 { ClearStructuralFeatureAction.result(source, target); } or 
 { CreateLinkObjectAction.result(source, target); } or 
 { CreateObjectAction.result(source, target); } or 
 { OpaqueAction.outputValue(source, target); } or 
 { ReadExtentAction.result(source, target); } or 
 { ReadIsClassifiedObjectAction.result(source, target); } or 
 { ReadLinkAction.result(source, target); } or 
 { ReadLinkObjectEndAction.result(source, target); } or 
 { ReadLinkObjectEndQualifierAction.result(source, target); } or 
 { ReadSelfAction.result(source, target); } or 
 { ReadStructuralFeatureAction.result(source, target); } or 
 { ReadVariableAction.result(source, target); } or 
 { ReduceAction.result(source, target); } or 
 { StructuredActivityNode.structuredNodeOutput(source, target); } or 
 { TestIdentityAction.result(source, target); } or 
 { UnmarshallAction.result(source, target); } or 
 { ValueSpecificationAction.result(source, target); } or 
 { WriteStructuralFeatureAction.result(source, target); }
 

See Also:

ActionOutputMatch, ActionOutputProcessor, ActionOutputQuerySpecification

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 ActionOutputMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected ActionOutputMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
int	countMatches(org.eclipse.uml2.uml.Action pSource, org.eclipse.uml2.uml.OutputPin pTarget) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
static ActionOutputMatcher	create()
void	forEachMatch(org.eclipse.uml2.uml.Action pSource, org.eclipse.uml2.uml.OutputPin pTarget, IMatchProcessor<? super ActionOutputMatch> 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.Action pSource, org.eclipse.uml2.uml.OutputPin pTarget, IMatchProcessor<? super ActionOutputMatch> 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<ActionOutputMatch>	getAllMatches(org.eclipse.uml2.uml.Action pSource, org.eclipse.uml2.uml.OutputPin 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.Action>	getAllValuesOfsource() Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.uml2.uml.Action>	getAllValuesOfsource(ActionOutputMatch partialMatch) Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.uml2.uml.Action>	getAllValuesOfsource(org.eclipse.uml2.uml.OutputPin pTarget) Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.uml2.uml.OutputPin>	getAllValuesOftarget() Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.uml2.uml.OutputPin>	getAllValuesOftarget(org.eclipse.uml2.uml.Action pSource) Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.uml2.uml.OutputPin>	getAllValuesOftarget(ActionOutputMatch partialMatch) Retrieve the set of values that occur in matches for target.
ActionOutputMatch	getOneArbitraryMatch(org.eclipse.uml2.uml.Action pSource, org.eclipse.uml2.uml.OutputPin 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.Action pSource, org.eclipse.uml2.uml.OutputPin 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).
ActionOutputMatch	newMatch(org.eclipse.uml2.uml.Action pSource, org.eclipse.uml2.uml.OutputPin pTarget) Returns a new (partial) match.
static ActionOutputMatcher	on(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<ActionOutputMatcher>	querySpecification()
protected java.util.Set<org.eclipse.uml2.uml.Action>	rawAccumulateAllValuesOfsource(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for source.
protected java.util.Set<org.eclipse.uml2.uml.OutputPin>	rawAccumulateAllValuesOftarget(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for target.
protected ActionOutputMatch	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 ActionOutputMatcher 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 ActionOutputMatcher 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<ActionOutputMatch> getAllMatches(org.eclipse.uml2.uml.Action pSource,
                                                             org.eclipse.uml2.uml.OutputPin pTarget)

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

Parameters:

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.

Returns:

matches represented as a ActionOutputMatch object.

getOneArbitraryMatch

public ActionOutputMatch getOneArbitraryMatch(org.eclipse.uml2.uml.Action pSource,
                                              org.eclipse.uml2.uml.OutputPin pTarget)

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:

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.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.uml2.uml.Action pSource,
                        org.eclipse.uml2.uml.OutputPin 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).

Parameters:

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.

Returns:

true if the input is a valid (partial) match of the pattern.

countMatches

public int countMatches(org.eclipse.uml2.uml.Action pSource,
                        org.eclipse.uml2.uml.OutputPin pTarget)

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

Parameters:

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.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.uml2.uml.Action pSource,
                         org.eclipse.uml2.uml.OutputPin pTarget,
                         IMatchProcessor<? super ActionOutputMatch> processor)

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

Parameters:

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.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.uml2.uml.Action pSource,
                                    org.eclipse.uml2.uml.OutputPin pTarget,
                                    IMatchProcessor<? super ActionOutputMatch> 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:

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.

Returns:

true if the pattern has at least one match with the given parameter values, false if the processor was not invoked

newMatch

public ActionOutputMatch newMatch(org.eclipse.uml2.uml.Action pSource,
                                  org.eclipse.uml2.uml.OutputPin pTarget)

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:

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.

Returns:

the (partial) match object.

rawAccumulateAllValuesOfsource

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

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

Returns:

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

getAllValuesOfsource

public java.util.Set<org.eclipse.uml2.uml.Action> getAllValuesOfsource()

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

Returns:

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

getAllValuesOfsource

public java.util.Set<org.eclipse.uml2.uml.Action> getAllValuesOfsource(ActionOutputMatch partialMatch)

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

Returns:

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

getAllValuesOfsource

public java.util.Set<org.eclipse.uml2.uml.Action> getAllValuesOfsource(org.eclipse.uml2.uml.OutputPin pTarget)

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

Returns:

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

rawAccumulateAllValuesOftarget

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

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

Returns:

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

getAllValuesOftarget

public java.util.Set<org.eclipse.uml2.uml.OutputPin> getAllValuesOftarget()

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

Returns:

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

getAllValuesOftarget

public java.util.Set<org.eclipse.uml2.uml.OutputPin> getAllValuesOftarget(ActionOutputMatch partialMatch)

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

Returns:

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

getAllValuesOftarget

public java.util.Set<org.eclipse.uml2.uml.OutputPin> getAllValuesOftarget(org.eclipse.uml2.uml.Action pSource)

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

Returns:

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

tupleToMatch

protected ActionOutputMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<ActionOutputMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<ActionOutputMatcher> querySpecification()
                                                                   throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded