SubPackageMatcher.java

package headless;

import headless.SubPackageMatch;
import headless.util.SubPackageQuerySpecification;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import org.eclipse.emf.common.notify.Notifier;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.incquery.runtime.api.IMatchProcessor;
import org.eclipse.incquery.runtime.api.IQuerySpecification;
import org.eclipse.incquery.runtime.api.IncQueryEngine;
import org.eclipse.incquery.runtime.api.impl.BaseMatcher;
import org.eclipse.incquery.runtime.exception.IncQueryException;
import org.eclipse.incquery.runtime.matchers.tuple.Tuple;
import org.eclipse.incquery.runtime.rete.misc.DeltaMonitor;

/**
 * Generated pattern matcher API of the headless.subPackage pattern,
 * providing pattern-specific query methods.
 * 
 * <p>Use the pattern matcher on a given model via {@link #on(IncQueryEngine)},
 * e.g. in conjunction with {@link IncQueryEngine#on(Notifier)}.
 * 
 * <p>Matches of the pattern will be represented as {@link SubPackageMatch}.
 * 
 * <p>Original source:
 * <code><pre>
 * {@literal @}Edge(source = p, target = sp, label = "sub")
 * pattern subPackage(p: EPackage, sp: EPackage){ EPackage.eSubpackages(p,sp); }
 * </pre></code>
 * 
 * @see SubPackageMatch
 * @see SubPackageProcessor
 * @see SubPackageQuerySpecification
 * 
 */
@SuppressWarnings("all")
public class SubPackageMatcher extends BaseMatcher<SubPackageMatch> {
  /**
   * @return the singleton instance of the query specification of this pattern
   * @throws IncQueryException if the pattern definition could not be loaded
   * 
   */
  public static IQuerySpecification<SubPackageMatcher> querySpecification() throws IncQueryException {
    return SubPackageQuerySpecification.instance();
  }
  
  /**
   * 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.
   * @param engine the existing EMF-IncQuery engine in which this matcher will be created.
   * @throws IncQueryException if an error occurs during pattern matcher creation
   * 
   */
  public static SubPackageMatcher on(final IncQueryEngine engine) throws IncQueryException {
    // check if matcher already exists
    SubPackageMatcher matcher = engine.getExistingMatcher(querySpecification());
    if (matcher == null) {
    	matcher = new SubPackageMatcher(engine);
    	// do not have to "put" it into engine.matchers, reportMatcherInitialized() will take care of it
    }
    return matcher;
  }
  
  private final static int POSITION_P = 0;
  
  private final static int POSITION_SP = 1;
  
  /**
   * 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.
   * <p>The matcher will be created within the managed {@link IncQueryEngine} belonging to the EMF model root, so
   * multiple matchers will reuse the same engine and benefit from increased performance and reduced memory footprint.
   * @param 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
   * @deprecated use {@link #on(IncQueryEngine)} instead, e.g. in conjunction with {@link IncQueryEngine#on(Notifier)}
   * 
   */
  @Deprecated
  public SubPackageMatcher(final Notifier emfRoot) throws IncQueryException {
    this(IncQueryEngine.on(emfRoot));
  }
  
  /**
   * 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.
   * @param engine the existing EMF-IncQuery engine in which this matcher will be created.
   * @throws IncQueryException if an error occurs during pattern matcher creation
   * @deprecated use {@link #on(IncQueryEngine)} instead
   * 
   */
  @Deprecated
  public SubPackageMatcher(final IncQueryEngine engine) throws IncQueryException {
    super(engine, querySpecification());
  }
  
  /**
   * Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
   * @param pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return matches represented as a SubPackageMatch object.
   * 
   */
  public Collection<SubPackageMatch> getAllMatches(final EPackage pP, final EPackage pSp) {
    return rawGetAllMatches(new Object[]{pP, pSp});
  }
  
  /**
   * 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 pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return a match represented as a SubPackageMatch object, or null if no match is found.
   * 
   */
  public SubPackageMatch getOneArbitraryMatch(final EPackage pP, final EPackage pSp) {
    return rawGetOneArbitraryMatch(new Object[]{pP, pSp});
  }
  
  /**
   * 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 pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return true if the input is a valid (partial) match of the pattern.
   * 
   */
  public boolean hasMatch(final EPackage pP, final EPackage pSp) {
    return rawHasMatch(new Object[]{pP, pSp});
  }
  
  /**
   * Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
   * @param pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return the number of pattern matches found.
   * 
   */
  public int countMatches(final EPackage pP, final EPackage pSp) {
    return rawCountMatches(new Object[]{pP, pSp});
  }
  
