PifaceGenericBindingProvider.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.piface.internal;

import java.util.ArrayList;
import java.util.List;

import org.openhab.binding.piface.PifaceBindingProvider;
import org.openhab.core.items.Item;
import org.openhab.core.library.items.ContactItem;
import org.openhab.core.library.items.SwitchItem;
import org.openhab.model.item.binding.AbstractGenericBindingProvider;
import org.openhab.model.item.binding.BindingConfigParseException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * <p>
 * This class can parse information from the generic binding format and
 * provides Piface binding information from it. It registers as a
 * {@link PifaceBindingProvider} service as well.
 * </p>
 *
 * <p>
 * Here are some examples for valid binding configuration strings:
 * <ul>
 * <li><code>{ piface="piface-id:OUT:1" }</code></li>
 * <li><code>{ piface="piface-id:IN:6" }</code></li>
 * </ul>
 *
 * @author Ben Jones
 *
 * @since 1.3.0
 */
public class PifaceGenericBindingProvider extends AbstractGenericBindingProvider implements PifaceBindingProvider {

    static final Logger logger = LoggerFactory.getLogger(PifaceGenericBindingProvider.class);

    /**
     * {@inheritDoc}
     */
    @Override
    public String getBindingType() {
        return "piface";
    }

    /**
     * @{inheritDoc}
     */
    @Override
    public void validateItemType(Item item, String bindingConfig) throws BindingConfigParseException {
        if (!(item instanceof SwitchItem) && !(item instanceof ContactItem)) {
            throw new BindingConfigParseException(
                    "Item '" + item.getName() + "' is of type '" + item.getClass().getSimpleName()
                            + "', only Switch and Contact items are allowed - please check your *.items configuration");
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void processBindingConfiguration(String context, Item item, String bindingConfig)
            throws BindingConfigParseException {
        super.processBindingConfiguration(context, item, bindingConfig);

        if (bindingConfig != null) {
            PifaceBindingConfig pin = parseBindingConfig(item, bindingConfig);
            addBindingConfig(item, pin);
        } else {
            logger.warn("bindingConfig is NULL (item=" + item + ") -> process bindingConfig aborted!");
        }
    }

    protected PifaceBindingConfig parseBindingConfig(Item item, String bindingConfig)
            throws BindingConfigParseException {
        String[] parts = bindingConfig.split(":");
        if (parts.length < 2) {
            throw new BindingConfigParseException("Item '" + item.getName()
                    + "' has an invalid binding config - expecting at least 2 tokens (<id>:<type>[:<pin>]) but found "
                    + bindingConfig);
        }

        String pifaceId = parts[0];
        PifaceBindingConfig.BindingType bindingType = PifaceBindingConfig.BindingType.parse(parts[1]);

        Integer pinNumber = 0;
        if (!bindingType.equals(PifaceBindingConfig.BindingType.WATCHDOG)) {
            if (parts.length != 3) {
                throw new BindingConfigParseException("Item '" + item.getName()
                        + "' has an invalid binding config - expecting at 3 tokens (<id>:IN|OUT:<pin>) but found "
                        + bindingConfig);
            }

            pinNumber = Integer.parseInt(parts[2]);
        }

        return new PifaceBindingConfig(pifaceId, bindingType, pinNumber, item.getClass());
    }

    /**
     * @{inheritDoc}
     */
    @Override
    public Class<? extends Item> getItemType(String itemName) {
        PifaceBindingConfig pin = (PifaceBindingConfig) bindingConfigs.get(itemName);
        return pin != null ? pin.getItemType() : null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public PifaceBindingConfig getPifaceBindingConfig(String itemName) {
        return (PifaceBindingConfig) bindingConfigs.get(itemName);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<String> getItemNames(String pifaceId, PifaceBindingConfig.BindingType bindingType, int pinNumber) {
        List<String> itemNames = new ArrayList<String>();
        for (String itemName : getItemNames()) {
            PifaceBindingConfig bindingConfig = (PifaceBindingConfig) bindingConfigs.get(itemName);
            if (bindingConfig.getPifaceId().equals(pifaceId) && bindingConfig.getBindingType() == bindingType
                    && bindingConfig.getPinNumber() == pinNumber) {
                itemNames.add(itemName);
            }
        }
        return itemNames;
    }
}