From 36ca60e5b6bd047a4f444d96241bd60a01bbab17 Mon Sep 17 00:00:00 2001 From: ArenBabikian Date: Mon, 27 Apr 2020 10:45:28 -0400 Subject: rename Pledge Case Studies and add familyTree case study --- .../queries/.FamilyTreeConstraints.java._trace | Bin 0 -> 333 bytes .../queries/.MemberIsItsOwnParent.java._trace | Bin 0 -> 3544 bytes .../src-gen/queries/FamilyTreeConstraints.java | 53 ++ .../src-gen/queries/MemberIsItsOwnParent.java | 577 +++++++++++++++++++++ 4 files changed, 630 insertions(+) create mode 100644 Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.FamilyTreeConstraints.java._trace create mode 100644 Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.MemberIsItsOwnParent.java._trace create mode 100644 Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/FamilyTreeConstraints.java create mode 100644 Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/MemberIsItsOwnParent.java (limited to 'Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries') diff --git a/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.FamilyTreeConstraints.java._trace b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.FamilyTreeConstraints.java._trace new file mode 100644 index 00000000..80158bd8 Binary files /dev/null and b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.FamilyTreeConstraints.java._trace differ diff --git a/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.MemberIsItsOwnParent.java._trace b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.MemberIsItsOwnParent.java._trace new file mode 100644 index 00000000..1b0dca98 Binary files /dev/null and b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/.MemberIsItsOwnParent.java._trace differ diff --git a/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/FamilyTreeConstraints.java b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/FamilyTreeConstraints.java new file mode 100644 index 00000000..a5c375c6 --- /dev/null +++ b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/FamilyTreeConstraints.java @@ -0,0 +1,53 @@ +/** + * Generated from platform:/resource/case.study.familyTree.run/src/queries/familyTreeConstraints.vql + */ +package queries; + +import org.eclipse.viatra.query.runtime.api.ViatraQueryEngine; +import org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedPatternGroup; +import queries.MemberIsItsOwnParent; + +/** + * A pattern group formed of all public patterns defined in familyTreeConstraints.vql. + * + *

Use the static instance as any {@link interface org.eclipse.viatra.query.runtime.api.IQueryGroup}, to conveniently prepare + * a VIATRA Query engine for matching all patterns originally defined in file familyTreeConstraints.vql, + * in order to achieve better performance than one-by-one on-demand matcher initialization. + * + *

From package queries, the group contains the definition of the following patterns:

+ * + * @see IQueryGroup + * + */ +@SuppressWarnings("all") +public final class FamilyTreeConstraints extends BaseGeneratedPatternGroup { + /** + * Access the pattern group. + * + * @return the singleton instance of the group + * @throws ViatraQueryRuntimeException if there was an error loading the generated code of pattern specifications + * + */ + public static FamilyTreeConstraints instance() { + if (INSTANCE == null) { + INSTANCE = new FamilyTreeConstraints(); + } + return INSTANCE; + } + + private static FamilyTreeConstraints INSTANCE; + + private FamilyTreeConstraints() { + querySpecifications.add(MemberIsItsOwnParent.instance()); + } + + public MemberIsItsOwnParent getMemberIsItsOwnParent() { + return MemberIsItsOwnParent.instance(); + } + + public MemberIsItsOwnParent.Matcher getMemberIsItsOwnParent(final ViatraQueryEngine engine) { + return MemberIsItsOwnParent.Matcher.on(engine); + } +} diff --git a/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/MemberIsItsOwnParent.java b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/MemberIsItsOwnParent.java new file mode 100644 index 00000000..67cdafb5 --- /dev/null +++ b/Tests/MODELS2020-CaseStudies/case.study.familyTree.run/src-gen/queries/MemberIsItsOwnParent.java @@ -0,0 +1,577 @@ +/** + * Generated from platform:/resource/case.study.familyTree.run/src/queries/familyTreeConstraints.vql + */ +package queries; + +import familytree.Member; +import java.util.Arrays; +import java.util.Collection; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.function.Consumer; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.log4j.Logger; +import org.eclipse.emf.ecore.EClass; +import org.eclipse.viatra.query.runtime.api.IPatternMatch; +import org.eclipse.viatra.query.runtime.api.IQuerySpecification; +import org.eclipse.viatra.query.runtime.api.ViatraQueryEngine; +import org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedEMFPQuery; +import org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedEMFQuerySpecification; +import org.eclipse.viatra.query.runtime.api.impl.BaseMatcher; +import org.eclipse.viatra.query.runtime.api.impl.BasePatternMatch; +import org.eclipse.viatra.query.runtime.emf.types.EClassTransitiveInstancesKey; +import org.eclipse.viatra.query.runtime.emf.types.EStructuralFeatureInstancesKey; +import org.eclipse.viatra.query.runtime.matchers.backend.QueryEvaluationHint; +import org.eclipse.viatra.query.runtime.matchers.psystem.PBody; +import org.eclipse.viatra.query.runtime.matchers.psystem.PVariable; +import org.eclipse.viatra.query.runtime.matchers.psystem.annotations.PAnnotation; +import org.eclipse.viatra.query.runtime.matchers.psystem.annotations.ParameterReference; +import org.eclipse.viatra.query.runtime.matchers.psystem.basicdeferred.Equality; +import org.eclipse.viatra.query.runtime.matchers.psystem.basicdeferred.ExportedParameter; +import org.eclipse.viatra.query.runtime.matchers.psystem.basicenumerables.TypeConstraint; +import org.eclipse.viatra.query.runtime.matchers.psystem.queries.PParameter; +import org.eclipse.viatra.query.runtime.matchers.psystem.queries.PParameterDirection; +import org.eclipse.viatra.query.runtime.matchers.psystem.queries.PVisibility; +import org.eclipse.viatra.query.runtime.matchers.tuple.Tuple; +import org.eclipse.viatra.query.runtime.matchers.tuple.Tuples; +import org.eclipse.viatra.query.runtime.util.ViatraQueryLoggingUtil; + +/** + * A pattern-specific query specification that can instantiate Matcher in a type-safe way. + * + *

Original source: + * 

+ *         {@literal @}Constraint(message="memberIsItsOwnParent", severity="error", key={m})
+ *         pattern memberIsItsOwnParent(m: Member) = {
+ *         	FamilyTree.members(_, m);
+ *         	Member.parents(m, p);
+ *         	m == p;
+ *         }
+ *
+ * + * @see Matcher + * @see Match + * + */ +@SuppressWarnings("all") +public final class MemberIsItsOwnParent extends BaseGeneratedEMFQuerySpecification { + /** + * Pattern-specific match representation of the queries.memberIsItsOwnParent pattern, + * to be used in conjunction with {@link Matcher}. + * + *

Class fields correspond to parameters of the pattern. Fields with value null are considered unassigned. + * Each instance is a (possibly partial) substitution of pattern parameters, + * usable to represent a match of the pattern in the result of a query, + * or to specify the bound (fixed) input parameters when issuing a query. + * + * @see Matcher + * + */ + public static abstract class Match extends BasePatternMatch { + private Member fM; + + private static List parameterNames = makeImmutableList("m"); + + private Match(final Member pM) { + this.fM = pM; + } + + @Override + public Object get(final String parameterName) { + switch(parameterName) { + case "m": return this.fM; + default: return null; + } + } + + @Override + public Object get(final int index) { + switch(index) { + case 0: return this.fM; + default: return null; + } + } + + public Member getM() { + return this.fM; + } + + @Override + public boolean set(final String parameterName, final Object newValue) { + if (!isMutable()) throw new java.lang.UnsupportedOperationException(); + if ("m".equals(parameterName) ) { + this.fM = (Member) newValue; + return true; + } + return false; + } + + public void setM(final Member pM) { + if (!isMutable()) throw new java.lang.UnsupportedOperationException(); + this.fM = pM; + } + + @Override + public String patternName() { + return "queries.memberIsItsOwnParent"; + } + + @Override + public List parameterNames() { + return MemberIsItsOwnParent.Match.parameterNames; + } + + @Override + public Object[] toArray() { + return new Object[]{fM}; + } + + @Override + public MemberIsItsOwnParent.Match toImmutable() { + return isMutable() ? newMatch(fM) : this; + } + + @Override + public String prettyPrint() { + StringBuilder result = new StringBuilder(); + result.append("\"m\"=" + prettyPrintValue(fM)); + return result.toString(); + } + + @Override + public int hashCode() { + return Objects.hash(fM); + } + + @Override + public boolean equals(final Object obj) { + if (this == obj) + return true; + if (obj == null) { + return false; + } + if ((obj instanceof MemberIsItsOwnParent.Match)) { + MemberIsItsOwnParent.Match other = (MemberIsItsOwnParent.Match) obj; + return Objects.equals(fM, other.fM); + } else { + // this should be infrequent + if (!(obj instanceof IPatternMatch)) { + return false; + } + IPatternMatch otherSig = (IPatternMatch) obj; + return Objects.equals(specification(), otherSig.specification()) && Arrays.deepEquals(toArray(), otherSig.toArray()); + } + } + + @Override + public MemberIsItsOwnParent specification() { + return MemberIsItsOwnParent.instance(); + } + + /** + * Returns an empty, mutable match. + * Fields of the mutable match can be filled to create a partial match, usable as matcher input. + * + * @return the empty match. + * + */ + public static MemberIsItsOwnParent.Match newEmptyMatch() { + return new Mutable(null); + } + + /** + * Returns a mutable (partial) match. + * Fields of the mutable match can be filled to create a partial match, usable as matcher input. + * + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return the new, mutable (partial) match object. + * + */ + public static MemberIsItsOwnParent.Match newMutableMatch(final Member pM) { + return new Mutable(pM); + } + + /** + * 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 {@link #newEmptyMatch()} to obtain a mutable match object. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return the (partial) match object. + * + */ + public static MemberIsItsOwnParent.Match newMatch(final Member pM) { + return new Immutable(pM); + } + + private static final class Mutable extends MemberIsItsOwnParent.Match { + Mutable(final Member pM) { + super(pM); + } + + @Override + public boolean isMutable() { + return true; + } + } + + private static final class Immutable extends MemberIsItsOwnParent.Match { + Immutable(final Member pM) { + super(pM); + } + + @Override + public boolean isMutable() { + return false; + } + } + } + + /** + * Generated pattern matcher API of the queries.memberIsItsOwnParent pattern, + * providing pattern-specific query methods. + * + *

Use the pattern matcher on a given model via {@link #on(ViatraQueryEngine)}, + * e.g. in conjunction with {@link ViatraQueryEngine#on(QueryScope)}. + * + *

Matches of the pattern will be represented as {@link Match}. + * + *

Original source: + * 

+   * {@literal @}Constraint(message="memberIsItsOwnParent", severity="error", key={m})
+   * pattern memberIsItsOwnParent(m: Member) = {
+   * 	FamilyTree.members(_, m);
+   * 	Member.parents(m, p);
+   * 	m == p;
+   * }
+   *
+ * + * @see Match + * @see MemberIsItsOwnParent + * + */ + public static class Matcher extends BaseMatcher { + /** + * 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. + * + * @param engine the existing VIATRA Query engine in which this matcher will be created. + * @throws ViatraQueryRuntimeException if an error occurs during pattern matcher creation + * + */ + public static MemberIsItsOwnParent.Matcher on(final ViatraQueryEngine engine) { + // check if matcher already exists + Matcher matcher = engine.getExistingMatcher(querySpecification()); + if (matcher == null) { + matcher = (Matcher)engine.getMatcher(querySpecification()); + } + return matcher; + } + + /** + * @throws ViatraQueryRuntimeException if an error occurs during pattern matcher creation + * @return an initialized matcher + * @noreference This method is for internal matcher initialization by the framework, do not call it manually. + * + */ + public static MemberIsItsOwnParent.Matcher create() { + return new Matcher(); + } + + private static final int POSITION_M = 0; + + private static final Logger LOGGER = ViatraQueryLoggingUtil.getLogger(MemberIsItsOwnParent.Matcher.class); + + /** + * 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. + * + * @param engine the existing VIATRA Query engine in which this matcher will be created. + * @throws ViatraQueryRuntimeException if an error occurs during pattern matcher creation + * + */ + private Matcher() { + super(querySpecification()); + } + + /** + * Returns the set of all matches of the pattern that conform to the given fixed values of some parameters. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return matches represented as a Match object. + * + */ + public Collection getAllMatches(final Member pM) { + return rawStreamAllMatches(new Object[]{pM}).collect(Collectors.toSet()); + } + + /** + * Returns a stream of all matches of the pattern that conform to the given fixed values of some parameters. + *

+ * NOTE: It is important not to modify the source model while the stream is being processed. + * If the match set of the pattern changes during processing, the contents of the stream is undefined. + * In such cases, either rely on {@link #getAllMatches()} or collect the results of the stream in end-user code. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return a stream of matches represented as a Match object. + * + */ + public Stream streamAllMatches(final Member pM) { + return rawStreamAllMatches(new Object[]{pM}); + } + + /** + * 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. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return a match represented as a Match object, or null if no match is found. + * + */ + public Optional getOneArbitraryMatch(final Member pM) { + return rawGetOneArbitraryMatch(new Object[]{pM}); + } + + /** + * Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, + * under any possible substitution of the unspecified parameters (if any). + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return true if the input is a valid (partial) match of the pattern. + * + */ + public boolean hasMatch(final Member pM) { + return rawHasMatch(new Object[]{pM}); + } + + /** + * Returns the number of all matches of the pattern that conform to the given fixed values of some parameters. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return the number of pattern matches found. + * + */ + public int countMatches(final Member pM) { + return rawCountMatches(new Object[]{pM}); + } + + /** + * 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. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @param processor the action that will process the selected match. + * @return true if the pattern has at least one match with the given parameter values, false if the processor was not invoked + * + */ + public boolean forOneArbitraryMatch(final Member pM, final Consumer processor) { + return rawForOneArbitraryMatch(new Object[]{pM}, processor); + } + + /** + * 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 {@link #newEmptyMatch()} to obtain a mutable match object. + * @param pM the fixed value of pattern parameter m, or null if not bound. + * @return the (partial) match object. + * + */ + public MemberIsItsOwnParent.Match newMatch(final Member pM) { + return MemberIsItsOwnParent.Match.newMatch(pM); + } + + /** + * Retrieve the set of values that occur in matches for m. + * @return the Set of all values or empty set if there are no matches + * + */ + protected Stream rawStreamAllValuesOfm(final Object[] parameters) { + return rawStreamAllValues(POSITION_M, parameters).map(Member.class::cast); + } + + /** + * Retrieve the set of values that occur in matches for m. + * @return the Set of all values or empty set if there are no matches + * + */ + public Set getAllValuesOfm() { + return rawStreamAllValuesOfm(emptyArray()).collect(Collectors.toSet()); + } + + /** + * Retrieve the set of values that occur in matches for m. + * @return the Set of all values or empty set if there are no matches + * + */ + public Stream streamAllValuesOfm() { + return rawStreamAllValuesOfm(emptyArray()); + } + + @Override + protected MemberIsItsOwnParent.Match tupleToMatch(final Tuple t) { + try { + return MemberIsItsOwnParent.Match.newMatch((Member) t.get(POSITION_M)); + } catch(ClassCastException e) { + LOGGER.error("Element(s) in tuple not properly typed!",e); + return null; + } + } + + @Override + protected MemberIsItsOwnParent.Match arrayToMatch(final Object[] match) { + try { + return MemberIsItsOwnParent.Match.newMatch((Member) match[POSITION_M]); + } catch(ClassCastException e) { + LOGGER.error("Element(s) in array not properly typed!",e); + return null; + } + } + + @Override + protected MemberIsItsOwnParent.Match arrayToMatchMutable(final Object[] match) { + try { + return MemberIsItsOwnParent.Match.newMutableMatch((Member) match[POSITION_M]); + } catch(ClassCastException e) { + LOGGER.error("Element(s) in array not properly typed!",e); + return null; + } + } + + /** + * @return the singleton instance of the query specification of this pattern + * @throws ViatraQueryRuntimeException if the pattern definition could not be loaded + * + */ + public static IQuerySpecification querySpecification() { + return MemberIsItsOwnParent.instance(); + } + } + + private MemberIsItsOwnParent() { + super(GeneratedPQuery.INSTANCE); + } + + /** + * @return the singleton instance of the query specification + * @throws ViatraQueryRuntimeException if the pattern definition could not be loaded + * + */ + public static MemberIsItsOwnParent instance() { + try{ + return LazyHolder.INSTANCE; + } catch (ExceptionInInitializerError err) { + throw processInitializerError(err); + } + } + + @Override + protected MemberIsItsOwnParent.Matcher instantiate(final ViatraQueryEngine engine) { + return MemberIsItsOwnParent.Matcher.on(engine); + } + + @Override + public MemberIsItsOwnParent.Matcher instantiate() { + return MemberIsItsOwnParent.Matcher.create(); + } + + @Override + public MemberIsItsOwnParent.Match newEmptyMatch() { + return MemberIsItsOwnParent.Match.newEmptyMatch(); + } + + @Override + public MemberIsItsOwnParent.Match newMatch(final Object... parameters) { + return MemberIsItsOwnParent.Match.newMatch((familytree.Member) parameters[0]); + } + + /** + * Inner class allowing the singleton instance of {@link MemberIsItsOwnParent} to be created + * not at the class load time of the outer class, + * but rather at the first call to {@link MemberIsItsOwnParent#instance()}. + * + *

This workaround is required e.g. to support recursion. + * + */ + private static class LazyHolder { + private static final MemberIsItsOwnParent INSTANCE = new MemberIsItsOwnParent(); + + /** + * Statically initializes the query specification after the field {@link #INSTANCE} is assigned. + * This initialization order is required to support indirect recursion. + * + *

The static initializer is defined using a helper field to work around limitations of the code generator. + * + */ + private static final Object STATIC_INITIALIZER = ensureInitialized(); + + public static Object ensureInitialized() { + INSTANCE.ensureInitializedInternal(); + return null; + } + } + + private static class GeneratedPQuery extends BaseGeneratedEMFPQuery { + private static final MemberIsItsOwnParent.GeneratedPQuery INSTANCE = new GeneratedPQuery(); + + private final PParameter parameter_m = new PParameter("m", "familytree.Member", new EClassTransitiveInstancesKey((EClass)getClassifierLiteralSafe("http://www.example.org/familytree", "Member")), PParameterDirection.INOUT); + + private final List parameters = Arrays.asList(parameter_m); + + private GeneratedPQuery() { + super(PVisibility.PUBLIC); + } + + @Override + public String getFullyQualifiedName() { + return "queries.memberIsItsOwnParent"; + } + + @Override + public List getParameterNames() { + return Arrays.asList("m"); + } + + @Override + public List getParameters() { + return parameters; + } + + @Override + public Set doGetContainedBodies() { + setEvaluationHints(new QueryEvaluationHint(null, QueryEvaluationHint.BackendRequirement.UNSPECIFIED)); + Set bodies = new LinkedHashSet<>(); + { + PBody body = new PBody(this); + PVariable var_m = body.getOrCreateVariableByName("m"); + PVariable var___0_ = body.getOrCreateVariableByName("_<0>"); + PVariable var_p = body.getOrCreateVariableByName("p"); + new TypeConstraint(body, Tuples.flatTupleOf(var_m), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member"))); + body.setSymbolicParameters(Arrays.asList( + new ExportedParameter(body, var_m, parameter_m) + )); + // FamilyTree.members(_, m) + new TypeConstraint(body, Tuples.flatTupleOf(var___0_), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "FamilyTree"))); + PVariable var__virtual_0_ = body.getOrCreateVariableByName(".virtual{0}"); + new TypeConstraint(body, Tuples.flatTupleOf(var___0_, var__virtual_0_), new EStructuralFeatureInstancesKey(getFeatureLiteral("http://www.example.org/familytree", "FamilyTree", "members"))); + new TypeConstraint(body, Tuples.flatTupleOf(var__virtual_0_), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member"))); + new Equality(body, var__virtual_0_, var_m); + // Member.parents(m, p) + new TypeConstraint(body, Tuples.flatTupleOf(var_m), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member"))); + PVariable var__virtual_1_ = body.getOrCreateVariableByName(".virtual{1}"); + new TypeConstraint(body, Tuples.flatTupleOf(var_m, var__virtual_1_), new EStructuralFeatureInstancesKey(getFeatureLiteral("http://www.example.org/familytree", "Member", "parents"))); + new TypeConstraint(body, Tuples.flatTupleOf(var__virtual_1_), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member"))); + new Equality(body, var__virtual_1_, var_p); + // m == p + new Equality(body, var_m, var_p); + bodies.add(body); + } + { + PAnnotation annotation = new PAnnotation("Constraint"); + annotation.addAttribute("message", "memberIsItsOwnParent"); + annotation.addAttribute("severity", "error"); + annotation.addAttribute("key", Arrays.asList(new Object[] { + new ParameterReference("m") + })); + addAnnotation(annotation); + } + return bodies; + } + } +} -- cgit v1.2.3-54-g00ecf