org.eclipse.viatra.addon.viewers.runtime.model.patterns

Class ChildrenMatcher

java.lang.Object

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

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

org.eclipse.viatra.addon.viewers.runtime.model.patterns.ChildrenMatcher

All Implemented Interfaces:

ViatraQueryMatcher<ChildrenMatch>

public class ChildrenMatcher
extends BaseMatcher<ChildrenMatch>

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

Original source:

  @QueryExplorer(checked = false)
 pattern children(parent:Item, child:Item) {
        Containment.source(c, parent);
        Containment.target(c, child);
 }
 

See Also:

ChildrenMatch, ChildrenProcessor, ChildrenQuerySpecification

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 ChildrenMatch	arrayToMatch(java.lang.Object[] match) Converts the array representation of a pattern match to an immutable Match object.
protected ChildrenMatch	arrayToMatchMutable(java.lang.Object[] match) Converts the array representation of a pattern match to a mutable Match object.
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.
static ChildrenMatcher	create()
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(ViatraQueryEngine engine) Initializes the pattern matcher within an existing VIATRA Query engine.
static IQuerySpecification<ChildrenMatcher>	querySpecification()
protected java.util.Set<Item>	rawAccumulateAllValuesOfchild(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for child.
protected java.util.Set<Item>	rawAccumulateAllValuesOfparent(java.lang.Object[] parameters) Retrieve the set of values that occur in matches for parent.
protected ChildrenMatch	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 ChildrenMatcher 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 ChildrenMatcher 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<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.

rawAccumulateAllValuesOfparent

protected java.util.Set<Item> rawAccumulateAllValuesOfparent(java.lang.Object[] parameters)

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

Returns:

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

getAllValuesOfparent

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

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

Returns:

the Set of all values or 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 or 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 or empty set if there are no matches

rawAccumulateAllValuesOfchild

protected java.util.Set<Item> rawAccumulateAllValuesOfchild(java.lang.Object[] parameters)

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

Returns:

the Set of all values or 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 or 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 or 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 or empty set if there are no matches

tupleToMatch

protected ChildrenMatch tupleToMatch(Tuple t)

Specified by:

tupleToMatch in class BaseMatcher<ChildrenMatch>

arrayToMatch

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

arrayToMatchMutable

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

querySpecification

public static IQuerySpecification<ChildrenMatcher> querySpecification()
                                                               throws ViatraQueryException

Returns:

the singleton instance of the query specification of this pattern

Throws:

ViatraQueryException - if the pattern definition could not be loaded