com.force.i18n.grammar.impl.BantuDeclension 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) 2019, 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.impl;

import static com.force.i18n.grammar.LanguageGender.*;
import java.util.*;

import com.force.i18n.HumanLanguage;
import com.force.i18n.grammar.*;
import com.force.i18n.grammar.Noun.NounType;
import com.force.i18n.grammar.impl.ComplexGrammaticalForm.ComplexAdjective;
import com.force.i18n.grammar.impl.ComplexGrammaticalForm.ComplexAdjectiveForm;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;

/**
 * Declension for Bantu languages, with noun classes.
 *
 * For simplicity, we ask for nouns with singular and plural, and then ask for the noun class.
 * So when expressing a translation for "Account", we'll ask for
 * "Akaunti", "Akaunti", N Class (IX/X)
 *

 *
 * @author stamm
 * @since 1.1
 */
abstract class BantuDeclension extends AbstractLanguageDeclension {
    static final List ALL_FORMS = ImmutableList.copyOf(EnumSet.allOf(PluralNounForm.class));
    static final Set OTHER_FORMS = EnumSet.of(PluralNounForm.SINGULAR);
    private final List adjectiveForms;

    public BantuDeclension(HumanLanguage language) {
        super(language);

        ImmutableList.Builder adjBuilder = ImmutableList.builder();
        int adjOrdinal = 0;
        for (LanguageNumber number : getAllowedNumbers()) {
            for (LanguageGender gender : getRequiredGenders()) {
                adjBuilder.add(new BantuAdjectiveForm(this, number, gender, adjOrdinal++));
            }
        }
        this.adjectiveForms = adjBuilder.build();
    }


    static class BantuAdjectiveForm extends ComplexAdjectiveForm {
        private static final long serialVersionUID = 1L;

        private final LanguageNumber number;
        private final LanguageGender gender;

        public BantuAdjectiveForm(LanguageDeclension declension, LanguageNumber number, LanguageGender gender, int ordinal) {
            super(declension, ordinal);
            this.number = number;
            this.gender = gender;
        }

        @Override public LanguageArticle getArticle() { return LanguageArticle.ZERO; }
        @Override public LanguageCase getCase() {  return LanguageCase.NOMINATIVE; }
        @Override public LanguageNumber getNumber() {  return this.number; }
        @Override public LanguageStartsWith getStartsWith() {  return LanguageStartsWith.CONSONANT; }
        @Override public LanguageGender getGender() {  return this.gender; }
        @Override public LanguagePossessive getPossessive() { return LanguagePossessive.NONE; }

        @Override
        public String getKey() {
            return getGender().getDbValue() + "-" + getNumber().getDbValue();
        }

        @Override
        public int hashCode() {
            return Objects.hash(super.hashCode(), this.number, this.gender);
        }

        @Override
        public boolean equals(Object other) {
            if (this == other) return true;
            if (other instanceof BantuAdjectiveForm) {
                BantuAdjectiveForm o = this.getClass().cast(other);
                return super.equals(other) && this.number == o.number && this.gender == o.gender;
            }
            return false;
        }
    }

    /**
     * Represents a bantu adjective
     */
    public static class BantuAdjective extends ComplexAdjective {
        private static final long serialVersionUID = 1L;

        BantuAdjective(LanguageDeclension declension, String name, LanguagePosition position) {
            super(declension, name, position);
        }

        @Override
        protected final Class getFormClass() {
            return BantuAdjectiveForm.class;
        }

        @Override
        public boolean validate(String name) {
            return defaultValidate(name, ImmutableSet.of(getDeclension().getAdjectiveForm(LanguageStartsWith.CONSONANT, LanguageGender.CLASS_I, LanguageNumber.SINGULAR, LanguageCase.NOMINATIVE, LanguageArticle.ZERO, LanguagePossessive.NONE)));
        }
   }

   @Override
   public Adjective createAdjective(String name, LanguageStartsWith startsWith, LanguagePosition position) {
       return new BantuAdjective(this, name, position);
   }

    @Override
    public Noun createNoun(String name, String pluralAlias, NounType type, String entityName, LanguageStartsWith startsWith,
            LanguageGender gender, String access, boolean isStandardField, boolean isCopied) {
        return new SimplePluralNounWithGender(this, name, pluralAlias, type, entityName, gender, access, isStandardField, isCopied);
    }

    @Override
    public List< ? extends AdjectiveForm> getAdjectiveForms() {
        return this.adjectiveForms;
    }

    @Override
    public List< ? extends NounForm> getAllNounForms() {
        return ALL_FORMS;
    }

    @Override
    public Collection< ? extends NounForm> getEntityForms() {
        return ALL_FORMS;
    }
    @Override
    public Collection< ? extends NounForm> getFieldForms() {
        return OTHER_FORMS;
    }

    @Override
    public Collection< ? extends NounForm> getOtherForms() {
        return OTHER_FORMS;
    }

    @Override
    public boolean hasArticle() {
        return false;
    }

    @Override
    public boolean hasGender() {
        return true;
    }

    @Override
    public LanguageGender getDefaultGender() {
        return LanguageGender.CLASS_I;
    }

    @Override
    public boolean hasStartsWith() {
        return false;
    }

    /**
     * Declension for the Kiswahili language
     * */
    /*
     * An example of specifying adjectives would be

 
    Mpya
    Wapya
    Mpya
    Mipya
    Jipya
    Mapya
    Kipya
    Vipya
    Mpya
    Mpya
    Mpya
    Mpya
    Mpya
    Mpya
    Mpya
 

 
    Wangu
    Wangu
    Wangu
    Yangu
    Langu
    Yangu
    Changu
    Vyangu
    Yangu
    Zangu
    Wangu
    Wangu
    Pangu
    Kwangu
    Mwangu
 

     *
     *
     * @author stamm
     * @since 220
     */
    static final class SwahiliDeclension extends BantuDeclension {
        public SwahiliDeclension(HumanLanguage language) {
            super(language);
        }

        @Override
        public EnumSet getRequiredGenders() {
            return EnumSet.of(CLASS_I, CLASS_III, CLASS_V, CLASS_VII, CLASS_IX, CLASS_XI, CLASS_XVI, CLASS_XVII, CLASS_XVIII);
        }
    }

    /**
     * Declension for the isiZulu language
     *
     */
 /*
     * An example of specifying adjectives would be
 
    Omusha
    Abasha
    Omusha
    Emisha
    Elisha
    Amasha
    Esisha
    Vipya
    Entsha
    Ezintsha
    Entsha
    Ezintsha
    Obusha
    Okusha
    Okusha
 

     *
     * @author stamm
     * @since 220
     */
    static final class ZuluDeclension extends BantuDeclension {
        public ZuluDeclension(HumanLanguage language) {
            super(language);
        }

        @Override
        public EnumSet getRequiredGenders() {
            return EnumSet.of(CLASS_I, CLASS_III, CLASS_V, CLASS_VII, CLASS_IX, CLASS_XI, CLASS_XIV, CLASS_XV, CLASS_XVII);
        }
    }

    /**
     * Declension for the isiXhosa language.
     *
     * @author stamm
     * @since 220
     */
    static final class XhosaDeclension extends BantuDeclension {
        public XhosaDeclension(HumanLanguage language) {
            super(language);
        }

        @Override
        public EnumSet getRequiredGenders() {
            return EnumSet.of(CLASS_I, CLASS_III, CLASS_V, CLASS_VII, CLASS_IX, CLASS_XI, CLASS_XIV, CLASS_XV, CLASS_XVII);
        }
    }
}