GeneralizatonHandler.java

/**
 * Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file).
 * All Rights Reserved.
 *
 * NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
 * KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
 * OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
 * MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * SPDX-License-Identifier: EPL-2.0
 *
 * Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
 *
 * This program includes and/or can make use of certain third party source code, object code, documentation and other
 * files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
 * configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
 * conditions contained in any such Third Party Software or separate license file distributed with such Third Party
 * Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
 * aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
 * censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
 */
package org.osate.ge.aadl2.internal;

import java.util.Optional;

import org.osate.aadl2.Classifier;
import org.osate.aadl2.Generalization;
import org.osate.aadl2.GroupExtension;
import org.osate.aadl2.ImplementationExtension;
import org.osate.aadl2.Realization;
import org.osate.aadl2.TypeExtension;
import org.osate.ge.BusinessObjectContext;
import org.osate.ge.CanonicalBusinessObjectReference;
import org.osate.ge.GraphicalConfiguration;
import org.osate.ge.GraphicalConfigurationBuilder;
import org.osate.ge.RelativeBusinessObjectReference;
import org.osate.ge.businessobjecthandling.CanDeleteContext;
import org.osate.ge.businessobjecthandling.GetGraphicalConfigurationContext;
import org.osate.ge.businessobjecthandling.GetNameContext;
import org.osate.ge.businessobjecthandling.GetNameForDiagramContext;
import org.osate.ge.businessobjecthandling.IsApplicableContext;
import org.osate.ge.businessobjecthandling.ReferenceContext;
import org.osate.ge.graphics.ArrowBuilder;
import org.osate.ge.graphics.Color;
import org.osate.ge.graphics.ConnectionBuilder;
import org.osate.ge.graphics.Graphic;
import org.osate.ge.graphics.LabelBuilder;
import org.osate.ge.graphics.Style;
import org.osate.ge.graphics.StyleBuilder;
import org.osate.ge.internal.services.impl.DeclarativeReferenceType;
import org.osate.ge.query.ExecutableQuery;
import org.osate.ge.services.QueryService;

public class GeneralizatonHandler extends AadlBusinessObjectHandler {
	private static final Graphic EXTENDS_GRAPHIC = ConnectionBuilder.create()
			.destinationTerminator(ArrowBuilder.create().open().build())
			.build();
	private static final Style EXTENDS_STYLE = StyleBuilder.create().backgroundColor(Color.WHITE).build();
	private static final Graphic IMPLEMENTS_GRAPHIC = ConnectionBuilder.create()
			.destinationTerminator(ArrowBuilder.create().open().build())
			.build();
	private static final Style IMPLEMENTS_STYLE = StyleBuilder.create().backgroundColor(Color.WHITE).dashed().build();
	private static final Graphic LABEL_GRAPHIC = LabelBuilder.create().build();
	private static final ExecutableQuery<Generalization> NESTED_CLASSIFIER_QUERY = ExecutableQuery
			.create(rootQuery -> rootQuery
					.descendantsByBusinessObjectsRelativeReference(g -> getBusinessObjectPath(g.getGeneral())));

	@Override
	public boolean isApplicable(final IsApplicableContext ctx) {
		return ctx.getBusinessObject(Realization.class).isPresent()
				|| ctx.getBusinessObject(TypeExtension.class).isPresent()
				|| ctx.getBusinessObject(ImplementationExtension.class).isPresent()
				|| ctx.getBusinessObject(GroupExtension.class).isPresent();
	}

	@Override
	public CanonicalBusinessObjectReference getCanonicalReference(final ReferenceContext ctx) {
		final Object bo = ctx.getBusinessObject();

		if (bo instanceof Realization) {
			return new CanonicalBusinessObjectReference(DeclarativeReferenceType.REALIZATION.getId(),
					((Realization) bo).getSpecific().getQualifiedName());
		} else if (bo instanceof TypeExtension) {
			return new CanonicalBusinessObjectReference(DeclarativeReferenceType.TYPE_EXTENSION.getId(),
					((TypeExtension) bo).getSpecific().getQualifiedName());
		} else if (bo instanceof ImplementationExtension) {
			return new CanonicalBusinessObjectReference(DeclarativeReferenceType.IMPLEMENTATION_EXTENSION.getId(),
					((ImplementationExtension) bo).getSpecific().getQualifiedName());
		} else if (bo instanceof GroupExtension) {
			return new CanonicalBusinessObjectReference(DeclarativeReferenceType.GROUP_EXTENSION.getId(),
					((GroupExtension) bo).getSpecific().getQualifiedName());
		}

		throw new RuntimeException("Unexpected business object " + bo);
	}

