ConnectionHandler.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.ArrayList;
import java.util.List;
import java.util.Optional;

import org.osate.aadl2.ConnectedElement;
import org.osate.aadl2.Connection;
import org.osate.aadl2.Context;
import org.osate.aadl2.SubprogramCall;
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.aadl2.internal.util.AadlInheritanceUtil;
import org.osate.ge.businessobjecthandling.CanDeleteContext;
import org.osate.ge.businessobjecthandling.CanRenameContext;
import org.osate.ge.businessobjecthandling.GetGraphicalConfigurationContext;
import org.osate.ge.businessobjecthandling.GetNameContext;
import org.osate.ge.businessobjecthandling.IsApplicableContext;
import org.osate.ge.businessobjecthandling.ReferenceContext;
import org.osate.ge.graphics.ConnectionBuilder;
import org.osate.ge.graphics.Graphic;
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.query.QueryResult;
import org.osate.ge.services.QueryService;

public class ConnectionHandler extends AadlBusinessObjectHandler {
	private static final Graphic GRAPHIC = ConnectionBuilder.create().build();
	private static final ExecutableQuery<Connection> SRC_QUERY = ExecutableQuery
			.create(rootQuery -> rootQuery.parent()
					.descendantsByBusinessObjectsRelativeReference(c -> getBusinessObjectsPathToConnectedElement(
							c.getAllSourceContext(), c.getRootConnection().getSource()), 1)
					.first());
	private static final ExecutableQuery<Connection> DST_QUERY = ExecutableQuery
			.create(rootQuery -> rootQuery.parent()
					.descendantsByBusinessObjectsRelativeReference(c -> getBusinessObjectsPathToConnectedElement(
							c.getAllDestinationContext(), c.getRootConnection().getDestination()), 1)
					.first());

	@Override
	public boolean isApplicable(final IsApplicableContext ctx) {
		return ctx.getBusinessObject(Connection.class).isPresent();
	}

	@Override
	public CanonicalBusinessObjectReference getCanonicalReference(final ReferenceContext ctx) {
		return new CanonicalBusinessObjectReference(DeclarativeReferenceType.CONNECTION.getId(),
				ctx.getBusinessObject(Connection.class).orElseThrow().getQualifiedName());
	}

	@Override
	public RelativeBusinessObjectReference getRelativeReference(final ReferenceContext ctx) {
		return AadlReferenceUtil.buildSimpleRelativeReference(DeclarativeReferenceType.CONNECTION.getId(),
				ctx.getBusinessObject(Connection.class).orElseThrow());
	}

	@Override
	public boolean canDelete(final CanDeleteContext ctx) {
		return true;
	}

	@Override
	public Optional<GraphicalConfiguration> getGraphicalConfiguration(final GetGraphicalConfigurationContext ctx) {
		final BusinessObjectContext boc = ctx.getBusinessObjectContext();
		final QueryService queryService = ctx.getQueryService();

		final Connection c = boc.getBusinessObject(Connection.class).orElseThrow();
		final QueryResult src = queryService.getFirstResult(SRC_QUERY, boc, c).orElse(null);
		final QueryResult dst = queryService.getFirstResult(DST_QUERY, boc, c).orElse(null);
		final boolean partial = (src != null && src.isPartial()) || (dst != null && dst.isPartial());

		final StyleBuilder sb = StyleBuilder
				.create(AadlInheritanceUtil.isInherited(boc) ? Styles.INHERITED_ELEMENT : Style.EMPTY);
		if (partial) {
			sb.dotted();
		}

		return Optional.of(GraphicalConfigurationBuilder.create()
				.graphic(GRAPHIC)
				.style(sb.build())
				.source(src == null ? null : src.getBusinessObjectContext())
				.destination(dst == null ? null : dst.getBusinessObjectContext())
				.build());
	}

	/**
	 * Gets an array of business objects which describes the logical diagram element path to the connection end.
	 * @param ctx
	 * @param connectionEnd
	 * @return
	 */
	private static Object[] getBusinessObjectsPathToConnectedElement(final Context ctx,
			final ConnectedElement connectedElement) {
		if (connectedElement == null) {
			return null;
		}

		final List<Object> path = new ArrayList<>(6);
		if (ctx instanceof SubprogramCall) {
			path.add(ctx.eContainer());
		}

		if (ctx != null) {
			path.add(ctx);
		}

		for (ConnectedElement tmp = connectedElement; tmp != null; tmp = tmp.getNext()) {
			path.add(tmp.getConnectionEnd());
		}

		return path.toArray();
	}

	@Override
	public String getName(final GetNameContext ctx) {
		return ctx.getBusinessObject(Connection.class).map(c -> c.getName()).orElse("");
	}

	@Override
	public boolean canRename(final CanRenameContext ctx) {
		return true;
	}
}