com.force.i18n.grammar.LanguageGender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grammaticus Show documentation
Localization Framework that allows grammatically correct renaming of nouns
There is a newer version: 1.2.30
/*
 * Copyright (c) 2017, salesforce.com, inc.
 * All rights reserved.
 * Licensed under the BSD 3-Clause license.
 * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
 */

package com.force.i18n.grammar;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Represents the gender or noun class of an *object* associated with a noun.
 *
 * Generally, the cloud
 * @author stamm
 */
public enum LanguageGender {
    NEUTER ("n", "Neuter"),
    FEMININE ("f", "Feminine", "c", "e"),   // Dutch = "c", Swedish = "e"
    MASCULINE ("m", "Masculine"),
    ANIMATE_MASCULINE ("a", "AnimateMasculine"), //West Slavic

    // Bantu Noun Classes.  Swahili noun classes available as aliases
    // In isiXhosa & isiZulu, class I and Ia, while different for nouns, are the same for adjectives, so are unmarked.
    // Note: In other Bantu languages, like Tswana, the numbering is different (The plurals are part of the class, not a separate one)
    // That may cause confusion
    CLASS_I ("1", "ClassI", "M-wa", "I"), // Class I/II M-Wa
    CLASS_III("3", "ClassIII", "M-mi", "III"), // Class III/IV M-Mi
    CLASS_V("5", "ClassV", "Ma", "V"), // Class V/VI Ma
    CLASS_VII("7", "ClassVII", "Ki-vi", "VII"), // Class VII/VIII Ki-vi
    CLASS_IX("9", "ClassIX", "N", "IX"), // Class IX/X N
    CLASS_XI("U", "ClassXI", "XI"), // Class XI/XII U Class.
    CLASS_XIV("B", "ClassXIV", "XIV"), // Class XIV (Zulu/Xhosa ubu-)
    CLASS_XV("S", "ClassXV", "XV"), // Class XV (Zulu/Xhosa uku-)
    CLASS_XVI("P", "ClassXVI", "Pa", "XVI"), // Class XVI Pa Class
    CLASS_XVII("K", "ClassXVII", "Ku", "XVII"), // Class XVII Ku Class
    CLASS_XVIII("M", "ClassXVIII", "Mu", "XVIII"), // Class XVIII Mu Class
    ;

	public static final char JSON_ATTR_NAME = 'g';

    private static final Map dbValueMap = new HashMap(8);
    private static final Map labelValueMap = new HashMap(16);
    static {
        for (LanguageGender gender : values()) {
            dbValueMap.put(gender.getDbValue(), gender);
            labelValueMap.put(gender.getDbValue(), gender);
            if (gender.aliases != null) {
                for (String alias : gender.aliases) {
                    LanguageGender old = labelValueMap.put(alias, gender);
                    assert old == null;
                }
            }
        }
    }

    private final String dbValue;
    private final String apiValue;
    private final String[] aliases;
    private LanguageGender(String dbValue, String apiValue, String... aliases) {
        this.dbValue = dbValue;
        this.apiValue = apiValue;
        this.aliases = aliases;
    }
    public String getDbValue() { return this.dbValue; }
    public String getApiValue() { return this.apiValue; }
    public boolean isDefault() { return false; }
    public static LanguageGender fromDbValue(String dbValue) {
        return dbValueMap.get(dbValue);
    }
    public List getAliases() {
        return Collections.unmodifiableList(Arrays.asList(this.aliases));
    }

    public static LanguageGender fromLabelValue(String labelValue) {
        if (labelValue == null) return null;
        return labelValueMap.get(labelValue);
    }

    public static LanguageGender fromApiValue(String apiValue) {
        for (LanguageGender e : values()) {
            if (e.getApiValue().equals(apiValue)) return e;
        }
        return null;
    }

    /*
     * Alias definitions
     */
    /**
     * Swedish uses EUTER as a gender, which isn't feminine, but we store it as such
     */
    public static final LanguageGender EUTER = FEMININE;
    /**
     * Dutch has "de" and "het" words, het is netuer and "de" is either masculine or feminine; but we use feminine.
     */
    public static final LanguageGender COMMON = FEMININE;
}