ItemMap.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.fritzboxtr064.internal;

/***
 * Represents a item mapping. An item mapping is a collection of all parameters
 * based on the config string of the item. config string is like the key of an item mapping
 * Item Mappings must be created manually to support desired fbox tr064 functions.
 *
 * @author gitbock
 *
 */
public class ItemMap {
    // common parameters
    private String _itemCommand; // matches itemconfig
    private String _serviceId; // SOAP service ID

    // read specific
    private String _readServiceCommand; // command to execute on fbox if value should be read
    private String _readDataInName; // name of parameter to put in soap request to read value
    private String _readDataOutName; // name of parameter to extract from fbox soap response when reading value (is
                                     // parsed as value)
    private SoapValueParser _soapValueParser; // handler to use for parsing soapresponse

    // write specific
    private String _writeServiceCommand; // command to execute on fbox if value should be set
    private String _writeDataInName; // name of parameter which is put in soap request when setting an option on fbox
    private String _writeDataInNameAdditional; // additional Parameter to add to write request. e.g. id of TAM to set

    public String getWriteDataInNameAdditional() {
        return _writeDataInNameAdditional;
    }

    public void setWriteDataInNameAdditional(String _writeDataInNameAdditional) {
        this._writeDataInNameAdditional = _writeDataInNameAdditional;
    }

    public String getWriteServiceCommand() {
        return _writeServiceCommand;
    }

    public void setWriteServiceCommand(String _writeServiceCommand) {
        this._writeServiceCommand = _writeServiceCommand;
    }

    public String getWriteDataInName() {
        return _writeDataInName;
    }

    public void setWriteDataInName(String _setDataInName) {
        this._writeDataInName = _setDataInName;
    }

    public SoapValueParser getSoapValueParser() {
        return _soapValueParser;
    }

    public void setSoapValueParser(SoapValueParser _svp) {
        this._soapValueParser = _svp;
    }

    public ItemMap(String _itemCommand, String _getServiceCommand, String _serviceId, String _getDataInName1,
            String _getDataOutName1) {
        this._itemCommand = _itemCommand;
        this._readServiceCommand = _getServiceCommand;
        this._serviceId = _serviceId;
        this._readDataInName = _getDataInName1;
        this._readDataOutName = _getDataOutName1;
    }

    public String getItemCommand() {
        return _itemCommand;
    }

    public void setItemCommand(String _itemCommand) {
        this._itemCommand = _itemCommand;
    }

    public String getReadServiceCommand() {
        return _readServiceCommand;
    }

    public void setReadServiceCommand(String _serviceCommand) {
        this._readServiceCommand = _serviceCommand;
    }

    public String getServiceId() {
        return _serviceId;
    }

    public void setServiceId(String _serviceId) {
        this._serviceId = _serviceId;
    }

    public String getReadDataInName() {
        return _readDataInName;
    }

    public void setReadDataInName1(String _dataInName1) {
        this._readDataInName = _dataInName1;
    }

    public String getReadDataOutName() {
        return _readDataOutName;
    }

    public void setReadDataOutName(String _dataOutName1) {
        this._readDataOutName = _dataOutName1;
    }

    @Override
    public String toString() {
        return "ItemMap [_itemCommand=" + _itemCommand + ", _serviceId=" + _serviceId + ", _readServiceCommand="
                + _readServiceCommand + ", _readDataInName=" + _readDataInName + ", _readDataOutName="
                + _readDataOutName + ", _svp=" + _soapValueParser + ", _writeDataInName=" + _writeDataInName + "]";
    }

}