com.hfg.bio.proteinproperty.MassCalcSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.bio.proteinproperty;

import com.hfg.chem.Element;
import com.hfg.exception.UserInputException;
import com.hfg.setting.StringSetting;
import com.hfg.util.StringUtil;

//------------------------------------------------------------------------------
/**
 * Settings for performing mass calculations on proteins.
 * 
 * @author J. Alex Taylor, hairyfatguy.com
 * 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class MassCalcSettings extends SimpleProteinPropertyCalcSettings
{
    public static final String ATOMIC_WEIGHTS_VERSION     = "atomic_weights_version";

    private static final Element.AtomicWeightsVersion sDefaultAtomicWeightsVersion = Element.getDefaultAtomicWeightsVersion();

    //###########################################################################
    // CONSTRUCTORS
    //###########################################################################

    //---------------------------------------------------------------------------
    public MassCalcSettings()
    {
        super();
    }

    //---------------------------------------------------------------------------
    protected void init()
    {
        super.init();
        add(new StringSetting(ATOMIC_WEIGHTS_VERSION, sDefaultAtomicWeightsVersion.name()));
    }

    //###########################################################################
    // PUBLIC METHODS
    //###########################################################################

    //--------------------------------------------------------------------------
    @SuppressWarnings("unchecked")
    public MassCalcSettings setAtomicWeightsVersion(Element.AtomicWeightsVersion inValue)
    {
        if (null == inValue)
        {
            throw new UserInputException("The atomic weights version cannot be null!");
        }

        get(ATOMIC_WEIGHTS_VERSION).setValue(inValue.name());
        return this;
    }

    //--------------------------------------------------------------------------
    public Element.AtomicWeightsVersion getAtomicWeightsVersion()
    {
        Element.AtomicWeightsVersion value = null;
        String stringValue = get(ATOMIC_WEIGHTS_VERSION).getStringValue();
        if (StringUtil.isSet(stringValue))
        {
            value = Element.AtomicWeightsVersion.valueOf(stringValue);
        }

        return value;
    }

    //--------------------------------------------------------------------------
    public MassCalcSettings setProteinAnalysisMode(ProteinAnalysisMode inValue)
    {
        return (MassCalcSettings) super.setProteinAnalysisMode(inValue);
    }

}