EClassMatch.java

package org.eclipse.viatra.query.application.queries;

import java.util.Arrays;
import java.util.List;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.viatra.query.application.queries.util.EClassQuerySpecification;
import org.eclipse.viatra.query.runtime.api.IPatternMatch;
import org.eclipse.viatra.query.runtime.api.impl.BasePatternMatch;
import org.eclipse.viatra.query.runtime.exception.ViatraQueryException;

/**
 * Pattern-specific match representation of the org.eclipse.viatra.query.application.queries.eClass pattern,
 * to be used in conjunction with {@link EClassMatcher}.
 * 
 * <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 EClassMatcher
 * @see EClassProcessor
 * 
 */
@SuppressWarnings("all")
public abstract class EClassMatch extends BasePatternMatch {
  private EClass fEc;
  
  private static List<String> parameterNames = makeImmutableList("ec");
  
  private EClassMatch(final EClass pEc) {
    this.fEc = pEc;
  }
  
  @Override
  public Object get(final String parameterName) {
    if ("ec".equals(parameterName)) return this.fEc;
    return null;
  }
  
  public EClass getEc() {
    return this.fEc;
  }
  
  @Override
  public boolean set(final String parameterName, final Object newValue) {
    if (!isMutable()) throw new java.lang.UnsupportedOperationException();
    if ("ec".equals(parameterName) ) {
    	this.fEc = (EClass) newValue;
    	return true;
    }
    return false;
  }
  
  public void setEc(final EClass pEc) {
    if (!isMutable()) throw new java.lang.UnsupportedOperationException();
    this.fEc = pEc;
  }
  
  @Override
  public String patternName() {
    return "org.eclipse.viatra.query.application.queries.eClass";
  }
  
  @Override
  public List<String> parameterNames() {
    return EClassMatch.parameterNames;
  }
  
  @Override
  public Object[] toArray() {
    return new Object[]{fEc};
  }
  
  @Override
  public EClassMatch toImmutable() {
    return isMutable() ? newMatch(fEc) : this;
  }
  
  @Override
  public String prettyPrint() {
    StringBuilder result = new StringBuilder();
    result.append("\"ec\"=" + prettyPrintValue(fEc)
    );
    return result.toString();
  }
  
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((fEc == null) ? 0 : fEc.hashCode());
    return result;
  }
  
  @Override
  public boolean equals(final Object obj) {
    if (this == obj)
    	return true;
    if (!(obj instanceof EClassMatch)) { // this should be infrequent
    	if (obj == null) {
    		return false;
    	}
    	if (!(obj instanceof IPatternMatch)) {
    		return false;
    	}
    	IPatternMatch otherSig  = (IPatternMatch) obj;
    	if (!specification().equals(otherSig.specification()))
    		return false;
    	return Arrays.deepEquals(toArray(), otherSig.toArray());
    }
    EClassMatch other = (EClassMatch) obj;
    if (fEc == null) {if (other.fEc != null) return false;}
    else if (!fEc.equals(other.fEc)) return false;
    return true;
  }
  
  @Override
  public EClassQuerySpecification specification() {
    try {
    	return EClassQuerySpecification.instance();
    } catch (ViatraQueryException ex) {
     	// This cannot happen, as the match object can only be instantiated if the query specification exists
     	throw new IllegalStateException (ex);
    }
  }
  
  /**
   * 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 EClassMatch 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 pEc the fixed value of pattern parameter ec, or null if not bound.
   * @return the new, mutable (partial) match object.
   * 
   */
  public static EClassMatch newMutableMatch(final EClass pEc) {
    return new Mutable(pEc);
  }
  
  /**
   * 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 pEc the fixed value of pattern parameter ec, or null if not bound.
   * @return the (partial) match object.
   * 
   */
  public static EClassMatch newMatch(final EClass pEc) {
    return new Immutable(pEc);
  }
  
  private static final class Mutable extends EClassMatch {
    Mutable(final EClass pEc) {
      super(pEc);
    }
    
    @Override
    public boolean isMutable() {
      return true;
    }
  }
  
  private static final class Immutable extends EClassMatch {
    Immutable(final EClass pEc) {
      super(pEc);
    }
    
    @Override
    public boolean isMutable() {
      return false;
    }
  }
}