com.adobe.granite.translation.api

Interface TranslationConfig

@ProviderType
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 and Description
static String	PROPERTY_CATEGORY_LABEL Name of the property on category nodes that contains the label.
static String	PROPERTY_LANGUAGE_LABEL Name of the property on language nodes that contains the label.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getCategories() Returns a Map of the currently allowed content categories The default location for the categories is: "/libs/granite/translation/resources/categories".
Map<String,String>	getLanguages() Deprecated. since 2.3.0, use getLanguages(ResourceResolver) instead. Returns a Map of the currently allowed language codes. The default location for the language codes is: "/libs/wcm/core/resources/languages"
Map<String,String>	getLanguages(ResourceResolver resolver) Returns a Map of the currently allowed language codes.

Field Detail

PROPERTY_LANGUAGE_LABEL

static final 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 String PROPERTY_CATEGORY_LABEL

Name of the property on category nodes that contains the label.

See Also:

Constant Field Values

Method Detail

getLanguages

@Deprecated
Map<String,String> getLanguages()
                                     throws TranslationException

Deprecated. since 2.3.0, use getLanguages(ResourceResolver) instead. Returns a Map of the currently allowed language codes. The default location for the language codes is: "/libs/wcm/core/resources/languages"

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

getLanguages

Map<String,String> getLanguages(ResourceResolver resolver)

Returns a Map of the currently allowed language codes. The default location for the language codes is: "/libs/wcm/core/resources/languages"

Parameters:

resolver - used for resolving language code path

Returns:

Map<String, String> containing the list of allowed language codes and their respective labels (in English) (<Language Code, Language Label>)

getCategories

Map<String,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