/**
 * 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.dialect;

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

import org.openbel.framework.common.model.Namespace;

/**
 * Constants for {@link Namespace} domains.
 *
 * @author Steve Ungerer
 */
public enum NamespaceDomain {
    Gene("Gene and Gene Products"),
    BiologicalProcess("BiologicalProcess"),
    Chemical("Chemical");

    private String domainString;

    private NamespaceDomain(String domainString) {
        this.domainString = domainString;
    }

    /**
     * Retrieve the domain string to which this {@link NamespaceDomain} maps.
     *
     * @return
     */
    public String getDomainString() {
        return domainString;
    }

    private static Map<String, NamespaceDomain> DSMAP =
            new HashMap<String, NamespaceDomain>();
    static {
        for (NamespaceDomain nd : values()) {
            DSMAP.put(nd.getDomainString(), nd);
        }
    }

    /**
     * Retrieve the {@link NamespaceDomain} constant for the given domain
     * string.
     *
     * @param domainString
     * @return
     */
    public static NamespaceDomain forDomainString(String domainString) {
        return DSMAP.get(domainString);
    }
}