plugins/org.eclipse.app4mc.amalthea.validations.standard/src/org/eclipse/app4mc/amalthea/validations/standard/hardware/AmHwModuleDefinition.java

/**
 ********************************************************************************
 * Copyright (c) 2019-2020 Robert Bosch GmbH and others.
 *
 * 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
 *
 * Contributors:
 *     Robert Bosch GmbH - initial API and implementation
 ********************************************************************************
 */

package org.eclipse.app4mc.amalthea.validations.standard.hardware;

import java.util.List;

import org.eclipse.app4mc.amalthea.model.Cache;
import org.eclipse.app4mc.amalthea.model.ConnectionHandler;
import org.eclipse.app4mc.amalthea.model.HwModule;
import org.eclipse.app4mc.amalthea.model.Memory;
import org.eclipse.app4mc.amalthea.model.ProcessingUnit;
import org.eclipse.app4mc.amalthea.validation.core.AmaltheaValidation;
import org.eclipse.app4mc.validation.annotation.Validation;
import org.eclipse.app4mc.validation.core.ValidationDiagnostic;
import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.EObject;

/**
 * Checks the correctness of HwModule definitions
 *
 * <ul>
 * <li>Memory definition must be set</li>
 * <li>ProcessingUnit definition must be set</li>
 * <li>ConnectionHandler definition must be set</li>
 * <li>Cache definition must be set</li>
 * </ul>
 */

@Validation(
		id = "AM-HW-Module-Definition",
		checks = {	"Memory definition must be set",
					"ProcessingUnit definition must be set",
					"ConnectionHandler definition must be set",
					"Cache definition must be set" })

public class AmHwModuleDefinition extends AmaltheaValidation {

	private static final String MISSING_DEFINITION = ": missing definition";

	@Override
	public EClassifier getEClassifier() {
		return ePackage.getHwModule();
	}

	@Override
	public void validate(final EObject object, final List<ValidationDiagnostic> results) {
		if (object instanceof HwModule) {
			HwModule module = (HwModule) object;

			// ***** Memory definition must be set

			if (module instanceof Memory) {
				Memory memory = (Memory) module;
				if (memory.getDefinition() == null) {
					addIssue(results, memory, ePackage.getMemory_Definition(),
							"HW Module (Memory) " + name(module) + MISSING_DEFINITION);
				}
			}

			// ***** ProcessingUnit definition must be set

			if (module instanceof ProcessingUnit) {
				ProcessingUnit pu = (ProcessingUnit) module;
				if (pu.getDefinition() == null) {
					addIssue(results, pu, ePackage.getProcessingUnit_Definition(),
							"HW Module (ProcessingUnit) " + name(module) + MISSING_DEFINITION);
				}
			}

			// ***** ConnectionHandler definition must be set

			if (module instanceof ConnectionHandler) {
				ConnectionHandler handler = (ConnectionHandler) module;
				if (handler.getDefinition() == null) {
					addIssue(results, handler, ePackage.getConnectionHandler_Definition(),
							"HW Module (ConnectionHandler) " + name(module) + MISSING_DEFINITION);
				}
			}

			// ***** Cache definition must be set

			if (module instanceof Cache) {
				Cache cache = (Cache) module;
				if (cache.getDefinition() == null) {
					addIssue(results, cache, ePackage.getCache_Definition(),
							"HW Module (Cache) " + name(module) + MISSING_DEFINITION);
				}
			}

		}
	}

}