org.eclipse.incquery.viewers.runtime.model.patterns

Class ChildrenMatcher

java.lang.Object

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

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

org.eclipse.incquery.viewers.runtime.model.patterns.ChildrenMatcher

All Implemented Interfaces:

IncQueryMatcher<ChildrenMatch>

public class ChildrenMatcher
extends BaseMatcher<ChildrenMatch>

Generated pattern matcher API of the org.eclipse.incquery.viewers.runtime.model.patterns.children 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 ChildrenMatch.

Original source:

 pattern children(parent:Item, child:Item) {
        Containment.source(c, parent);
        Containment.target(c, child);
 }
 

See Also:

ChildrenMatch, ChildrenProcessor, ChildrenQuerySpecification

Constructor Summary

Constructors

Constructor and Description
ChildrenMatcher(IncQueryEngine engine) Deprecated. use on(IncQueryEngine) instead
ChildrenMatcher(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(Item pParent, Item pChild) Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
void	forEachMatch(Item pParent, Item pChild, IMatchProcessor<? super ChildrenMatch> processor) Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
boolean	forOneArbitraryMatch(Item pParent, Item pChild, IMatchProcessor<? super ChildrenMatch> 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<ChildrenMatch>	getAllMatches(Item pParent, Item pChild) Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
java.util.Set<Item>	getAllValuesOfchild() Retrieve the set of values that occur in matches for child.
java.util.Set<Item>	getAllValuesOfchild(ChildrenMatch partialMatch) Retrieve the set of values that occur in matches for child.
java.util.Set<Item>	getAllValuesOfchild(Item pParent) Retrieve the set of values that occur in matches for child.
java.util.Set<Item>	getAllValuesOfparent() Retrieve the set of values that occur in matches for parent.
java.util.Set<Item>	getAllValuesOfparent(ChildrenMatch partialMatch) Retrieve the set of values that occur in matches for parent.
java.util.Set<Item>	getAllValuesOfparent(Item pChild) Retrieve the set of values that occur in matches for parent.
ChildrenMatch	getOneArbitraryMatch(Item pParent, Item pChild) Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
boolean	hasMatch(Item pParent, Item pChild) Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
ChildrenMatch	newMatch(Item pParent, Item pChild) Returns a new (partial) match.
static ChildrenMatcher	on(IncQueryEngine engine) Initializes the pattern matcher within an existing EMF-IncQuery engine.
static IQuerySpecification<ChildrenMatcher>	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

ChildrenMatcher

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

ChildrenMatcher

@Deprecated
public ChildrenMatcher(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 ChildrenMatcher 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<ChildrenMatch> getAllMatches(Item pParent,
                                                         Item pChild)

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

Parameters:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

Returns:

matches represented as a ChildrenMatch object.

getOneArbitraryMatch

public ChildrenMatch getOneArbitraryMatch(Item pParent,
                                          Item pChild)

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:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

Returns:

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

hasMatch

public boolean hasMatch(Item pParent,
                        Item pChild)

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:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

Returns:

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

countMatches

public int countMatches(Item pParent,
                        Item pChild)

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

Parameters:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

Returns:

the number of pattern matches found.

forEachMatch

public void forEachMatch(Item pParent,
                         Item pChild,
                         IMatchProcessor<? super ChildrenMatch> processor)

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

Parameters:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

processor - the action that will process each pattern match.

forOneArbitraryMatch

public boolean forOneArbitraryMatch(Item pParent,
                                    Item pChild,
                                    IMatchProcessor<? super ChildrenMatch> 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:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, 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 ChildrenMatch newMatch(Item pParent,
                              Item pChild)

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:

pParent - the fixed value of pattern parameter parent, or null if not bound.

pChild - the fixed value of pattern parameter child, or null if not bound.

Returns:

the (partial) match object.

getAllValuesOfparent

public java.util.Set<Item> getAllValuesOfparent()

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

Returns:

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

getAllValuesOfparent

public java.util.Set<Item> getAllValuesOfparent(ChildrenMatch partialMatch)

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

Returns:

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

getAllValuesOfparent

public java.util.Set<Item> getAllValuesOfparent(Item pChild)

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

Returns:

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

getAllValuesOfchild

public java.util.Set<Item> getAllValuesOfchild()

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

Returns:

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

getAllValuesOfchild

public java.util.Set<Item> getAllValuesOfchild(ChildrenMatch partialMatch)

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

Returns:

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

getAllValuesOfchild

public java.util.Set<Item> getAllValuesOfchild(Item pParent)

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

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

Returns:

the singleton instance of the query specification of this pattern

Throws:

IncQueryException - if the pattern definition could not be loaded