Package com.adobe.granite.translation.api

Interface TranslationConfig

  • public interface TranslationConfig
    This TranslationConfig interface is used to return the full list of Language Codes and Content Categories which are stored within the system. These lists are used by the Translation API as the only acceptable inputs to their respective parameters.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROPERTY_CATEGORY_LABEL
      Name of the property on category nodes that contains the label.
      static java.lang.String PROPERTY_LANGUAGE_LABEL
      Name of the property on language nodes that contains the label.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getCategories()
      Returns a Map of the currently allowed content categories The default location for the categories is: "/libs/granite/translation/resources/categories".
      java.util.Map<java.lang.String,​java.lang.String> getLanguages()
      Returns a Map of the currently allowed language codes.

    • Field Detail

      • PROPERTY_LANGUAGE_LABEL

        static final java.lang.String PROPERTY_LANGUAGE_LABEL
        Name of the property on language nodes that contains the label.
        See Also:
        Constant Field Values

      • PROPERTY_CATEGORY_LABEL

        static final java.lang.String PROPERTY_CATEGORY_LABEL
        Name of the property on category nodes that contains the label.
        See Also:
        Constant Field Values

    • Method Detail

      • getLanguages

        java.util.Map<java.lang.String,​java.lang.String> getLanguages()
                                                             throws TranslationException
        Returns a Map of the currently allowed language codes. The default location for the language codes is: "/libs/granite/translation/resources/language"
        Returns:
        Map<String, String> containing the list of allowed language codes and their respective labels (in English) (<Language Code, Language Label>)
        Throws:
        TranslationException - the translation exception

      • getCategories

        java.util.Map<java.lang.String,​java.lang.String> getCategories()
                                                              throws TranslationException
        Returns a Map of the currently allowed content categories The default location for the categories is: "/libs/granite/translation/resources/categories".
        Returns:
        Map<String, String> containing the list of allowed content categories and their respective labels (in English) (<Content Category, Category Label>)
        Throws:
        TranslationException - the translation exception