plugins/org.eclipse.qvtd.compiler/src/org/eclipse/qvtd/compiler/internal/qvtp2qvts/Role.java

/*******************************************************************************
 * Copyright (c) 2015, 2016 Willink Transformations and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   E.D.Willink - Initial API and implementation
 *******************************************************************************/
package org.eclipse.qvtd.compiler.internal.qvtp2qvts;

import org.eclipse.jdt.annotation.NonNull;

/**
 * Role defines which of many possible roles an edge plays
 */
public interface Role extends Comparable<Role>
{
	public static final @NonNull String BINDING_COLOR = "orange";
	public static final @NonNull String CONSTANT_COLOR = "black";
	public static final @NonNull String ERROR_COLOR = "red";
	public static final @NonNull String ITERATION_COLOR = "magenta";
	public static final @NonNull String LOADED_COLOR = "blue";
	public static final @NonNull String OPERATION_COLOR = "magenta";
	public static final @NonNull String ORDERING_COLOR = "brown";
	public static final @NonNull String OTHER_COLOR = "grey";
	public static final @NonNull String PREDICATED_COLOR = "cyan";
	public static final @NonNull String REALIZED_COLOR = "green";
	public static final @NonNull String RECURSION_COLOR = "brown";
	public static final @NonNull String SPECULATED_COLOR = "orange";
	public static final @NonNull String SPECULATION_COLOR = "red";

	public static final @NonNull Integer HEAD_WIDTH = 8;
	public static final @NonNull Integer GUARD_WIDTH = 4;
	public static final @NonNull Integer LINE_WIDTH = 2;

	/**
	 * Phase identifies the different processing phases of a mapping. The phases are ordered by decreasing
	 * certainty, allowing the earlier to be chosen by a merge.
	 */
	public enum Phase {
		CONSTANT,		// Unequivocably known as compile time constant
		LOADED,			// Known once input models loaded
		REALIZED,		// Known once a mapping has realized its results
		PREDICATED,		// Not known, awaiting matching
		SPECULATION,	// Awaiting other mappings to speculate
		SPECULATED,		// Known other mappings are speculating
		OTHER			// Not known, nothing to do with mapping execution.
	};

	/**
	 * Return a variant of this role suitable for phase.
	 */
	@NonNull Role asPhase(@NonNull Phase phase);

	/**
	 * Return the color with which this glyph is drawn.
	 */
	@NonNull String getColor();

	@NonNull Phase getPhase();

	boolean isConstant();

	boolean isLoaded();

	boolean isPredicated();

	boolean isSpeculated();

	boolean isRealized();

	boolean isSpeculation();
}