DeviceSpecificationImpl

package org.minetti.astrodevice.server.hibernate.object;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Transient;
import org.hibernate.annotations.Index;
import org.minetti.astrodevice.common.device.DeviceSignature;
import org.minetti.astrodevice.server.core.object.DeviceSpecification;
import org.minetti.astrodevice.server.plugin.device.BaseDeviceSignature;

/**
 * Object representing the specifications on a device.
 * @author Jean-Philippe MINETTI
 */
@Table(name = "DEVICE")
@org.hibernate.annotations.Table(appliesTo = "DEVICE", indexes = { @Index(name = "K_DEVICE_SIGNATURE", columnNames = { "BUS", "PRODUCT_ID", "PRODUCT_DESCRIPTION",
		"PRODUCT_VERSION", "SERIAL_NUMBER" }) })
@NamedQueries({
		@NamedQuery(name = "allDeviceSpecificationQuery", query = "FROM DeviceSpecificationImpl t ORDER BY t.name"),
		@NamedQuery(name = "pluginDeviceSpecificationQuery", query = "FROM DeviceSpecificationImpl t WHERE (t.pluginClassName=:pluginClassName) ORDER BY t.name"),
		@NamedQuery(name = "sameProductDeviceSpecificationQuery", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion=:productVersion) ORDER BY t.name"),
		@NamedQuery(name = "sameProductDeviceSpecificationQueryWithNullVersion", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion is null) ORDER BY t.name"),
		@NamedQuery(name = "signatureDeviceSpecificationQuery", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion=:productVersion) and (t.serialNumber=:serialNumber) ORDER BY t.name"),
		@NamedQuery(name = "signatureDeviceSpecificationQueryWithNullVersion", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion is null) and (t.serialNumber=:serialNumber) ORDER BY t.name"),
		@NamedQuery(name = "signatureDeviceSpecificationQueryWithNullSerialNumber", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion=:productVersion) and (t.serialNumber is null) ORDER BY t.name"),
		@NamedQuery(name = "signatureDeviceSpecificationQueryWithNullVersionAndSerialNumber", query = "FROM DeviceSpecificationImpl t WHERE (t.bus=:bus) and (t.productId=:productId) and (t.productDescription=:productDescription) and (t.productVersion is null) and (t.serialNumber is null) ORDER BY t.name") })
