/**
* Generated from platform:/resource/case.study.a.queries/src/queries/case_study_A.vql
*/
package queries;
import Taxation.External_Allowance;
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.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.ExportedParameter;
import org.eclipse.viatra.query.runtime.matchers.psystem.basicdeferred.NegativePatternCall;
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;
import queries.X_inv15;
/**
* A pattern-specific query specification that can instantiate Matcher in a type-safe way.
*
*
Original source:
*
* //inv14-MultiplicityChanged
*
* //inv15-Ordered Sets in assignment if block
* //ERROR if no household object
* {@literal @}Constraint(message = "inv15", severity = "error", key = {ea})
* pattern inv15(ea : External_Allowance) {
* neg find x_inv15(ea);
* }
*
*
* @see Matcher
* @see Match
*
*/
@SuppressWarnings("all")
public final class Inv15 extends BaseGeneratedEMFQuerySpecification {
/**
* Pattern-specific match representation of the queries.inv15 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 External_Allowance fEa;
private static List parameterNames = makeImmutableList("ea");
private Match(final External_Allowance pEa) {
this.fEa = pEa;
}
@Override
public Object get(final String parameterName) {
switch(parameterName) {
case "ea": return this.fEa;
default: return null;
}
}
@Override
public Object get(final int index) {
switch(index) {
case 0: return this.fEa;
default: return null;
}
}
public External_Allowance getEa() {
return this.fEa;
}
@Override
public boolean set(final String parameterName, final Object newValue) {
if (!isMutable()) throw new java.lang.UnsupportedOperationException();
if ("ea".equals(parameterName) ) {
this.fEa = (External_Allowance) newValue;
return true;
}
return false;
}
public void setEa(final External_Allowance pEa) {
if (!isMutable()) throw new java.lang.UnsupportedOperationException();
this.fEa = pEa;
}
@Override
public String patternName() {
return "queries.inv15";
}
@Override
public List parameterNames() {
return Inv15.Match.parameterNames;
}
@Override
public Object[] toArray() {
return new Object[]{fEa};
}
@Override
public Inv15.Match toImmutable() {
return isMutable() ? newMatch(fEa) : this;
}
@Override
public String prettyPrint() {
StringBuilder result = new StringBuilder();
result.append("\"ea\"=" + prettyPrintValue(fEa));
return result.toString();
}
@Override
public int hashCode() {
return Objects.hash(fEa);
}
@Override
public boolean equals(final Object obj) {
if (this == obj)
return true;
if (obj == null) {
return false;
}
if ((obj instanceof Inv15.Match)) {
Inv15.Match other = (Inv15.Match) obj;
return Objects.equals(fEa, other.fEa);
} 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 Inv15 specification() {
return Inv15.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 Inv15.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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return the new, mutable (partial) match object.
*
*/
public static Inv15.Match newMutableMatch(final External_Allowance pEa) {
return new Mutable(pEa);
}
/**
* 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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return the (partial) match object.
*
*/
public static Inv15.Match newMatch(final External_Allowance pEa) {
return new Immutable(pEa);
}
private static final class Mutable extends Inv15.Match {
Mutable(final External_Allowance pEa) {
super(pEa);
}
@Override
public boolean isMutable() {
return true;
}
}
private static final class Immutable extends Inv15.Match {
Immutable(final External_Allowance pEa) {
super(pEa);
}
@Override
public boolean isMutable() {
return false;
}
}
}
/**
* Generated pattern matcher API of the queries.inv15 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:
*
* //inv14-MultiplicityChanged
*
* //inv15-Ordered Sets in assignment if block
* //ERROR if no household object
* {@literal @}Constraint(message = "inv15", severity = "error", key = {ea})
* pattern inv15(ea : External_Allowance) {
* neg find x_inv15(ea);
* }
*
*
* @see Match
* @see Inv15
*
*/
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 Inv15.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 Inv15.Matcher create() {
return new Matcher();
}
private static final int POSITION_EA = 0;
private static final Logger LOGGER = ViatraQueryLoggingUtil.getLogger(Inv15.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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return matches represented as a Match object.
*
*/
public Collection getAllMatches(final External_Allowance pEa) {
return rawStreamAllMatches(new Object[]{pEa}).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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return a stream of matches represented as a Match object.
*
*/
public Stream streamAllMatches(final External_Allowance pEa) {
return rawStreamAllMatches(new Object[]{pEa});
}
/**
* 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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return a match represented as a Match object, or null if no match is found.
*
*/
public Optional getOneArbitraryMatch(final External_Allowance pEa) {
return rawGetOneArbitraryMatch(new Object[]{pEa});
}
/**
* 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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return true if the input is a valid (partial) match of the pattern.
*
*/
public boolean hasMatch(final External_Allowance pEa) {
return rawHasMatch(new Object[]{pEa});
}
/**
* Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
* @param pEa the fixed value of pattern parameter ea, or null if not bound.
* @return the number of pattern matches found.
*
*/
public int countMatches(final External_Allowance pEa) {
return rawCountMatches(new Object[]{pEa});
}
/**
* 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 pEa the fixed value of pattern parameter ea, 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 External_Allowance pEa, final Consumer super Inv15.Match> processor) {
return rawForOneArbitraryMatch(new Object[]{pEa}, 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 pEa the fixed value of pattern parameter ea, or null if not bound.
* @return the (partial) match object.
*
*/
public Inv15.Match newMatch(final External_Allowance pEa) {
return Inv15.Match.newMatch(pEa);
}
/**
* Retrieve the set of values that occur in matches for ea.
* @return the Set of all values or empty set if there are no matches
*
*/
protected Stream rawStreamAllValuesOfea(final Object[] parameters) {
return rawStreamAllValues(POSITION_EA, parameters).map(External_Allowance.class::cast);
}
/**
* Retrieve the set of values that occur in matches for ea.
* @return the Set of all values or empty set if there are no matches
*
*/
public Set getAllValuesOfea() {
return rawStreamAllValuesOfea(emptyArray()).collect(Collectors.toSet());
}
/**
* Retrieve the set of values that occur in matches for ea.
* @return the Set of all values or empty set if there are no matches
*
*/
public Stream streamAllValuesOfea() {
return rawStreamAllValuesOfea(emptyArray());
}
@Override
protected Inv15.Match tupleToMatch(final Tuple t) {
try {
return Inv15.Match.newMatch((External_Allowance) t.get(POSITION_EA));
} catch(ClassCastException e) {
LOGGER.error("Element(s) in tuple not properly typed!",e);
return null;
}
}
@Override
protected Inv15.Match arrayToMatch(final Object[] match) {
try {
return Inv15.Match.newMatch((External_Allowance) match[POSITION_EA]);
} catch(ClassCastException e) {
LOGGER.error("Element(s) in array not properly typed!",e);
return null;
}
}
@Override
protected Inv15.Match arrayToMatchMutable(final Object[] match) {
try {
return Inv15.Match.newMutableMatch((External_Allowance) match[POSITION_EA]);
} 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 Inv15.instance();
}
}
private Inv15() {
super(GeneratedPQuery.INSTANCE);
}
/**
* @return the singleton instance of the query specification
* @throws ViatraQueryRuntimeException if the pattern definition could not be loaded
*
*/
public static Inv15 instance() {
try{
return LazyHolder.INSTANCE;
} catch (ExceptionInInitializerError err) {
throw processInitializerError(err);
}
}
@Override
protected Inv15.Matcher instantiate(final ViatraQueryEngine engine) {
return Inv15.Matcher.on(engine);
}
@Override
public Inv15.Matcher instantiate() {
return Inv15.Matcher.create();
}
@Override
public Inv15.Match newEmptyMatch() {
return Inv15.Match.newEmptyMatch();
}
@Override
public Inv15.Match newMatch(final Object... parameters) {
return Inv15.Match.newMatch((Taxation.External_Allowance) parameters[0]);
}
/**
* Inner class allowing the singleton instance of {@link Inv15} to be created
* not at the class load time of the outer class,
* but rather at the first call to {@link Inv15#instance()}.
*
* This workaround is required e.g. to support recursion.
*
*/
private static class LazyHolder {
private static final Inv15 INSTANCE = new Inv15();
/**
* 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 Inv15.GeneratedPQuery INSTANCE = new GeneratedPQuery();
private final PParameter parameter_ea = new PParameter("ea", "Taxation.External_Allowance", new EClassTransitiveInstancesKey((EClass)getClassifierLiteralSafe("http:///TaxCard.ecore", "External_Allowance")), PParameterDirection.INOUT);
private final List parameters = Arrays.asList(parameter_ea);
private GeneratedPQuery() {
super(PVisibility.PUBLIC);
}
@Override
public String getFullyQualifiedName() {
return "queries.inv15";
}
@Override
public List getParameterNames() {
return Arrays.asList("ea");
}
@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_ea = body.getOrCreateVariableByName("ea");
new TypeConstraint(body, Tuples.flatTupleOf(var_ea), new EClassTransitiveInstancesKey((EClass)getClassifierLiteral("http:///TaxCard.ecore", "External_Allowance")));
body.setSymbolicParameters(Arrays.asList(
new ExportedParameter(body, var_ea, parameter_ea)
));
// neg find x_inv15(ea)
new NegativePatternCall(body, Tuples.flatTupleOf(var_ea), X_inv15.instance().getInternalQueryRepresentation());
bodies.add(body);
}
{
PAnnotation annotation = new PAnnotation("Constraint");
annotation.addAttribute("message", "inv15");
annotation.addAttribute("severity", "error");
annotation.addAttribute("key", Arrays.asList(new Object[] {
new ParameterReference("ea")
}));
addAnnotation(annotation);
}
return bodies;
}
}
}