path: root/Tests/MODELS2020-CaseStudies/case.study.pledge.run/src-gen/queries/MemberHasParent.java

/**
 * Generated from platform:/resource/case.study.pledge.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.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.
 * 
 * <p>Original source:
 *         <code><pre>
 *         pattern memberHasParent(m: Member) = {
 *         	Member.parents(m, _);
 *         }
 * </pre></code>
 * 
 * @see Matcher
 * @see Match
 * 
 */
@SuppressWarnings("all")
public final class MemberHasParent extends BaseGeneratedEMFQuerySpecification<MemberHasParent.Matcher> {
  /**
   * Pattern-specific match representation of the queries.memberHasParent pattern,
   * to be used in conjunction with {@link Matcher}.
   * 
   * <p>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<String> 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.memberHasParent";
    }
    
    @Override
    public List<String> parameterNames() {
      return MemberHasParent.Match.parameterNames;
    }
    
    @Override
    public Object[] toArray() {
      return new Object[]{fM};
    }
    
    @Override
    public MemberHasParent.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 MemberHasParent.Match)) {
          MemberHasParent.Match other = (MemberHasParent.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 MemberHasParent specification() {
      return MemberHasParent.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 MemberHasParent.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 MemberHasParent.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.
     * <p>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 MemberHasParent.Match newMatch(final Member pM) {
      return new Immutable(pM);
    }
    
    private static final class Mutable extends MemberHasParent.Match {
      Mutable(final Member pM) {
        super(pM);
      }
      
      @Override
      public boolean isMutable() {
        return true;
      }
    }
    
    private static final class Immutable extends MemberHasParent.Match {
      Immutable(final Member pM) {
        super(pM);
      }
      
      @Override
      public boolean isMutable() {
        return false;
      }
    }
  }
  
  /**
   * Generated pattern matcher API of the queries.memberHasParent pattern,
   * providing pattern-specific query methods.
   * 
   * <p>Use the pattern matcher on a given model via {@link #on(ViatraQueryEngine)},
   * e.g. in conjunction with {@link ViatraQueryEngine#on(QueryScope)}.
   * 
   * <p>Matches of the pattern will be represented as {@link Match}.
   * 
   * <p>Original source:
   * <code><pre>
   * pattern memberHasParent(m: Member) = {
   * 	Member.parents(m, _);
   * }
   * </pre></code>
   * 
   * @see Match
   * @see MemberHasParent
   * 
   */
  public static class Matcher extends BaseMatcher<MemberHasParent.Match> {
    /**
     * 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 MemberHasParent.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 MemberHasParent.Matcher create() {
      return new Matcher();
    }
    
    private static final int POSITION_M = 0;
    
    private static final Logger LOGGER = ViatraQueryLoggingUtil.getLogger(MemberHasParent.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<MemberHasParent.Match> 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.
     * </p>
     * <strong>NOTE</strong>: 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 <strong>undefined</strong>.
     * 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<MemberHasParent.Match> 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<MemberHasParent.Match> 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<? super MemberHasParent.Match> 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.
     * <p>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 MemberHasParent.Match newMatch(final Member pM) {
      return MemberHasParent.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<Member> 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<Member> 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<Member> streamAllValuesOfm() {
      return rawStreamAllValuesOfm(emptyArray());
    }
    
    @Override
    protected MemberHasParent.Match tupleToMatch(final Tuple t) {
      try {
          return MemberHasParent.Match.newMatch((Member) t.get(POSITION_M));
      } catch(ClassCastException e) {
          LOGGER.error("Element(s) in tuple not properly typed!",e);
          return null;
      }
    }
    
    @Override
    protected MemberHasParent.Match arrayToMatch(final Object[] match) {
      try {
          return MemberHasParent.Match.newMatch((Member) match[POSITION_M]);
      } catch(ClassCastException e) {
          LOGGER.error("Element(s) in array not properly typed!",e);
          return null;
      }
    }
    
    @Override
    protected MemberHasParent.Match arrayToMatchMutable(final Object[] match) {
      try {
          return MemberHasParent.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<MemberHasParent.Matcher> querySpecification() {
      return MemberHasParent.instance();
    }
  }
  
  private MemberHasParent() {
    super(GeneratedPQuery.INSTANCE);
  }
  
  /**
   * @return the singleton instance of the query specification
   * @throws ViatraQueryRuntimeException if the pattern definition could not be loaded
   * 
   */
  public static MemberHasParent instance() {
    try{
        return LazyHolder.INSTANCE;
    } catch (ExceptionInInitializerError err) {
        throw processInitializerError(err);
    }
  }
  
  @Override
  protected MemberHasParent.Matcher instantiate(final ViatraQueryEngine engine) {
    return MemberHasParent.Matcher.on(engine);
  }
  
  @Override
  public MemberHasParent.Matcher instantiate() {
    return MemberHasParent.Matcher.create();
  }
  
  @Override
  public MemberHasParent.Match newEmptyMatch() {
    return MemberHasParent.Match.newEmptyMatch();
  }
  
  @Override
  public MemberHasParent.Match newMatch(final Object... parameters) {
    return MemberHasParent.Match.newMatch((familytree.Member) parameters[0]);
  }
  
  /**
   * Inner class allowing the singleton instance of {@link MemberHasParent} to be created 
   *     <b>not</b> at the class load time of the outer class, 
   *     but rather at the first call to {@link MemberHasParent#instance()}.
   * 
   * <p> This workaround is required e.g. to support recursion.
   * 
   */
  private static class LazyHolder {
    private static final MemberHasParent INSTANCE = new MemberHasParent();
    
    /**
     * Statically initializes the query specification <b>after</b> the field {@link #INSTANCE} is assigned.
     * This initialization order is required to support indirect recursion.
     * 
     * <p> 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 MemberHasParent.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<PParameter> parameters = Arrays.asList(parameter_m);
    
    private GeneratedPQuery() {
      super(PVisibility.PUBLIC);
    }
    
    @Override
    public String getFullyQualifiedName() {
      return "queries.memberHasParent";
    }
    
    @Override
    public List<String> getParameterNames() {
      return Arrays.asList("m");
    }
    
    @Override
    public List<PParameter> getParameters() {
      return parameters;
    }
    
    @Override
    public Set<PBody> doGetContainedBodies() {
      setEvaluationHints(new QueryEvaluationHint(null, QueryEvaluationHint.BackendRequirement.UNSPECIFIED));
      Set<PBody> bodies = new LinkedHashSet<>();
      {
          PBody body = new PBody(this);
          PVariable var_m = body.getOrCreateVariableByName("m");
          PVariable var___0_ = body.getOrCreateVariableByName("_<0>");
          new TypeConstraint(body, Tuples.flatTupleOf(var_m), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member")));
          body.setSymbolicParameters(Arrays.<ExportedParameter>asList(
             new ExportedParameter(body, var_m, parameter_m)
          ));
          // 	Member.parents(m, _)
          new TypeConstraint(body, Tuples.flatTupleOf(var_m), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http://www.example.org/familytree", "Member")));
          PVariable var__virtual_0_ = body.getOrCreateVariableByName(".virtual{0}");
          new TypeConstraint(body, Tuples.flatTupleOf(var_m, var__virtual_0_), new EStructuralFeatureInstancesKey(getFeatureLiteral("http://www.example.org/familytree", "Member", "parents")));
          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___0_);
          bodies.add(body);
      }
      return bodies;
    }
  }
}