AadlInstanceObjectUtil.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.util;

import java.util.Optional;

import org.osate.aadl2.ComponentImplementation;
import org.osate.aadl2.ModalElement;
import org.osate.aadl2.ModalPath;
import org.osate.aadl2.instance.ComponentInstance;
import org.osate.aadl2.instance.ConnectionReference;
import org.osate.aadl2.instance.EndToEndFlowInstance;
import org.osate.aadl2.instance.FlowSpecificationInstance;
import org.osate.aadl2.instance.InstanceObject;
import org.osate.ge.BusinessObjectContext;

public class AadlInstanceObjectUtil {
	public static Optional<ComponentInstance> getComponentInstance(final Object bo) {
		final ComponentInstance ci;
		if (bo instanceof BusinessObjectContext) {
			return getComponentInstance(((BusinessObjectContext) bo).getBusinessObject());
		} else if (bo instanceof ComponentInstance) {
			// If component instance is a subcomponent, it must extend a component implementation
			ci = (((ComponentInstance) bo).getSubcomponent() == null
					|| (((ComponentInstance) bo).getSubcomponent() != null && (((ComponentInstance) bo)
							.getSubcomponent().getAllClassifier() instanceof ComponentImplementation)))
					? (ComponentInstance) bo
							: null;
		} else {
			ci = null;
		}

		return Optional.ofNullable(ci);
	}

	/**
	 * Get the modal element that is represented by an instance object.
	 * @param instanceObject
	 * @return modal element. Null if not a modal element.
	 */
	public static ModalElement getModalElement(final InstanceObject instanceObject) {
		if (instanceObject instanceof FlowSpecificationInstance) {
			return ((FlowSpecificationInstance) instanceObject).getFlowSpecification();
		} else if (instanceObject instanceof ConnectionReference) {
			return ((ConnectionReference) instanceObject).getConnection();
		} else if (instanceObject instanceof EndToEndFlowInstance) {
			return ((EndToEndFlowInstance) instanceObject).getEndToEndFlow();
		} else if (instanceObject instanceof ComponentInstance) {
			return ((ComponentInstance) instanceObject).getSubcomponent();
		}

		return null;
	}

	/**
	 * Get the modal path that is represented by an instance object
	 * @param childBo
	 * @return
	 */
	public static ModalPath getModalPath(final Object childBo) {
		if (childBo instanceof FlowSpecificationInstance) {
			return ((FlowSpecificationInstance) childBo).getFlowSpecification();
		} else if (childBo instanceof ConnectionReference) {
			return ((ConnectionReference) childBo).getConnection();
		} else if (childBo instanceof EndToEndFlowInstance) {
			return ((EndToEndFlowInstance) childBo).getEndToEndFlow();
		} else {
			throw new RuntimeException(childBo + "unsupported instance object");
		}
	}
}