net.sf.opendse.model.parameter.ParameterReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendse-model Show documentation
The algorithms module of OpenDSE
There is a newer version: 1.8
/**
 * OpenDSE is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 * 
 * OpenDSE is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with OpenDSE. If not, see http://www.gnu.org/licenses/.
 */
package net.sf.opendse.model.parameter;

import net.sf.opendse.model.Element;

/**
 * The {@code ParameterReference} is a reference to a {@link Parameter} of an
 * {@link Element}. This reference is defined by the element {@code id} and the
 * name of the {@code Attribute}.
 * 
 * @author Martin Lukasiewycz
 * 
 */
public class ParameterReference implements Comparable {

	protected final String id;
	protected final String attribute;
	protected final Parameter parameter;

	/**
	 * Constructs a {@code ParameterReference}.
	 * 
	 * @param element
	 *            the element
	 * @param attribute
	 *            the attribute name
	 */
	public ParameterReference(Element element, String attribute) {
		this(element.getId(), attribute, element.getAttributeParameter(attribute));
	}

	/**
	 * Constructs a {@code ParameterReference}.
	 * 
	 * @param id
	 *            the element id
	 * @param attribute
	 *            the attribute name
	 * @param parameter
	 *            the parameter
	 */
	public ParameterReference(String id, String attribute, Parameter parameter) {
		super();
		this.id = id;
		this.attribute = attribute;
		this.parameter = parameter;
	}

	/**
	 * Returns the {@code id} of the referenced {@code Element}.
	 * 
	 * @return the id of the element
	 */
	public String getId() {
		return id;
	}

	/**
	 * Returns the name of the {@code Attribute}.
	 * 
	 * @return the name of the attribute
	 */
	public String getAttribute() {
		return attribute;
	}

	/**
	 * Returns the {@code Parameter}.
	 * 
	 * @return the parameter
	 */
	public Parameter getParameter() {
		return parameter;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((attribute == null) ? 0 : attribute.hashCode());
		result = prime * result + ((id == null) ? 0 : id.hashCode());
		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		ParameterReference other = (ParameterReference) obj;
		if (attribute == null) {
			if (other.attribute != null)
				return false;
		} else if (!attribute.equals(other.attribute))
			return false;
		if (id == null) {
			if (other.id != null)
				return false;
		} else if (!id.equals(other.id))
			return false;
		return true;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Comparable#compareTo(java.lang.Object)
	 */
	@Override
	public int compareTo(ParameterReference o) {
		int v = id.compareTo(o.id);
		if (v != 0)
			return v;
		v = attribute.compareTo(o.attribute);
		return v;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return "[id=" + id + ", attribute=" + attribute + "]";
	}

}