Package org.languagetool.language

Class LanguageBuilder.ExtendedLanguage

    • Field Detail

      • baseLanguage

        private final Language baseLanguage

      • name

        private final java.lang.String name

      • ruleFile

        private final java.io.File ruleFile

    • Constructor Detail

      • ExtendedLanguage

        ExtendedLanguage​(Language baseLanguage,
                 java.lang.String name,
                 java.io.File ruleFile)

    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: Language
        Get this language's name in English, e.g. English or German (Germany).
        Specified by:
        getName in class Language
        Returns:
        language name

      • getRuleFileNames

        public java.util.List<java.lang.String> getRuleFileNames()
        Description copied from class: Language
        Get the location of the rule file(s) in a form like /org/languagetool/rules/de/grammar.xml, i.e. a path in the classpath. The files must exist or an exception will be thrown, unless the filename contains the string -test-.
        Overrides:
        getRuleFileNames in class Language

      • isExternal

        public boolean isExternal()
        Description copied from class: Language
        For internal use only. Overwritten to return true for languages that have been loaded from an external file after start up.
        Overrides:
        isExternal in class Language

      • getLocale

        public java.util.Locale getLocale()
        Description copied from class: Language
        Get this language's Java locale, not considering the country code.
        Overrides:
        getLocale in class Language

      • getMaintainers

        public Contributor[] getMaintainers()
        Description copied from class: Language
        Get the name(s) of the maintainer(s) for this language or null.
        Specified by:
        getMaintainers in class Language

      • getShortCode

        public java.lang.String getShortCode()
        Description copied from class: Language
        Get this language's character code, e.g. en for English. For most languages this is a two-letter code according to ISO 639-1, but for those languages that don't have a two-letter code, a three-letter code according to ISO 639-2 is returned. The country parameter (e.g. "US"), if any, is not returned.
        Specified by:
        getShortCode in class Language

      • getCountries

        public java.lang.String[] getCountries()
        Description copied from class: Language
        Get this language's country options , e.g. US (as in en-US) or PL (as in pl-PL).
        Specified by:
        getCountries in class Language
        Returns:
        String[] - array of country options for the language.

      • getRelevantRules

        public java.util.List<Rule> getRelevantRules​(java.util.ResourceBundle messages,
                                             UserConfig userConfig,
                                             Language motherTongue,
                                             java.util.List<Language> altLanguages)
                                      throws java.io.IOException
        Description copied from class: Language
        Get the rules classes that should run for texts in this language.
        Specified by:
        getRelevantRules in class Language
        Throws:
        java.io.IOException

      • getVariant

        @Nullable
public @Nullable java.lang.String getVariant()
        Description copied from class: Language
        Get this language's variant, e.g. valencia (as in ca-ES-valencia) or null. Attention: not to be confused with "country" option
        Overrides:
        getVariant in class Language
        Returns:
        variant for the language or null

      • getDefaultEnabledRulesForVariant

        public java.util.List<java.lang.String> getDefaultEnabledRulesForVariant()
        Description copied from class: Language
        Get enabled rules different from the default ones for this language variant.
        Overrides:
        getDefaultEnabledRulesForVariant in class Language
        Returns:
        enabled rules for the language variant.

      • getDefaultDisabledRulesForVariant

        public java.util.List<java.lang.String> getDefaultDisabledRulesForVariant()
        Description copied from class: Language
        Get disabled rules different from the default ones for this language variant.
        Overrides:
        getDefaultDisabledRulesForVariant in class Language
        Returns:
        disabled rules for the language variant.

      • getLanguageModel

        @Nullable
public @Nullable LanguageModel getLanguageModel​(java.io.File indexDir)
                                         throws java.io.IOException
        Overrides:
        getLanguageModel in class Language
        Parameters:
        indexDir - directory with a '3grams' sub directory which contains a Lucene index with 3gram occurrence counts
        Returns:
        a LanguageModel or null if this language doesn't support one
        Throws:
        java.io.IOException

      • getRelevantLanguageModelRules

        public java.util.List<Rule> getRelevantLanguageModelRules​(java.util.ResourceBundle messages,
                                                          LanguageModel languageModel)
                                                   throws java.io.IOException
        Description copied from class: Language
        Get a list of rules that require a LanguageModel. Returns an empty list for languages that don't have such rules.
        Overrides:
        getRelevantLanguageModelRules in class Language
        Throws:
        java.io.IOException

      • getRelevantWord2VecModelRules

        public java.util.List<Rule> getRelevantWord2VecModelRules​(java.util.ResourceBundle messages,
                                                          Word2VecModel word2vecModel)
                                                   throws java.io.IOException
        Description copied from class: Language
        Get a list of rules that require a Word2VecModel. Returns an empty list for languages that don't have such rules.
        Overrides:
        getRelevantWord2VecModelRules in class Language
        Throws:
        java.io.IOException

      • getLocaleWithCountryAndVariant

        public java.util.Locale getLocaleWithCountryAndVariant()
        Description copied from class: Language
        Get this language's Java locale, considering language code and country code (if any).
        Overrides:
        getLocaleWithCountryAndVariant in class Language

      • getDefaultLanguageVariant

        @Nullable
public @Nullable Language getDefaultLanguageVariant()
        Description copied from class: Language
        Languages that have country variants need to overwrite this to select their most common variant.
        Overrides:
        getDefaultLanguageVariant in class Language
        Returns:
        default country variant or null

      • getTagger

        public Tagger getTagger()
        Description copied from class: Language
        Get this language's part-of-speech tagger implementation. The tagger must not be null, but it can be a trivial pseudo-tagger that only assigns null tags.
        Overrides:
        getTagger in class Language

      • getChunker

        @Nullable
public @Nullable Chunker getChunker()
        Description copied from class: Language
        Get this language's chunker implementation or null.
        Overrides:
        getChunker in class Language

      • getSynthesizer

        @Nullable
public @Nullable Synthesizer getSynthesizer()
        Description copied from class: Language
        Get this language's part-of-speech synthesizer implementation or null.
        Overrides:
        getSynthesizer in class Language