org.mycore.datamodel.language.MCRLanguage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe 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.
 *
 * MyCoRe 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 MyCoRe.  If not, see .
 */

package org.mycore.datamodel.language;

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

/**
 * Represents a language in the datamodel, independent of the type of code used to encode it.
 * 
 * @author Frank L\u00FCtzenkirchen
 */
public class MCRLanguage {

    /**
     * A map from codes used for this language, by code type
     */
    private Map codesByType = new HashMap<>();

    /**
     * A map of labels for this language, by language 
     */
    private Map labelsByLanguage = new HashMap<>();

    private Locale locale;

    /**
     * Language instances are created by the package itself, do not use on your own, use MCRLanguageFactory instead.
     * 
     * @see MCRLanguageFactory
     */
    MCRLanguage() {
    }

    /**
     * Sets the language code of the given type
     */
    void setCode(MCRLanguageCodeType type, String code) {
        codesByType.put(type, code);
    }

    /**
     * Returns the code of this language for the given type
     */
    public String getCode(MCRLanguageCodeType type) {
        return codesByType.get(type);
    }

    /**
     * Returns all language codes used for this language
     */
    public Map getCodes() {
        return codesByType;
    }

    /**
     * Sets the label in the given language
     */
    void setLabel(MCRLanguage language, String label) {
        labelsByLanguage.put(language, label);
    }

    /**
     * Returns the label in the given language
     */
    public String getLabel(MCRLanguage language) {
        return labelsByLanguage.get(language);
    }

    /**
     * Returns the label in the given language
     */
    public String getLabel(String languageCode) {
        MCRLanguage language = MCRLanguageFactory.instance().getLanguage(languageCode);
        return labelsByLanguage.get(language);
    }

    /**
     * Returns all labels used for this language
     */
    public Map getLabels() {
        return labelsByLanguage;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof MCRLanguage) {
            return this.toString().equals(obj.toString());
        } else {
            return false;
        }
    }

    @Override
    public int hashCode() {
        return toString().hashCode();
    }

    @Override
    public String toString() {
        return getCode(MCRLanguageCodeType.xmlCode);
    }

    public Locale getLocale() {
        return locale;
    }

    void setLocale(Locale locale) {
        this.locale = locale;
    }
}