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

/********************************************************************************
 * Copyright (c) 2015-2019 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.List;
import java.util.Optional;
import java.util.stream.Collectors;

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

/**
 * Implementation of the parameter set entity type. Instances of this class
 * group a set of further describing data stored in {@link Parameter}s.
 * Parameter sets are attached either to a {@link Measurement} or
 * {@link Channel}.
 *
 * @since 1.0.0
 * @author Viktor Stoehr, Gigatronik Ingolstadt GmbH
 * @author Sebastian Dirsch, Gigatronik Ingolstadt GmbH
 */
public class ParameterSet extends BaseEntity implements Deletable {

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

	/**
	 * The {@link Measurement} parent type.
	 */
	public static final Class<Measurement> PARENT_TYPE_MEASUREMENT = Measurement.class;

	/**
	 * The {@link ChannelGroup} parent type.
	 */
	public static final Class<Channel> PARENT_TYPE_CHANNEL = Channel.class;

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

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

	/**
	 * Constructor.
	 *
	 * @param core The {@link Core}.
	 */
	ParameterSet(Core core) {
		super(core);
	}

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

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

	/**
	 * Returns all available {@link Parameter}s related to this parameter set.
	 *
	 * @return The returned {@code List} is unmodifiable.
	 */
	public List<Parameter> getParameters() {
		return getCore().getChildrenStore().get(Parameter.class);
	}

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

		return false;
	}

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

	/**
	 * Sets new version for this parameter set.
	 *
	 * @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(getValues().values().stream().map(Value::toString).collect(Collectors.joining(", ")));
		return sb.append(", Parameters = ").append(getParameters()).append(')').toString();
	}

}