@Entity
public final class DeviceSpecificationImpl
		implements DeviceSpecification, Serializable {

	/**
	 * Serial number.
	 */
	private static final long serialVersionUID = -7709095111542974139L;

	/**
	 * Signature used for recognize the device.
	 */
	protected final class DeviceSignatureImpl
			extends BaseDeviceSignature {

		/**
		 * Constructor.
		 */
		protected DeviceSignatureImpl () {
			super();
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getBus()
		 */
		public String getBus () {
			return DeviceSpecificationImpl.this.bus;
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getProductId()
		 */
		public String getProductId () {
			return DeviceSpecificationImpl.this.productId;
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getProductDescription()
		 */
		public String getProductDescription () {
			return DeviceSpecificationImpl.this.productDescription;
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getProductVersion()
		 */
		public String getProductVersion () {
			return DeviceSpecificationImpl.this.productVersion;
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getSerialNumber()
		 */
		public String getSerialNumber () {
			return DeviceSpecificationImpl.this.serialNumber;
		}

		/*
		 * (non-Javadoc)
		 * @see org.minetti.astrodevice.common.device.DeviceSignature#getProperties()
		 */
		public Map<String, Object> getProperties () {
			return DeviceSpecificationImpl.this.properties;
		}

	}

	/**
	 * Identifier given to device.
	 */
	@Id
	@GeneratedValue
	@Column(name = "ID", nullable = false)
	private Long id = null;

	/**
	 * Name given to device.
	 */
	@Column(name = "NAME", length = 40, nullable = false, unique = true)
	private String name = null;

	/**
	 * Class name of plug-in related to device.
	 */
	@Column(name = "PLUGIN", nullable = false)
	@Index(name = "K_DEVICE_PLUGIN")
	private String pluginClassName = null;

	/**
	 * Bus name where the device is connected (never NULL).
	 */
	@Column(name = "BUS", length = 15, nullable = false)
	protected String bus = null;

	/**
	 * Unique identifier identifying the device product (never NULL).
	 */
	@Column(name = "PRODUCT_ID", length = 15, nullable = false)
	protected String productId = null;

	/**
	 * Product description of device (never NULL).
	 */
	@Column(name = "PRODUCT_DESCRIPTION", length = 255, nullable = false)
	protected String productDescription = null;

	/**
	 * Product version of device (can be NULL).
	 */
	@Column(name = "PRODUCT_VERSION", length = 8)
	protected String productVersion = null;

	/**
	 * Serial number of device or other data identifying the devices of the same product (can be
	 * NULL).
	 */
	@Column(name = "SERIAL_NUMBER", length = 255)
	protected String serialNumber = null;

	/**
	 * Map containing all properties of the device (never NULL).
	 */
	@Column(name = "PROPERTIES", nullable = false)
	@Lob
	protected HashMap<String, Object> properties = null;

	/**
	 * Signature used for recognize the device.
	 */
	@Transient
	private final DeviceSignature signature = new DeviceSignatureImpl();

	/**
	 * Constructor.
	 */
	public DeviceSpecificationImpl () {
		super();
	}

	/**
	 * Constructor.
	 * @param deviceSpecification Object representing the specifications on a device.
	 */
	public DeviceSpecificationImpl (final DeviceSpecification deviceSpecification) {
		super();
		this.name = deviceSpecification.getName();
		this.pluginClassName = deviceSpecification.getPluginClassName();
		this.bus = deviceSpecification.getSignature().getBus();
		this.productId = deviceSpecification.getSignature().getProductId();
		this.productDescription = deviceSpecification.getSignature().getProductDescription();
		this.productVersion = deviceSpecification.getSignature().getProductVersion();
		this.serialNumber = deviceSpecification.getSignature().getSerialNumber();
		this.properties = new HashMap<String, Object>(deviceSpecification.getSignature().getProperties());
	}

	/*
	 * (non-Javadoc)
	 * @see org.minetti.astrodevice.server.core.object.DeviceSpecification#getId()
	 */
	public final Long getId () {
		return this.id;
	}

	/*
	 * (non-Javadoc)
	 * @see org.minetti.astrodevice.server.core.object.DeviceSpecification#getName()
	 */
	public final String getName () {
		return this.name;
	}

	/*
	 * (non-Javadoc)
	 * @see org.minetti.astrodevice.server.core.object.DeviceSpecification#setName(java.lang.String)
	 */
	public final void setName (final String name) {
		this.name = name;
	}

	/*
	 * (non-Javadoc)
	 * @see org.minetti.astrodevice.server.core.object.DeviceSpecification#getPluginClassName()
	 */
	public final String getPluginClassName () {
		return this.pluginClassName;
	}

	/*
	 * (non-Javadoc)
	 * @see
	 * org.minetti.astrodevice.server.core.object.DeviceSpecification#setPluginClassName(java.lang
	 * .String)
	 */
	public final void setPluginClassName (final String pluginClassName) {
		this.pluginClassName = pluginClassName;
	}

	/*
	 * (non-Javadoc)
	 * @see org.minetti.astrodevice.server.core.object.DeviceSpecification#getSignature()
	 */
	public final DeviceSignature getSignature () {
		return this.signature;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public final int hashCode () {
		return (this.name != null ? this.name.hashCode() : 0);
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public final boolean equals (final Object obj) {
		boolean result = false;
		if (obj == this) {
			result = true;
		}
		else if ((obj instanceof DeviceSpecification) && (this.name != null)) {
			result = this.name.equals(((DeviceSpecification) obj).getName());
		}
		return result;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public final String toString () {
		return this.name + " - " + this.signature;
	}

}