/**
 * Copyright (C) 2012-2013 Selventa, Inc.
 *
 * This file is part of the OpenBEL Framework.
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * The OpenBEL Framework 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 the OpenBEL Framework. If not, see <http://www.gnu.org/licenses/>.
 *
 * Additional Terms under LGPL v3:
 *
 * This license does not authorize you and you are prohibited from using the
 * name, trademarks, service marks, logos or similar indicia of Selventa, Inc.,
 * or, in the discretion of other licensors or authors of the program, the
 * name, trademarks, service marks, logos or similar indicia of such authors or
 * licensors, in any marketing or advertising materials relating to your
 * distribution of the program or any covered product. This restriction does
 * not waive or limit your obligation to keep intact all copyright notices set
 * forth in the program as delivered to you.
 *
 * If you distribute the program in whole or in part, or any modified version
 * of the program, and you assume contractual liability to the recipient with
 * respect to the program or modified version, then you will indemnify the
 * authors and licensors of the program for any liabilities that these
 * contractual assumptions directly impose on those licensors and authors.
 */
package org.openbel.framework.ws.model;

import java.util.HashMap;
import java.util.Map;

import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;

/**
 * <p>Java class for FunctionType.
 *
 * <p>The following schema fragment specifies the expected content contained within this class.
 * <p>
 * <pre>
 * <simpleType name="FunctionType">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="UNKNOWN"/>
 *     <enumeration value="ABUNDANCE"/>
 *     <enumeration value="BIOLOGICAL_PROCESS"/>
 *     <enumeration value="CATALYTIC_ACTIVITY"/>
 *     <enumeration value="CELL_SECRETION"/>
 *     <enumeration value="CELL_SURFACE_EXPRESSION"/>
 *     <enumeration value="CHAPERONE_ACTIVITY"/>
 *     <enumeration value="COMPLEX_ABUNDANCE"/>
 *     <enumeration value="COMPOSITE_ABUNDANCE"/>
 *     <enumeration value="DEGRADATION"/>
 *     <enumeration value="FUSION"/>
 *     <enumeration value="GENE_ABUNDANCE"/>
 *     <enumeration value="GTP_BOUND_ACTIVITY"/>
 *     <enumeration value="KINASE_ACTIVITY"/>
 *     <enumeration value="LIST"/>
 *     <enumeration value="MICRORNA_ABUNDANCE"/>
 *     <enumeration value="MOLECULAR_ACTIVITY"/>
 *     <enumeration value="PATHOLOGY"/>
 *     <enumeration value="PEPTIDASE_ACTIVITY"/>
 *     <enumeration value="PHOSPHATASE_ACTIVITY"/>
 *     <enumeration value="PRODUCTS"/>
 *     <enumeration value="PROTEIN_ABUNDANCE"/>
 *     <enumeration value="PROTEIN_MODIFICATION"/>
 *     <enumeration value="REACTANTS"/>
 *     <enumeration value="REACTION"/>
 *     <enumeration value="RIBOSYLATION_ACTIVITY"/>
 *     <enumeration value="RNA_ABUNDANCE"/>
 *     <enumeration value="SUBSTITUTION"/>
 *     <enumeration value="TRANSCRIPTIONAL_ACTIVITY"/>
 *     <enumeration value="TRANSLOCATION"/>
 *     <enumeration value="TRANSPORT_ACTIVITY"/>
 *     <enumeration value="TRUNCATION"/>
 *   </restriction>
 * </simpleType>
 * </pre>
 *
 */
@XmlType(name = "FunctionType")
@XmlEnum
public enum FunctionType {

    UNKNOWN("unknown"),
    ABUNDANCE("abundance"),
    BIOLOGICAL_PROCESS("biologicalProcess"),
    CATALYTIC_ACTIVITY("catalyticActivity"),
    CELL_SECRETION("cellSecretion"),
    CELL_SURFACE_EXPRESSION("cellSurfaceExpression"),
    CHAPERONE_ACTIVITY("chaperoneActivity"),
    COMPLEX_ABUNDANCE("complexAbundance"),
    COMPOSITE_ABUNDANCE("compositeAbundance"),
    DEGRADATION("degradation"),
    FUSION("fusion"),
    GENE_ABUNDANCE("geneAbundance"),
    GTP_BOUND_ACTIVITY("gtpBoundActivity"),
    KINASE_ACTIVITY("kinaseActivity"),
    LIST("list"),
    MICRORNA_ABUNDANCE("microRNAAbundance"),
    MOLECULAR_ACTIVITY("molecularActivity"),
    PATHOLOGY("pathology"),
    PEPTIDASE_ACTIVITY("peptidaseActivity"),
    PHOSPHATASE_ACTIVITY("phosphataseActivity"),
    PRODUCTS("products"),
    PROTEIN_ABUNDANCE("proteinAbundance"),
    PROTEIN_MODIFICATION("proteinModification"),
    REACTANTS("reactants"),
    REACTION("reaction"),
    RIBOSYLATION_ACTIVITY("ribosylationActivity"),
    RNA_ABUNDANCE("rnaAbundance"),
    SUBSTITUTION("substitution"),
    TRANSCRIPTIONAL_ACTIVITY("transcriptionalActivity"),
    TRANSLOCATION("translocation"),
    TRANSPORT_ACTIVITY("transportActivity"),
    TRUNCATION("truncation");

    private static final Map<String, FunctionType> mapping =
            new HashMap<String, FunctionType>(values().length);

    static {
        for (FunctionType r : values()) {
            mapping.put(r.displayValue, r);
        }
    }

    private String displayValue;

    private FunctionType(final String displayValue) {
        this.displayValue = displayValue;
    }

    public String value() {
        return name();
    }

    public String getDisplayValue() {
        return displayValue;
    }

    public static FunctionType fromValue(String v) {
        // try display value
        FunctionType r = mapping.get(v);
        if (r != null) return r;

        // try enum name
        return valueOf(v);
    }
}