org.eclipse.incquery.viewmodel.traceability.patterns

Class TraceMatcher

java.lang.Object

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

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

org.eclipse.incquery.viewmodel.traceability.patterns.TraceMatcher

All Implemented Interfaces:

IncQueryMatcher<TraceMatch>

public class TraceMatcher
extends BaseMatcher<TraceMatch>

Generated pattern matcher API of the org.eclipse.incquery.viewmodel.traceability.patterns.trace 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 TraceMatch.

Original source:

  @QueryExplorer(checked = false)
 pattern trace(source, id, target, trace, traceabilityId) {
        Trace.params(trace, source);
        Trace.targets(trace, target);
        Trace.id(trace,id);
        Traceability.id(traceability,traceabilityId);
        Traceability.traces(traceability,trace);
 } or {
        Trace.objects(trace, source);
        Trace.targets(trace, target);
        Trace.id(trace,id);
        Traceability.id(traceability,traceabilityId);
        Traceability.traces(traceability,trace);
 }
 

See Also:

TraceMatch, TraceProcessor, TraceQuerySpecification

Constructor Summary

Constructors

Constructor and Description
TraceMatcher(IncQueryEngine engine) Deprecated. use on(IncQueryEngine) instead
TraceMatcher(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(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
void	forEachMatch(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, IMatchProcessor<? super TraceMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId, IMatchProcessor<? super TraceMatch> 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<TraceMatch>	getAllMatches(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) 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(java.lang.Object pSource, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.String>	getAllValuesOfid(TraceMatch partialMatch) Retrieve the set of values that occur in matches for id.
java.util.Set<java.lang.Object>	getAllValuesOfsource() Retrieve the set of values that occur in matches for source.
java.util.Set<java.lang.Object>	getAllValuesOfsource(java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for source.
java.util.Set<java.lang.Object>	getAllValuesOfsource(TraceMatch partialMatch) Retrieve the set of values that occur in matches for source.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget() Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget(java.lang.Object pSource, java.lang.String pId, Trace pTrace, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for target.
java.util.Set<org.eclipse.emf.ecore.EObject>	getAllValuesOftarget(TraceMatch partialMatch) Retrieve the set of values that occur in matches for target.
java.util.Set<Trace>	getAllValuesOftrace() Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, java.lang.String pTraceabilityId) Retrieve the set of values that occur in matches for trace.
java.util.Set<Trace>	getAllValuesOftrace(TraceMatch partialMatch) Retrieve the set of values that occur in matches for trace.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId() Retrieve the set of values that occur in matches for traceabilityId.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace) Retrieve the set of values that occur in matches for traceabilityId.
java.util.Set<java.lang.String>	getAllValuesOftraceabilityId(TraceMatch partialMatch) Retrieve the set of values that occur in matches for traceabilityId.
TraceMatch	getOneArbitraryMatch(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
TraceMatch	newMatch(java.lang.Object pSource, java.lang.String pId, org.eclipse.emf.ecore.EObject pTarget, Trace pTrace, java.lang.String pTraceabilityId) Returns a new (partial) match.
static TraceMatcher	on(IncQueryEngine engine) Initializes the pattern matcher within an existing EMF-IncQuery engine.
static IQuerySpecification<TraceMatcher>	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

TraceMatcher

@Deprecated
public TraceMatcher(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

TraceMatcher

@Deprecated
public TraceMatcher(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 TraceMatcher 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<TraceMatch> getAllMatches(java.lang.Object pSource,
                                                      java.lang.String pId,
                                                      org.eclipse.emf.ecore.EObject pTarget,
                                                      Trace pTrace,
                                                      java.lang.String pTraceabilityId)

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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

matches represented as a TraceMatch object.

getOneArbitraryMatch

public TraceMatch getOneArbitraryMatch(java.lang.Object pSource,
                                       java.lang.String pId,
                                       org.eclipse.emf.ecore.EObject pTarget,
                                       Trace pTrace,
                                       java.lang.String pTraceabilityId)

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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(java.lang.Object pSource,
                        java.lang.String pId,
                        org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace,
                        java.lang.String pTraceabilityId)

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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

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

countMatches

public int countMatches(java.lang.Object pSource,
                        java.lang.String pId,
                        org.eclipse.emf.ecore.EObject pTarget,
                        Trace pTrace,
                        java.lang.String pTraceabilityId)

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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(java.lang.Object pSource,
                         java.lang.String pId,
                         org.eclipse.emf.ecore.EObject pTarget,
                         Trace pTrace,
                         java.lang.String pTraceabilityId,
                         IMatchProcessor<? super TraceMatch> 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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(java.lang.Object pSource,
                                    java.lang.String pId,
                                    org.eclipse.emf.ecore.EObject pTarget,
                                    Trace pTrace,
                                    java.lang.String pTraceabilityId,
                                    IMatchProcessor<? super TraceMatch> 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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, 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 TraceMatch newMatch(java.lang.Object pSource,
                           java.lang.String pId,
                           org.eclipse.emf.ecore.EObject pTarget,
                           Trace pTrace,
                           java.lang.String pTraceabilityId)

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.

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

pTarget - the fixed value of pattern parameter target, or null if not bound.

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

pTraceabilityId - the fixed value of pattern parameter traceabilityId, or null if not bound.

Returns:

the (partial) match object.

getAllValuesOfsource

public java.util.Set<java.lang.Object> getAllValuesOfsource()

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

Returns:

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

getAllValuesOfsource

public java.util.Set<java.lang.Object> getAllValuesOfsource(TraceMatch partialMatch)

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

Returns:

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

getAllValuesOfsource

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

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

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(TraceMatch 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(java.lang.Object pSource,
                                                        org.eclipse.emf.ecore.EObject pTarget,
                                                        Trace pTrace,
                                                        java.lang.String pTraceabilityId)

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

getAllValuesOftarget

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

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

Returns:

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

getAllValuesOftarget

public java.util.Set<org.eclipse.emf.ecore.EObject> getAllValuesOftarget(TraceMatch partialMatch)

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

Returns:

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

getAllValuesOftarget

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

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

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(TraceMatch 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(java.lang.Object pSource,
                                                java.lang.String pId,
                                                org.eclipse.emf.ecore.EObject pTarget,
                                                java.lang.String pTraceabilityId)

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

getAllValuesOftraceabilityId

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

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

Returns:

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

getAllValuesOftraceabilityId

public java.util.Set<java.lang.String> getAllValuesOftraceabilityId(TraceMatch partialMatch)

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

Returns:

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

getAllValuesOftraceabilityId

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

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

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<TraceMatcher> querySpecification()
                                                            throws IncQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

IncQueryException - if the pattern definition could not be loaded