CreateSpecificationPaletteCommand.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.ba.ui.palette;

import java.util.Optional;

import org.eclipse.emf.ecore.EObject;
import org.osate.aadl2.Classifier;
import org.osate.aadl2.ComponentClassifier;
import org.osate.aadl2.Subcomponent;
import org.osate.ba.aadlba.AadlBaPackage;
import org.osate.ba.aadlba.BehaviorAnnex;
import org.osate.ge.BusinessObjectContext;
import org.osate.ge.aadl2.GraphicalAnnexUtil;
import org.osate.ge.ba.BehaviorAnnexReferenceUtil;
import org.osate.ge.operations.Operation;
import org.osate.ge.operations.StepResult;
import org.osate.ge.operations.StepResultBuilder;
import org.osate.ge.palette.BasePaletteCommand;
import org.osate.ge.palette.GetTargetedOperationContext;
import org.osate.ge.palette.TargetedPaletteCommand;

/**
 * Palette command for creating {@link BehaviorAnnex} elements.
 */
public class CreateSpecificationPaletteCommand extends BasePaletteCommand implements TargetedPaletteCommand {
	/**
	 * Creates a new instance
	 */
	public CreateSpecificationPaletteCommand() {
		super("Behavior Specification", BehaviorAnnexPaletteContributor.BEHAVIOR_ANNEX_CATEGORY_ID, null);
	}

	@Override
	public Optional<Operation> getOperation(final GetTargetedOperationContext ctx) {
		return ctx.getTarget().getBusinessObject(EObject.class).map(eObject -> {
			// Get behavior annex owner
			final Optional<ComponentClassifier> owner = getBehaviorAnnexOwner(ctx.getTarget());
			if (!owner.isPresent()) {
				return null;
			}

			return Operation.createWithBuilder(builder -> {
				builder.supply(() -> StepResult.forValue(owner.orElseThrow())).modifyPreviousResult(classifier -> {
					// Create behavior annex
					final BehaviorAnnex ba = createBehaviorAnnex(classifier);
					// Show new specification
					return StepResultBuilder.create().showNewBusinessObject(ctx.getTarget(), ba).build();
				});
			});
		});
	}

	private static BehaviorAnnex createBehaviorAnnex(final Classifier c) {
		final String name = BehaviorAnnexReferenceUtil.ANNEX_NAME;
		final BehaviorAnnex ba = GraphicalAnnexUtil.createParsedAnnexSubclause(c, name,
				AadlBaPackage.eINSTANCE.getBehaviorAnnex(), BehaviorAnnex.class);
		ba.setName(name);
		return ba;
	}

	// Get classifier that will own behavior annex
	private Optional<ComponentClassifier> getBehaviorAnnexOwner(final BusinessObjectContext boc) {
		final Subcomponent sc = boc.getBusinessObject(Subcomponent.class).orElse(null);
		if (sc != null) {
			return Optional.ofNullable(sc.getAllClassifier());
		}

		return boc.getBusinessObject(ComponentClassifier.class);
	}
}