	@Override
	public RelativeBusinessObjectReference getRelativeReference(final ReferenceContext ctx) {
		final Object bo = ctx.getBusinessObject();

		if (bo instanceof Realization) {
			return new RelativeBusinessObjectReference(DeclarativeReferenceType.REALIZATION.getId());
		} else if (bo instanceof TypeExtension) {
			return new RelativeBusinessObjectReference(DeclarativeReferenceType.TYPE_EXTENSION.getId());
		} else if (bo instanceof ImplementationExtension) {
			return new RelativeBusinessObjectReference(DeclarativeReferenceType.IMPLEMENTATION_EXTENSION.getId());
		} else if (bo instanceof GroupExtension) {
			return new RelativeBusinessObjectReference(DeclarativeReferenceType.GROUP_EXTENSION.getId());
		}

		throw new RuntimeException("Unexpected business object " + bo);
	}

	@Override
	public boolean canDelete(final CanDeleteContext ctx) {
		return ctx.getBusinessObject(TypeExtension.class).isPresent()
				|| ctx.getBusinessObject(ImplementationExtension.class).isPresent()
				|| ctx.getBusinessObject(GroupExtension.class).isPresent();
	}

	@Override
	public Optional<GraphicalConfiguration> getGraphicalConfiguration(final GetGraphicalConfigurationContext ctx) {
		final BusinessObjectContext boc = ctx.getBusinessObjectContext();
		final Object bo = boc.getBusinessObject();
		final QueryService queryService = ctx.getQueryService();
		final BusinessObjectContext destination = getDestination(boc, queryService);

		if (destination == null) {
			return Optional.of(GraphicalConfigurationBuilder.create().graphic(LABEL_GRAPHIC).build());
		} else {
			return Optional.of(GraphicalConfigurationBuilder.create()
					.graphic(getConnectionGraphicalRepresentation(bo))
					.style(getStyle(bo))
					.source(boc.getParent())
					. // Source is the owner of the BO
					destination(getDestination(boc, queryService))
					.build());
		}
	}

	private Graphic getConnectionGraphicalRepresentation(final Object bo) {
		return bo instanceof Realization ? IMPLEMENTS_GRAPHIC : EXTENDS_GRAPHIC;
	}

	private Style getStyle(final Object bo) {
		return bo instanceof Realization ? IMPLEMENTS_STYLE : EXTENDS_STYLE;
	}

	private BusinessObjectContext getDestination(final BusinessObjectContext boc, final QueryService queryService) {
		final BusinessObjectContext pkgBoc = boc.getParent().getParent();
		if (pkgBoc == null) {
			return null;
		}

		final BusinessObjectContext packageParentBoc = pkgBoc.getParent();

		// Showing generalizations as connections is only supported on diagrams which contain package symbols
		if (packageParentBoc == null) {
			return null;
		}

		return queryService.getFirstBusinessObjectContextOrNull(NESTED_CLASSIFIER_QUERY, packageParentBoc,
				boc.getBusinessObject(Generalization.class).orElseThrow());
	}

	private static Object[] getBusinessObjectPath(final Classifier c) {
		return new Object[] { c.getElementRoot(), c };
	}

	@Override
	public String getNameForDiagram(final GetNameForDiagramContext ctx) {
		// Don't show the name when displaying as a connection
		if (getDestination(ctx.getBusinessObjectContext(), ctx.getQueryService()) != null) {
			return "";
		}

		return super.getNameForDiagram(ctx);
	}

	@Override
	public String getName(final GetNameContext ctx) {
		return ctx.getBusinessObject(Generalization.class).map(generalization -> {
			final Classifier general = generalization.getGeneral();
			if (general == null) {
				return null;
			}

			final Classifier specific = generalization.getSpecific();
			if (specific == null) {
				return null;
			}

			// Only show the name of the general element if both elements are in the same package.
			final String generalName;
			if (general.getElementRoot() == specific.getElementRoot()) {
				generalName = general.getName();
			} else {
				generalName = general.getQualifiedName();
			}

			return (generalization instanceof Realization ? "Implements " : "Extends ") + generalName;

		}).orElse("");
	}
}