org.eclipse.mdm.api.base/src/main/java/org/eclipse/mdm/api/base/model/ContextRoot.java

/********************************************************************************
 * Copyright (c) 2015-2018 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 ********************************************************************************/

package org.eclipse.mdm.api.base.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Optional;
import java.util.stream.Collectors;

import org.eclipse.mdm.api.base.adapter.Core;

/**
 * Implementation of the context root entity types. This is the root node of the
 * descriptive component structure for a {@link ContextType}. This element is
 * used for both, order and measured result description data. If it belongs to
 * an order description, then a relation to a {@link TestStep} exists. Otherwise
 * it represents the description of a measurement and therefore has one ore more
 * relations to {@link Measurement}s. In the base application model the
 * component structure is provided as is. An extension of the base application
 * model may define a template, the structure of contained
 * {@link ContextComponent}s and {@link ContextSensor}s will be restricted to.
 * Additionally the <b>names</b> of all related {@code ContextComponent}s have
 * to be unique.
 *
 * @since 1.0.0
 * @author Viktor Stoehr, Gigatronik Ingolstadt GmbH
 * @author Sebastian Dirsch, Gigatronik Ingolstadt GmbH
 */
public class ContextRoot extends BaseEntity implements Deletable {

	// ======================================================================
	// Class variables
	// ======================================================================

	/**
	 * The 'Version' attribute name.
	 */
	public static final String ATTR_VERSION = "Version";

	// ======================================================================
	// Instance variables
	// ======================================================================

	private final ContextType contextType;

	// ======================================================================
	// Constructors
	// ======================================================================

	/**
	 * Constructor.
	 *
	 * @param core The {@link Core}.
	 */
	ContextRoot(Core core) {
		super(core);
		contextType = ContextType.valueOf(core.getTypeName().toUpperCase(Locale.ROOT));
	}

	// ======================================================================
	// Public methods
	// ======================================================================

	/**
	 * Returns the {@link ContextType} of this context root.
	 *
	 * @return The {@code ContextType} is returned.
	 */
	public ContextType getContextType() {
		return contextType;
	}

	/**
	 * Returns the {@link ContextComponent} identified by given name.
	 *
	 * @param name The name of the {@code ContextComponent}.
	 * @return The {@code Optional} is empty if a {@code ContextComponent} with
	 *         given name does not exist.
	 */
	public Optional<ContextComponent> getContextComponent(String name) {
		return getContextComponents().stream().filter(cc -> cc.nameEquals(name)).findAny();
	}

	/**
	 * Returns all available {@link ContextComponent}s related to this context root.
	 *
	 * @return The returned {@code List} is unmodifiable.
	 */
	public List<ContextComponent> getContextComponents() {
		return getCore().getChildrenStore().get(ContextComponent.class);
	}

	/**
	 * Removes the {@link ContextComponent} identified by given name.
	 *
	 * @param name Name of the {@code ContextComponent} that have to be removed.
	 * @return Returns {@code true} if the {@code ContextComponent} with given name
	 *         has been removed.
	 */
	public boolean removeContextComponent(String name) {
		Optional<ContextComponent> contextComponent = getContextComponent(name);
		if (contextComponent.isPresent()) {
			getCore().getChildrenStore().remove(contextComponent.get());
			return true;
		}

		return false;
	}

	/**
	 * Returns all available {@link ContextSensor}s related to the
	 * {@link ContextComponent}s, which are held by this context root.
	 *
	 * @return The returned {@code List} will always be empty if this context root
	 *         is of type {@link ContextType#UNITUNDERTEST} or
	 *         {@link ContextType#TESTSEQUENCE}.
	 */
	public List<ContextSensor> getContextSensors() {
		if (!getContextType().isTestEquipment()) {
			return Collections.emptyList();
		}

		return getContextComponents().stream().map(ContextComponent::getContextSensors).collect(ArrayList::new,
				List::addAll, List::addAll);
	}

	/**
	 * Returns the version of this context root.
	 *
	 * @return The version is returned.
	 */
	public String getVersion() {
		return getValue(ATTR_VERSION).extract();
	}

	/**
	 * Sets new version for this context root.
	 *
	 * @param version The new version.
	 */
	public void setVersion(String version) {
		getValue(ATTR_VERSION).set(version);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder(getClass().getSimpleName()).append('(');
		sb.append("ContextType = ").append(getContextType()).append(", ");
		sb.append(getValues().values().stream().map(Value::toString).collect(Collectors.joining(", ")));

		List<ContextComponent> contextComponents = getContextComponents();
		if (!contextComponents.isEmpty()) {
			sb.append(", ContextComponents = ").append(contextComponents);
		}

		return sb.append(')').toString();
	}

	/**
	 * Convenience method to access the {@link ContextRoot}s of newly created
	 * {@link ContextDescribable}.
	 *
	 * @param contextDescribable Either a {@link TestStep} or a {@link Measurement}.
	 * @return The {@code ContextRoot}s are returned.
	 */
	public static List<ContextRoot> of(ContextDescribable contextDescribable) {
		List<ContextRoot> contextRoots = new ArrayList<>();
		of(contextDescribable, ContextType.UNITUNDERTEST).ifPresent(contextRoots::add);
		of(contextDescribable, ContextType.TESTSEQUENCE).ifPresent(contextRoots::add);
		of(contextDescribable, ContextType.TESTEQUIPMENT).ifPresent(contextRoots::add);
		return contextRoots;
	}

	// ======================================================================
	// Private methods
	// ======================================================================

	/**
	 * Returns the {@link ContextRoot} with given {@link ContextType} from given
	 * {@link ContextDescribable}.
	 *
	 * @param contextDescribable Either a {@link TestStep} or a {@link Measurement}.
	 * @param contextType        The requested {@code ContextType}.
	 * @return {@code Optional} is empty if a {@code ContextRoot} with given
	 *         {@code ContextType} does not exist.
	 */
	private static Optional<ContextRoot> of(ContextDescribable contextDescribable, ContextType contextType) {
		return Optional.ofNullable(getCore(contextDescribable).getMutableStore().get(ContextRoot.class, contextType));
	}

}