org.eclipse.incquery.viewmodel.traceability.patterns

Class Trace2paramMatcher

java.lang.Object

org.eclipse.incquery.runtime.internal.apiimpl.QueryResultWrapper

org.eclipse.incquery.runtime.api.impl.BaseMatcher<Trace2paramMatch>

org.eclipse.incquery.viewmodel.traceability.patterns.Trace2paramMatcher

All Implemented Interfaces:

IncQueryMatcher<Trace2paramMatch>

public class Trace2paramMatcher
extends BaseMatcher<Trace2paramMatch>

Generated pattern matcher API of the org.eclipse.incquery.viewmodel.traceability.patterns.trace2param pattern, providing pattern-specific query methods.

Use the pattern matcher on a given model via on(IncQueryEngine), e.g. in conjunction with IncQueryEngine.on(Notifier).

Matches of the pattern will be represented as Trace2paramMatch.

Original source:

  @QueryExplorer(checked = false)
 pattern trace2param(param, trace, id) {
        Trace.params(trace, param);
        Trace.id(trace, id);
 }
 

See Also:

Trace2paramMatch, Trace2paramProcessor, Trace2paramQuerySpecification

Constructor Summary

Constructors

Constructor and Description
Trace2paramMatcher(IncQueryEngine engine) Deprecated. use on(IncQueryEngine) instead
Trace2paramMatcher(org.eclipse.emf.common.notify.Notifier emfRoot) Deprecated. use on(IncQueryEngine) instead, e.g. in conjunction with IncQueryEngine.on(Notifier)

Method Summary

Modifier and Type	Method and Description
int	countMatches(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
void	forEachMatch(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId, IMatchProcessor<? super Trace2paramMatch> 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.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId, IMatchProcessor<? super Trace2paramMatch> 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<Trace2paramMatch>	getAllMatches(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<java.lang.String>	getAllValuesOfid() Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(org.eclipse.emf.ecore.EObject pParam, Trace pTrace) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(Trace2paramMatch partialMatch) Retrieve the set of values that occur in matches for id.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfparam() Retrieve the set of values that occur in matches for param.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfparam(Trace2paramMatch partialMatch) Retrieve the set of values that occur in matches for param.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOfparam(Trace pTrace, java.lang.String pId) Retrieve the set of values that occur in matches for param.
java.util.Set<Trace>	getAllValuesOftrace() Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(org.eclipse.emf.ecore.EObject pParam, java.lang.String pId) Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(Trace2paramMatch partialMatch) Retrieve the set of values that occur in matches for trace.
Trace2paramMatch	getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
Trace2paramMatch	newMatch(org.eclipse.emf.ecore.EObject pParam, Trace pTrace, java.lang.String pId) Returns a new (partial) match.
static Trace2paramMatcher	on(IncQueryEngine engine) Initializes the pattern matcher within an existing EMF-IncQuery engine.
static IQuerySpecification<Trace2paramMatcher>	querySpecification()

Methods inherited from class org.eclipse.incquery.runtime.api.impl.BaseMatcher

countMatches, countMatches, forEachMatch, forEachMatch, forOneArbitraryMatch, forOneArbitraryMatch, getAllMatches, getAllMatches, getAllValues, getAllValues, getEngine, getOneArbitraryMatch, getOneArbitraryMatch, getParameterNames, getPatternName, getPositionOfParameter, getSpecification, hasMatch, newEmptyMatch, newMatch

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Trace2paramMatcher

@Deprecated
public Trace2paramMatcher(org.eclipse.emf.common.notify.Notifier emfRoot)
                               throws IncQueryException

Deprecated. use on(IncQueryEngine) instead, e.g. in conjunction with IncQueryEngine.on(Notifier)

Initializes the pattern matcher over a given EMF model root (recommended: Resource or ResourceSet). If a pattern matcher is already constructed with the same root, only a light-weight reference is returned. The scope of pattern matching will be the given EMF model root and below (see FAQ for more precise definition). The match set will be incrementally refreshed upon updates from this scope.

The matcher will be created within the managed IncQueryEngine belonging to the EMF model root, so multiple matchers will reuse the same engine and benefit from increased performance and reduced memory footprint.

Parameters:

emfRoot - the root of the EMF containment hierarchy where the pattern matcher will operate. Recommended: Resource or ResourceSet.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

Trace2paramMatcher

@Deprecated
public Trace2paramMatcher(IncQueryEngine engine)
                               throws IncQueryException

Deprecated. use on(IncQueryEngine) instead

Initializes the pattern matcher within an existing EMF-IncQuery 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 EMF-IncQuery engine in which this matcher will be created.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

Method Detail

on

public static Trace2paramMatcher on(IncQueryEngine engine)
                             throws IncQueryException

Initializes the pattern matcher within an existing EMF-IncQuery 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 EMF-IncQuery engine in which this matcher will be created.

Throws:

IncQueryException - if an error occurs during pattern matcher creation

getAllMatches

public java.util.Collection<Trace2paramMatch> getAllMatches(org.eclipse.emf.ecore.EObject pParam,
                                                            Trace pTrace,
                                                            java.lang.String pId)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

Returns:

matches represented as a Trace2paramMatch object.

getOneArbitraryMatch

public Trace2paramMatch getOneArbitraryMatch(org.eclipse.emf.ecore.EObject pParam,
                                             Trace pTrace,
                                             java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(org.eclipse.emf.ecore.EObject pParam,
                        Trace pTrace,
                        java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

Returns:

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

countMatches

public int countMatches(org.eclipse.emf.ecore.EObject pParam,
                        Trace pTrace,
                        java.lang.String pId)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(org.eclipse.emf.ecore.EObject pParam,
                         Trace pTrace,
                         java.lang.String pId,
                         IMatchProcessor<? super Trace2paramMatch> processor)

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

Parameters:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(org.eclipse.emf.ecore.EObject pParam,
                                    Trace pTrace,
                                    java.lang.String pId,
                                    IMatchProcessor<? super Trace2paramMatch> 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:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, 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 Trace2paramMatch newMatch(org.eclipse.emf.ecore.EObject pParam,
                                 Trace pTrace,
                                 java.lang.String pId)

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:

pParam - the fixed value of pattern parameter param, or null if not bound.

pTrace - the fixed value of pattern parameter trace, or null if not bound.

pId - the fixed value of pattern parameter id, or null if not bound.

Returns:

the (partial) match object.

getAllValuesOfparam

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfparam()

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfparam

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfparam(Trace2paramMatch partialMatch)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfparam

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOfparam(Trace pTrace,
                                                                        java.lang.String pId)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace()

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace(Trace2paramMatch partialMatch)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOftrace

public java.util.Set<Trace> getAllValuesOftrace(org.eclipse.emf.ecore.EObject pParam,
                                                java.lang.String pId)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid()

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid(Trace2paramMatch partialMatch)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

getAllValuesOfid

public java.util.Set<java.lang.String> getAllValuesOfid(org.eclipse.emf.ecore.EObject pParam,
                                                        Trace pTrace)

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

Returns:

the Set of all values, null if no parameter with the given name exists, empty set if there are no matches

querySpecification

public static IQuerySpecification<Trace2paramMatcher> querySpecification()
                                                                  throws IncQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

IncQueryException - if the pattern definition could not be loaded