HMSGenericBindingProvider.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.hms.internal;

import org.openhab.binding.hms.HMSBindingProvider;
import org.openhab.core.binding.BindingConfig;
import org.openhab.core.items.Item;
import org.openhab.core.library.items.NumberItem;
import org.openhab.model.item.binding.AbstractGenericBindingProvider;
import org.openhab.model.item.binding.BindingConfigParseException;

/**
 * This class is responsible for parsing the HMS binding configuration.<br>
 * e.g.<br>
 * <code>Number HumidityItem "Humidity [%.1f %%]"	<humidity> (Weather) {hms="address=A1DB;datapoint=HUMIDITY"}</code>
 *
 * @author Thomas Urmann
 * @since 1.7.0
 */
public class HMSGenericBindingProvider extends AbstractGenericBindingProvider implements HMSBindingProvider {

    /**
     * Returns the binding type 'hms' that must be used in items configuration
     * file.
     * 
     * @return "hms" as binding type
     */
    @Override
    public String getBindingType() {
        return "hms";
    }

    /**
     * Only items of type {@link NumberItem} are valid for this binding.
     * 
     * @throws BindingConfigParseException
     *             when item type is not NumberItem
     */
    @Override
    public void validateItemType(Item item, String bindingConfig) throws BindingConfigParseException {
        if (!(item instanceof NumberItem)) {
            throw new BindingConfigParseException(
                    "item '" + item.getName() + "' is of type '" + item.getClass().getSimpleName()
                            + "', only NumberItems are allowed - please check your *.items configuration");
        }
    }

    /**
     * Process a given binding configuration. Valid configurations can look
     * like: <br>
     * <code>address=A2DC;datapoint=HUMIDITY</code>
     */
    @Override
    public void processBindingConfiguration(String context, Item item, String bindingConfig)
            throws BindingConfigParseException {
        super.processBindingConfiguration(context, item, bindingConfig);
        HMSBindingConfig config = new HMSBindingConfig();

        String[] parts = bindingConfig.split(";");
        for (String part : parts) {
            String[] keyValue = part.split("=");
            // to avoid beginner error
            keyValue[0] = keyValue[0].trim();
            keyValue[1] = keyValue[1].trim();
            if (keyValue[0].equals("address")) {
                config.address = keyValue[1];
            }
            if (keyValue[0].equals("datapoint")) {
                config.datapoint = HMSBindingConfig.Datapoint.valueOf(keyValue[1]);
            }
        }
        config.item = item;

        addBindingConfig(item, config);
    }

    @Override
    public HMSBindingConfig getBindingConfigForAddressAndDatapoint(String device,
            HMSBindingConfig.Datapoint datapoint) {
        for (BindingConfig config : this.bindingConfigs.values()) {
            HMSBindingConfig hmsConfig = (HMSBindingConfig) config;
            if (hmsConfig.address.equals(device) && hmsConfig.datapoint == datapoint) {
                return (HMSBindingConfig) config;
            }
        }
        return null;
    }

    /**
     * This class hold the configuration parameters of an HMS item.
     * 
     * @author Thomas Urmann
     * @since 1.7.0
     */
    public static class HMSBindingConfig implements BindingConfig {
        public enum Datapoint {
            TEMPERATURE,
            HUMIDITY;
        }

        public String address;
        public Item item;
        public Datapoint datapoint;
    }
}