ScaWaveformMergeComponentsCommand.java

/** 
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 * 
 * This file is part of REDHAWK IDE.
 * 
 * All rights reserved.  This program and the accompanying materials are made available under 
 * the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html.
 *
 */
package gov.redhawk.model.sca.commands;

import gov.redhawk.model.sca.ScaComponent;
import gov.redhawk.model.sca.ScaFactory;
import gov.redhawk.model.sca.ScaModelPlugin;
import gov.redhawk.model.sca.ScaPackage;
import gov.redhawk.model.sca.ScaWaveform;

import java.util.HashMap;
import java.util.Map;

import mil.jpeojtrs.sca.sad.HostCollocation;
import mil.jpeojtrs.sca.sad.SadComponentInstantiation;
import mil.jpeojtrs.sca.sad.SadComponentPlacement;
import mil.jpeojtrs.sca.sad.SadPartitioning;
import mil.jpeojtrs.sca.sad.SoftwareAssembly;
import mil.jpeojtrs.sca.util.ScaUriHelpers;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.util.TreeIterator;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.util.EcoreUtil;

import CF.ComponentType;
import CF.Resource;
import CF.ResourceHelper;

/**
 * Used when updating the components belonging to a domain waveform.
 * @since 14.0
 */
public class ScaWaveformMergeComponentsCommand extends SetStatusCommand<ScaWaveform> {

	private final ComponentType[] compTypes;

	/**
	 * Creates an EMF command which will update a waveform's components based on data from a CORBA call.
	 * <p/>
	 * Note that this method narrows CORBA objects, and therefore may be subject to a CORBA call.
	 * @param provider The waveform to update
	 * @param compTypes The information from a CORBA call about the waveform's current components
	 * @param componentStatus The status from fetching CORBA data about the waveform's current components
	 * @since 15.0
	 */
	public ScaWaveformMergeComponentsCommand(ScaWaveform provider, ComponentType[] compTypes, IStatus componentStatus) {
		super(provider, ScaPackage.Literals.SCA_WAVEFORM__COMPONENTS, componentStatus);
		if (compTypes == null) {
			this.compTypes = new ComponentType[0];
		} else {
			this.compTypes = compTypes;
		}
		for (int i = 0; i < compTypes.length; i++) {
			compTypes[i].componentObject = ResourceHelper.narrow(compTypes[i].componentObject);
		}
	}

	@Override
	protected boolean prepare() {
		return super.prepare();
	}

	@Override
	public void execute() {
		if (status.isOK()) {
			final Map<String, ComponentType> newComponentsMap = new HashMap<String, ComponentType>();
			for (final ComponentType compType : compTypes) {
				newComponentsMap.put(compType.identifier, compType);
			}

			// Current component Map
			final Map<String, ScaComponent> currentComponents = new HashMap<String, ScaComponent>();
			for (final ScaComponent component : provider.getComponents()) {
				String componentId = component.getIdentifier();
				currentComponents.put(componentId, component);
			}

			// Components to remove
			final Map<String, ScaComponent> removeComponents = new HashMap<String, ScaComponent>();
			removeComponents.putAll(currentComponents);
			removeComponents.keySet().removeAll(newComponentsMap.keySet());

			// Remove components
			if (!removeComponents.isEmpty() && !provider.getComponents().isEmpty()) {
				provider.getComponents().removeAll(removeComponents.values());
			}

			// Remove duplicates
			newComponentsMap.keySet().removeAll(currentComponents.keySet());

			URI profileURI = provider.getProfileURI();
			for (final ComponentType typeInfo : newComponentsMap.values()) {
				URI spdUri = ScaUriHelpers.createFileSystemURI(typeInfo.softwareProfile, profileURI, null);
				final ScaComponent component = createComponent(typeInfo.identifier, typeInfo.softwareProfile, typeInfo.componentObject);
				if (typeInfo.componentObject == null) {
					component.setStatus(ScaPackage.Literals.CORBA_OBJ_WRAPPER__CORBA_OBJ,
						new Status(IStatus.ERROR, ScaModelPlugin.ID, "No CORBA object was provided by the waveform for this component."));
				}
				component.setProfileURI(spdUri);
				provider.getComponents().add(component);
				String ciId = component.getInstantiationIdentifier();
				if (ciId != null) {
					for (TreeIterator<EObject> iterator = EcoreUtil.getAllContents(provider.getProfileObj(), false); iterator.hasNext();) {
						EObject obj = iterator.next();
						if (obj instanceof SoftwareAssembly || obj instanceof SadPartitioning || obj instanceof SadComponentPlacement
							|| obj instanceof HostCollocation) {
							continue;
						} else if (obj instanceof SadComponentInstantiation) {
							SadComponentInstantiation ci = (SadComponentInstantiation) obj;
							String sadCiId = ci.getId();
							if (ciId.equals(sadCiId)) {
								component.setComponentInstantiation(ci);
								break;
							}
							iterator.prune();
						} else {
							iterator.prune();
						}
					}
				}
			}

			if (!provider.isSetComponents()) {
				provider.getComponents().clear();
			}
		} else {
			provider.unsetComponents();
			provider.unsetAssemblyController();
		}
		super.execute();
	}

	/**
	 * @deprecated Use {@link #createComponent(String, String, org.omg.CORBA.Object)}
	 */
	@Deprecated
	protected ScaComponent createComponent() {
		return ScaFactory.eINSTANCE.createScaComponent();
	}

	/**
	 * Create the appropriate SCA model object for the component, and update it based on the identifier, profile and
	 * CORBA object provided.
	 *
	 * @param identifier The component's identifier
	 * @param softwareProfile The component's software profile (path to SPD in the domain manager's file manager)
	 * @param componentObject The {@link Resource} object for the component
	 * @return The newly created model object
	 * @since 20.3
	 */
	protected ScaComponent createComponent(String identifier, String softwareProfile, org.omg.CORBA.Object componentObject) {
		ScaComponent component = ScaFactory.eINSTANCE.createScaComponent();
		setAttributes(component, identifier, softwareProfile, componentObject);
		return component;
	}

	/**
	 * Helper method to apply attributes to a {@link ScaComponent}.
	 *
	 * @param identifier The component's identifier
	 * @param softwareProfile The component's software profile (path to SPD in the domain manager's file manager)
	 * @param componentObject The {@link Resource} object for the component
	 * @since 20.3
	 */
	protected void setAttributes(ScaComponent component, String identifier, String softwareProfile, org.omg.CORBA.Object componentObject) {
		component.setIdentifier(identifier);
		component.setProfile(softwareProfile);
		if (componentObject != null) {
			component.setCorbaObj(componentObject);
			component.setObj((Resource) componentObject);
		}
	}
}