SiLeBAT/FSK-Lab

View on GitHub
de.bund.bfr.knime.pmm.common/src/de/bund/bfr/knime/pmm/common/DepXml.java

Summary

Maintainability
A
3 hrs
Test Coverage
/*******************************************************************************
 * Copyright (c) 2015 Federal Institute for Risk Assessment (BfR), Germany
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contributors:
 *     Department Biological Safety - BfR
 *******************************************************************************/
package de.bund.bfr.knime.pmm.common;

import org.jdom2.Element;

public class DepXml implements PmmXmlElementConvertable {

    public static final String ELEMENT_DEPENDENT = "dependent";

    public String name;
    public String origName;
    public Double min;
    public Double max;
    public String category;
    public String unit;
    public String description;

    /**
     * Constructor with name.
     * <ul>
     * <li>origName is assigned name.
     * <li>min, max, category, unit and description are null.
     * </ul>
     */
    public DepXml(String name) {
        this(name, null, null);
    }

    /**
     * Constructor with name, category and unit.
     * <ul>
     * <li>origName is assigned name.
     * <li>min, max and description are null.
     * </ul>
     */
    public DepXml(String name, String category, String unit) {
        this(name, name, category, unit, null);
    }

    /**
     * Constructor with name, origName, category, unit and description. min and max
     * are null.
     */
    public DepXml(String name, String origName, String category, String unit, String description) {
        this.name = name;
        this.origName = origName;
        this.category = category;
        this.unit = unit;
        this.description = description;
    }

    /**
     * Copy constructor. Take every property from a {@link org.jdom2.Element} with
     * properties:
     * <ul>
     * <li>String "name"
     * <li>String "origname" *
     * <li>Double "min"
     * <li>Double "max"
     * <li>String "category"
     * <li>String "unit"
     * <li>String "description"
     * </ul>
     */
    public DepXml(Element el) {
        this(XmlHelper.getString(el, "name"), XmlHelper.getString(el, "origname"),
                XmlHelper.getString(el, "category"), XmlHelper.getString(el, "unit"),
                XmlHelper.getString(el, "description"));
        this.min = XmlHelper.getDouble(el, "min");
        this.max = XmlHelper.getDouble(el, "max");
    }

    /**
     * Generate a {@link org.jdom2.Element} with name "dependent" and properties:
     * <ul>
     * <li>String "name"
     * <li>String "origname" *
     * <li>Double "min"
     * <li>Double "max"
     * <li>String "category"
     * <li>String "unit"
     * <li>String "description"
     * </ul>
     */
    @Override
    public Element toXmlElement() {
        Element ret = new Element(ELEMENT_DEPENDENT);

        ret.setAttribute("name", XmlHelper.getNonNull(name));
        ret.setAttribute("origname", XmlHelper.getNonNull(origName));
        ret.setAttribute("min", XmlHelper.getNonNull(min));
        ret.setAttribute("max", XmlHelper.getNonNull(max));
        ret.setAttribute("category", XmlHelper.getNonNull(category));
        ret.setAttribute("unit", XmlHelper.getNonNull(unit));
        ret.setAttribute("description", XmlHelper.getNonNull(description));

        return ret;
    }
}