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
private static String	__ENTRIES_SEPARATOR The separator between the entries for the string representation of a multilingual string
private static String	__LOCALE_AND_VALUE_SEPARATOR The separator between the locale and the value for the string representation of a multilingual string
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 MultilingualString	fromConfiguration(Configuration configuration) Get the MultilingualString object from the given Configuration
static MultilingualString	fromJSON(Map<String,? extends Object> json) Get the MultilingualString object from its JSON representation
static MultilingualString	fromString(String string) Retrieves the MultilingualString from its string representation
static Locale	getClosestNonEmptyLocale(MultilingualString multilingualString, Locale locale) Returns the closest non-empty locale for a MultilingualString in a given locale.
static String	getValue(CompositeMetadata parentMetadata, String metadataName, Locale locale) Deprecated. Use getValue(ModelAwareDataHolder, String, Locale) or getValue(ModelLessDataHolder, String, Locale) instead
static String	getValue(ModelAwareDataHolder dataHolder, String dataName, Locale locale) Returns the closest non-empty value for a MultilingualString element in a given locale.
static String	getValue(ModelLessDataHolder dataHolder, String dataName, Locale locale) Returns the closest non-empty value for a MultilingualString element 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 void	sax(ContentHandler contentHandler, String tagName, MultilingualString multilingualString, Locale locale) Saxes the given multilingual string
static Map<String,Object>	toJson(MultilingualString multilingualString) Get the JSON representation of a MultilingualString
static String	toString(MultilingualString multilingualString) Retrieves a string 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

__LOCALE_AND_VALUE_SEPARATOR

private static final String __LOCALE_AND_VALUE_SEPARATOR

The separator between the locale and the value for the string representation of a multilingual string

See Also:

Constant Field Values

__ENTRIES_SEPARATOR

private static final String __ENTRIES_SEPARATOR

The separator between the entries for the string representation of a multilingual string

See Also:

Constant Field Values

Constructor Detail

MultilingualStringHelper

private MultilingualStringHelper()

Method Detail

getValue

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

Deprecated. Use getValue(ModelAwareDataHolder, String, Locale) or getValue(ModelLessDataHolder, String, Locale) instead

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(ModelLessDataHolder dataHolder,
                              String dataName,
                              Locale locale)
                       throws AmetysRepositoryException

Returns the closest non-empty value for a MultilingualString element 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:

dataHolder - data holder

dataName - The data 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(ModelAwareDataHolder dataHolder,
                              String dataName,
                              Locale locale)
                       throws AmetysRepositoryException

Returns the closest non-empty value for a MultilingualString element 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:

dataHolder - The data holder

dataName - The data 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.

getClosestNonEmptyLocale

public static Locale getClosestNonEmptyLocale(MultilingualString multilingualString,
                                              Locale locale)
                                       throws AmetysRepositoryException

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

Parameters:

multilingualString - The multilingual string

locale - The requested locale. Can be null.

Returns:

the closest non-empty locale 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

sax

public static void sax(ContentHandler contentHandler,
                       String tagName,
                       MultilingualString multilingualString,
                       Locale locale)
                throws SAXException

Saxes the given multilingual string

Parameters:

contentHandler - the content handler where to SAX into.

tagName - the name of the tag to sax the multilingual string

multilingualString - the multilingual string to sax

locale - the requested locale. Can be null.

Throws:

SAXException - if an errors occurs during the value saxing

fromConfiguration

public static MultilingualString fromConfiguration(Configuration configuration)

Get the MultilingualString object from the given Configuration

Parameters:

configuration - the configuration containing the multilingual string data

Returns:

the MultilingualString object

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

fromJSON

public static MultilingualString fromJSON(Map<String,? extends Object> json)

Get the MultilingualString object from its JSON representation

Parameters:

json - the JSON representation of the multilingual string

Returns:

the MultilingualString object

toString

public static String toString(MultilingualString multilingualString)

Retrieves a string representation of a MultilingualString

Parameters:

multilingualString - the multilingual string

Returns:

thestring representation of the multilingual string

fromString

public static MultilingualString fromString(String string)
                                     throws IllegalArgumentException

Retrieves the MultilingualString from its string representation

Parameters:

string - the string representation of the multilingual string

Returns:

the multilingual string from its string representation, or null if the given string value is null or empty

Throws:

IllegalArgumentException - if the given string value can't be cast to a multilingual string