plugins/org.eclipse.qvtd.umlx/src/org/eclipse/qvtd/umlx/utilities/UMLXToStringVisitor.java

/*******************************************************************************
 * Copyright (c) 2016, 2017 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.umlx.utilities;

import java.util.List;

import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.ocl.pivot.utilities.LabelUtil;
import org.eclipse.qvtd.umlx.RelPatternNode;
import org.eclipse.qvtd.umlx.RelDiagram;
import org.eclipse.qvtd.umlx.RelDomainNode;
import org.eclipse.qvtd.umlx.RelInvocationEdge;
import org.eclipse.qvtd.umlx.RelInvocationNode;
import org.eclipse.qvtd.umlx.RelPatternEdge;
import org.eclipse.qvtd.umlx.TxKeyNode;
import org.eclipse.qvtd.umlx.TxPackageNode;
import org.eclipse.qvtd.umlx.TxPartNode;
import org.eclipse.qvtd.umlx.TxQueryNode;
import org.eclipse.qvtd.umlx.TxTypedModelNode;
import org.eclipse.qvtd.umlx.UMLXElement;
import org.eclipse.qvtd.umlx.UMLXModel;
import org.eclipse.qvtd.umlx.UMLXNamedElement;
import org.eclipse.qvtd.umlx.UMLXTypedElement;
import org.eclipse.qvtd.umlx.util.AbstractExtendingUMLXVisitor;

public class UMLXToStringVisitor extends AbstractExtendingUMLXVisitor<@Nullable Object, @NonNull StringBuilder>
{
	public static @NonNull String toString(@NonNull UMLXElement umlxElement) {
		UMLXToStringVisitor umlxToStringVisitor = new UMLXToStringVisitor();
		umlxElement.accept(umlxToStringVisitor);
		return umlxToStringVisitor.toString();
	}

	protected UMLXToStringVisitor() {
		super(new StringBuilder());
	}

	private void append(@Nullable String string) {
		context.append(string != null ? string : "null");
	}

	@Override
	public @NonNull String toString() {
		return context.toString();
	}

	@Override
	public @Nullable Object visitRelDomainNode(@NonNull RelDomainNode relDomainNode) {
		TxTypedModelNode txTypedModelNode = relDomainNode.getReferredTxTypedModelNode();
		append(txTypedModelNode != null ? txTypedModelNode.getName() : null);
		return null;
	}

	@Override
	public @Nullable Object visitRelInvocationEdge(@NonNull RelInvocationEdge relInvocationEdge) {
		RelPatternNode relPatternNode = relInvocationEdge.getReferredRelPatternNode();
		if (relPatternNode != null) {
			return relPatternNode.accept(this);
		}
		append(null);
		return null;
	}

	@Override
	public @Nullable Object visitRelInvocationNode(@NonNull RelInvocationNode relInvocationNode) {
		RelDiagram relDiagram = relInvocationNode.getReferredRelDiagram();
		append(relDiagram != null ? relDiagram.getName() : null);
		return null;
	}

	@Override
	public @Nullable Object visitRelPatternEdge(@NonNull RelPatternEdge relPatternEdge) {
		EStructuralFeature eStructuralFeature = relPatternEdge.getReferredEStructuralFeature();
		if (eStructuralFeature != null) {
			append(LabelUtil.getLabel(eStructuralFeature));
		}
		else {
			append("«" + relPatternEdge.getSourceIndex() + "»");
		}
		return null;
	}

	@Override
	public @Nullable Object visitRelPatternNode(@NonNull RelPatternNode relPatternNode) {
		if (relPatternNode.isExpression()) {
			List<String> lines = relPatternNode.getInitExpressionLines();
			if (lines.size() > 0) {
				boolean firstLine = true;
				for (String line : lines) {
					if (!firstLine) {
						append("\n");
					}
					append(line);
					firstLine = false;
				}
			}
			return null;
		}
		else {
			visitUMLXTypedElement(relPatternNode);
			List<String> lines = relPatternNode.getInitExpressionLines();
			if (lines.size() > 0) {
				append(" = ");
				boolean firstLine = true;
				for (String line : lines) {
					if (!firstLine) {
						append("\n");
					}
					append(line);
					firstLine = false;
				}
			}
			return null;
		}
	}

	@Override
	public @Nullable Object visitTxKeyNode(@NonNull TxKeyNode txKeyNode) {
		EClassifier eClassifier = txKeyNode.getReferredEClass();
		append(LabelUtil.getLabel(eClassifier));
		return null;
	}

	@Override
	public @Nullable Object visitTxPackageNode(@NonNull TxPackageNode txPackageNode) {
		EPackage ePackage = txPackageNode.getReferredEPackage();
		append(LabelUtil.getLabel(ePackage));
		return null;
	}

	@Override
	public @Nullable Object visitTxPartNode(@NonNull TxPartNode txPartNode) {
		EStructuralFeature eStructuralFeature = txPartNode.getReferredEStructuralFeature();
		if (txPartNode.isIsOpposite()) {
			append("~");
		}
		append(LabelUtil.getLabel(eStructuralFeature));
		return null;
	}

	@Override
	public @Nullable Object visitTxQueryNode(@NonNull TxQueryNode txQueryNode) {
		visitUMLXTypedElement(txQueryNode);
		// fixme parameters
		List<String> lines = txQueryNode.getInitExpressionLines();
		if (lines.size() > 0) {
			append(" = ");
			boolean firstLine = true;
			for (String line : lines) {
				if (!firstLine) {
					append("\n");
				}
				append(line);
				firstLine = false;
			}
		}
		return null;
	}

	@Override
	public @Nullable Object visitTxTypedModelNode(@NonNull TxTypedModelNode txTypedModelNode) {
		append(txTypedModelNode.getName());
		return null;
	}

	@Override
	public @Nullable Object visitUMLXModel(@NonNull UMLXModel umlxModel) {
		return "UMLXModel";
	}

	@Override
	public @Nullable Object visitUMLXNamedElement(@NonNull UMLXNamedElement umlxNamedElement) {
		append(umlxNamedElement.getName());
		return null;
	}

	@Override
	public @Nullable Object visitUMLXTypedElement(@NonNull UMLXTypedElement umlxTypedElement) {
		EClassifier eClassifier = umlxTypedElement.getReferredEClassifier();
		append(umlxTypedElement.getName());
		append(" : ");
		if (umlxTypedElement.isIsMany()) {
			if (umlxTypedElement.isIsUnique()) {
				append(umlxTypedElement.isIsOrdered() ? "OrderedSet" : "Set");
			}
			else {
				append(umlxTypedElement.isIsOrdered() ? "Sequence" : "Bag");
			}
			append("(");
			append(LabelUtil.getLabel(eClassifier));
			append(umlxTypedElement.isIsNullFree() ? "[*|1]" : "[*|?]");
			append(")");
		}
		else {
			append(LabelUtil.getLabel(eClassifier));
		}
		append(umlxTypedElement.isIsRequired() ? "[1]" : "[?]");
		return null;
	}

	@Override
	public @Nullable Object visiting(@NonNull UMLXElement umlxElement) {
		append("Unsupported " + getClass().getSimpleName() + " for " + umlxElement.eClass().getName());
		return null;
	}
}