org.ametys.plugins.repository.metadata

Class MultilingualStringHelper

java.lang.Object

org.ametys.plugins.repository.metadata.MultilingualStringHelper

public final class MultilingualStringHelper
extends Object

Helper methods for MultilingualString metadata

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DEFAULT_LOCALE The default locale

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MultilingualStringHelper()

Method Summary

Modifier and Type	Method and Description
static String	getValue(CompositeMetadata parentMetadata, String metadataName, Locale locale) Returns the closest non-empty value for a MultilingualString metadata in a given locale.
static String	getValue(MultilingualString multilingualString, Locale locale) Returns the closest non-empty value for a MultilingualString in a given locale.
static List<Locale>	localeLookupList(Locale locale) Return the list of closest locales to search
static Map<String,Object>	toJson(MultilingualString multilingualString) Get the JSON representation of a MultilingualString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

The default locale

Constructor Detail

MultilingualStringHelper

private MultilingualStringHelper()

Method Detail

getValue

public static String getValue(CompositeMetadata parentMetadata,
                              String metadataName,
                              Locale locale)
                       throws AmetysRepositoryException

Returns the closest non-empty value for a MultilingualString metadata in a given locale. If no close locale is found, return the value for Locale.ENGLISH if exists.
Otherwise, the value of first stored locale will be returned.

Parameters:

parentMetadata - The metadata holder

metadataName - The metadata name

locale - The requested locale

Returns:

the closest non-empty localized value or null if not found.

Throws:

AmetysRepositoryException - if an errors occurs.

getValue

public static String getValue(MultilingualString multilingualString,
                              Locale locale)
                       throws AmetysRepositoryException

Returns the closest non-empty value for a MultilingualString in a given locale. If no close locale is found, return the value for Locale.ENGLISH if exists.
Otherwise, the value of first stored locale will be returned.

Parameters:

multilingualString - The multilingual string

locale - The requested locale. Can be null.

Returns:

the closest non-empty localized value or null if not found.

Throws:

AmetysRepositoryException - if an errors occurs.

localeLookupList

public static List<Locale> localeLookupList(Locale locale)

Return the list of closest locales to search

Parameters:

locale - the locale to start from. If null, returns the default locale

Returns:

the unmodifiable list of Locale objects, 0 being locale, not null

toJson

public static Map<String,Object> toJson(MultilingualString multilingualString)
                                 throws AmetysRepositoryException

Get the JSON representation of a MultilingualString

Parameters:

multilingualString - The multilingual string. Cannot be null.

Returns:

A map with the locales and values.

Throws:

AmetysRepositoryException - if an error occurs