  /**
   * Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
   * @param pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @param processor the action that will process each pattern match.
   * 
   */
  public void forEachMatch(final EPackage pP, final EPackage pSp, final IMatchProcessor<? super SubPackageMatch> processor) {
    rawForEachMatch(new Object[]{pP, pSp}, 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.
   * @param pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, 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 EPackage pP, final EPackage pSp, final IMatchProcessor<? super SubPackageMatch> processor) {
    return rawForOneArbitraryMatch(new Object[]{pP, pSp}, processor);
  }
  
  /**
   * Registers a new filtered delta monitor on this pattern matcher.
   * The DeltaMonitor can be used to track changes (delta) in the set of filtered pattern matches from now on, considering those matches only that conform to the given fixed values of some parameters.
   * It can also be reset to track changes from a later point in time,
   * and changes can even be acknowledged on an individual basis.
   * See {@link DeltaMonitor} for details.
   * @param fillAtStart if true, all current matches are reported as new match events; if false, the delta monitor starts empty.
   * @param pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return the delta monitor.
   * @deprecated use the IncQuery Databinding API (IncQueryObservables) instead.
   * 
   */
  @Deprecated
  public DeltaMonitor<SubPackageMatch> newFilteredDeltaMonitor(final boolean fillAtStart, final EPackage pP, final EPackage pSp) {
    return rawNewFilteredDeltaMonitor(fillAtStart, new Object[]{pP, pSp});
  }
  
  /**
   * Returns a new (partial) Match object for the matcher.
   * 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 pP the fixed value of pattern parameter p, or null if not bound.
   * @param pSp the fixed value of pattern parameter sp, or null if not bound.
   * @return the (partial) match object.
   * 
   */
  public SubPackageMatch newMatch(final EPackage pP, final EPackage pSp) {
    return new SubPackageMatch.Immutable(pP, pSp);
    
  }
  
  /**
   * Retrieve the set of values that occur in matches for p.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  protected Set<EPackage> rawAccumulateAllValuesOfp(final Object[] parameters) {
    Set<EPackage> results = new HashSet<EPackage>();
    rawAccumulateAllValues(POSITION_P, parameters, results);
    return results;
  }
  
  /**
   * Retrieve the set of values that occur in matches for p.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfp() {
    return rawAccumulateAllValuesOfp(emptyArray());
  }
  
  /**
   * Retrieve the set of values that occur in matches for p.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfp(final SubPackageMatch partialMatch) {
    return rawAccumulateAllValuesOfp(partialMatch.toArray());
  }
  
  /**
   * Retrieve the set of values that occur in matches for p.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfp(final EPackage pSp) {
    return rawAccumulateAllValuesOfp(new Object[]{null, pSp});
  }
  
  /**
   * Retrieve the set of values that occur in matches for sp.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  protected Set<EPackage> rawAccumulateAllValuesOfsp(final Object[] parameters) {
    Set<EPackage> results = new HashSet<EPackage>();
    rawAccumulateAllValues(POSITION_SP, parameters, results);
    return results;
  }
  
  /**
   * Retrieve the set of values that occur in matches for sp.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfsp() {
    return rawAccumulateAllValuesOfsp(emptyArray());
  }
  
  /**
   * Retrieve the set of values that occur in matches for sp.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfsp(final SubPackageMatch partialMatch) {
    return rawAccumulateAllValuesOfsp(partialMatch.toArray());
  }
  
  /**
   * Retrieve the set of values that occur in matches for sp.
   * @return the Set of all values, null if no parameter with the given name exists, empty set if there are no matches
   * 
   */
  public Set<EPackage> getAllValuesOfsp(final EPackage pP) {
    return rawAccumulateAllValuesOfsp(new Object[]{pP, null});
  }
  
  @Override
  protected SubPackageMatch tupleToMatch(final Tuple t) {
    try {
    	return new SubPackageMatch.Immutable((org.eclipse.emf.ecore.EPackage) t.get(POSITION_P), (org.eclipse.emf.ecore.EPackage) t.get(POSITION_SP));
    } catch(ClassCastException e) {engine.getLogger().error("Element(s) in tuple not properly typed!",e);	//throw new IncQueryRuntimeException(e.getMessage());
    	return null;
    }
    
  }
  
  @Override
  protected SubPackageMatch arrayToMatch(final Object[] match) {
    try {
    	return new SubPackageMatch.Immutable((org.eclipse.emf.ecore.EPackage) match[POSITION_P], (org.eclipse.emf.ecore.EPackage) match[POSITION_SP]);
    } catch(ClassCastException e) {engine.getLogger().error("Element(s) in array not properly typed!",e);	//throw new IncQueryRuntimeException(e.getMessage());
    	return null;
    }
    
  }
  
  @Override
  protected SubPackageMatch arrayToMatchMutable(final Object[] match) {
    try {
    	return new SubPackageMatch.Mutable((org.eclipse.emf.ecore.EPackage) match[POSITION_P], (org.eclipse.emf.ecore.EPackage) match[POSITION_SP]);
    } catch(ClassCastException e) {engine.getLogger().error("Element(s) in array not properly typed!",e);	//throw new IncQueryRuntimeException(e.getMessage());
    	return null;
    }
    
  }
}