io.relayr.java.model.models.DeviceModel Maven / Gradle / Ivy

Go to download
package io.relayr.java.model.models;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import io.relayr.java.model.models.error.DeviceModelsException;
import io.relayr.java.model.models.error.DeviceModelsFirmwareException;

/** Main object that defines every device supported on Relayr platrofm. */
public class DeviceModel implements Serializable {

    private String id;
    private String owner;
    private String name;
    private String productNumber;
    private String description;
    private String website;
    private DeviceManufacturer manufacturer;
    private List resources;
    private Map firmware;

    public String getId() {
        return id;
    }

    /** If device io.relayr.java.model is not defined by Relayr this field represent model owner. */
    public String getOwner() {
        return owner;
    }

    /** @return io.relayr.java.model name */
    public String getName() {
        return name;
    }

    /** @return product number (product version) */
    public String getProductNumber() {
        return productNumber;
    }

    public String getDescription() {
        return description;
    }

    public String getWebsite() {
        return website;
    }

    /** @return details about device manufacturer */
    public DeviceManufacturer getManufacturer() {
        return manufacturer;
    }

    /**
     * Return device resources.
     * @return list of {@link DeviceResource}
     */
    public List getResources() {
        return resources;
    }

    /**
     * Returns a map with all available firmwares. Map key is Version number.
     * Check available firmwares using {@link #getFirmwareVersions()}
     * @return {@link Map} where key is version number
     */
    public Map getFirmware() {
        return firmware;
    }

    /**
     * Returns all available firmware versions
     * @return {@link List} of firmware versions
     */
    public List getFirmwareVersions() {
        if (firmware == null || firmware.keySet() == null || firmware.keySet().isEmpty())
            return new ArrayList<>();
        return new ArrayList<>(firmware.keySet());
    }

    /**
     * @param version of firmware
     * @return {@link DeviceFirmware} for specified version
     * @throws DeviceModelsFirmwareException if firmware is not found
     */
    public DeviceFirmware getFirmwareByVersion(String version) throws DeviceModelsFirmwareException {
        final DeviceFirmware deviceFirmware = firmware.get(version);
        if (deviceFirmware == null) throw DeviceModelsException.firmwareNotFound();
        return deviceFirmware;
    }

    /**
     * @return latest version of firmware. Use only if firmware for the device can not be matched.
     * @throws DeviceModelsFirmwareException
     */
    public DeviceFirmware getLatestFirmware() throws DeviceModelsFirmwareException {
        if (firmware == null || firmware.isEmpty()) throw DeviceModelsException.firmwareNotFound();
        String version = null;
        for (String firmwareVersion : firmware.keySet())
            if (version == null) version = firmwareVersion;
            else if ((version.replace(".", "")).compareTo(firmwareVersion.replace(".", "")) < 0)
                version = firmwareVersion;

        return getFirmwareByVersion(version);
    }

    @Override public String toString() {
        return "DeviceModel{" +
                "id='" + id + '\'' +
                ", owner='" + owner + '\'' +
                ", name='" + name + '\'' +
                ", productNumber='" + productNumber + '\'' +
                ", description='" + description + '\'' +
                ", website='" + website + '\'' +
                ", manufacturer=" + manufacturer.toString() +
                ", resources=" + resources.toString() +
                ", firmware=" + firmware.toString() +
                '}';
    }

    @Override public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        DeviceModel that = (DeviceModel) o;

        return !(id != null ? !id.equals(that.id) : that.id != null);
    }

    @Override public int hashCode() {
        return id != null ? id.hashCode() : 0;
    }
}