001/*
002 * #%L
003 * Netarchivesuite - harvester
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023package dk.netarkivet.harvester.webinterface;
024
025import dk.netarkivet.common.exceptions.ArgumentNotValid;
026
027/**
028 * Enumeration of the possible ways to search for domains.
029 */
030public enum DomainSearchType {
031
032    /** search in the crawlertraps associated with a domain. */
033    CRAWLERTRAPS,
034    /** search the name associated with a domain. */
035    NAME,
036    /** search the comments associated with a domain. */
037    COMMENTS;
038
039    /**
040     * Helper method that tries to convert a string to a DomainSearchType.
041     *
042     * @param type a DomainSearchType as string
043     * @return the DomainSearchType related to a string
044     * @throws ArgumentNotValid
045     */
046    public static DomainSearchType parse(String type) {
047        for (DomainSearchType s : values()) {
048            if (s.name().equalsIgnoreCase(type)) {
049                return s;
050            }
051        }
052        throw new ArgumentNotValid("Invalid Domain Search Type '" + type + "'");
053    }
054
055    /**
056     * Return the localized key related to this value.
057     *
058     * @return The localized key for this value.
059     */
060    public String getLocalizedKey() {
061        switch (this) {
062        case NAME:
063            return "domain.search.name";
064        case CRAWLERTRAPS:
065            return "domain.search.crawlertraps";
066        case COMMENTS:
067            return "domain.search.comments";
068        default:
069            throw new ArgumentNotValid("Invalid Domain Search Type '" + this + "'");
070        }
071    }
072}