ModeTransitionTriggerHandler.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 java.util.function.UnaryOperator;

import org.osate.aadl2.ModeTransitionTrigger;
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.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.services.QueryService;

import com.google.common.base.Strings;

public class ModeTransitionTriggerHandler extends AadlBusinessObjectHandler {
	private static final Graphic GRAPHIC = ConnectionBuilder.create().build();
	private static final Style STYLE = StyleBuilder.create().dashed().primaryLabelVisible(false).build();

	// If context is null look for the port under the trigger's ancestor. if context is not null use ancestor(1).children().filterByBo(context);
	private static final ExecutableQuery<ModeTransitionTrigger> DST_QUERY = ExecutableQuery.create(
			rootQuery -> rootQuery.ancestor(2)
			.ifElse(ca -> ca.getQueryArgument().getContext() == null, UnaryOperator.identity(),
			innerRoot -> innerRoot.children()
			.filterByBusinessObjectRelativeReference(ModeTransitionTrigger::getContext)
			.first())
			.children()
			.filterByBusinessObjectRelativeReference(ModeTransitionTrigger::getTriggerPort));

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

	@Override
	public CanonicalBusinessObjectReference getCanonicalReference(final ReferenceContext ctx) {
		final ModeTransitionTrigger mtt = ctx.getBusinessObject(ModeTransitionTrigger.class).get();
		return new CanonicalBusinessObjectReference(DeclarativeReferenceType.MODE_TRANSITION_TRIGGER.getId(),
				ctx.getReferenceBuilder().getCanonicalReference(mtt.eContainer()).encode(),
				AadlReferenceUtil.getNameForSerialization(mtt.getContext()),
				AadlReferenceUtil.getNameForSerialization(mtt.getTriggerPort()));
	}

	@Override
	public RelativeBusinessObjectReference getRelativeReference(final ReferenceContext ctx) {
		final ModeTransitionTrigger mtt = ctx.getBusinessObject(ModeTransitionTrigger.class).get();
		return new RelativeBusinessObjectReference(DeclarativeReferenceType.MODE_TRANSITION_TRIGGER.getId(),
				AadlReferenceUtil.getNameForSerialization(mtt.getContext()),
				AadlReferenceUtil.getNameForSerialization(mtt.getTriggerPort()));
	}

	@Override
	public Optional<GraphicalConfiguration> getGraphicalConfiguration(final GetGraphicalConfigurationContext ctx) {
		final BusinessObjectContext boc = ctx.getBusinessObjectContext();
		final QueryService queryService = ctx.getQueryService();
		return Optional.of(GraphicalConfigurationBuilder.create()
				.graphic(GRAPHIC)
				.style(STYLE)
				.source(getSource(boc))
				.destination(getDestination(boc, queryService))
				.build());
	}

	@Override
	public String getName(final GetNameContext ctx) {
		return ctx.getBusinessObject(ModeTransitionTrigger.class).map(this::getName).orElse("");
	}

	public String getName(final ModeTransitionTrigger mtt) {
		final String portName = Strings
				.nullToEmpty(mtt.getTriggerPort() == null ? null : mtt.getTriggerPort().getName());
		if (Strings.isNullOrEmpty(portName)) {
			return null;
		}

		final String contextName = Strings.nullToEmpty(mtt.getContext() == null ? null : mtt.getContext().getName());
		return (contextName.length() == 0 ? "" : (contextName + ".")) + portName;
	}

// Source - the mode transition
	private BusinessObjectContext getSource(final BusinessObjectContext boc) {
		return boc.getParent();
	}

// Destination - trigger feature
	private BusinessObjectContext getDestination(final BusinessObjectContext boc, final QueryService queryService) {
		return queryService.getFirstBusinessObjectContextOrNull(DST_QUERY, boc,
				boc.getBusinessObject(ModeTransitionTrigger.class).orElseThrow());
	}
}