com.haulmont.cuba.core.global

Class MessageTools

java.lang.Object

com.haulmont.cuba.core.global.MessageTools

Direct Known Subclasses:

TestMessageTools

@Component(value="cuba_MessageTools")
public class MessageTools
extends java.lang.Object

Utility class to provide common functionality related to localized messages.
Implemented as Spring bean to allow extension in application projects.
A reference to this class can be obtained either via DI or by Messages.getTools() method.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExtendedEntities	extendedEntities
protected GlobalConfig	globalConfig
static java.lang.String	MAIN_MARK
static java.lang.String	MARK Prefix defining that the string is actually a key in a localized messages pack.
protected Messages	messages
protected Metadata	metadata
static java.lang.String	NAME
protected java.lang.Boolean	useLocaleLanguageOnly

Constructor Summary

Constructors

Constructor and Description
MessageTools(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultDateFormat(javax.persistence.TemporalType temporalType)
java.util.Locale	getDefaultLocale()
java.lang.String	getDefaultRequiredMessage(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.String propertyName) Get default required message for specified property of MetaClass.
java.lang.String	getDefaultRequiredMessage(com.haulmont.chile.core.model.MetaProperty metaProperty) Deprecated. Use getDefaultRequiredMessage(MetaClass, String)
java.lang.String	getDetailedEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass)
java.lang.String	getDetailedEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass, java.util.Locale locale)
java.lang.String	getEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass)
java.lang.String	getEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass, java.util.Locale locale)
java.lang.String	getLocValue(java.lang.String attribute, com.haulmont.chile.core.model.Instance instance) Get localized value of an attribute based on LocalizedValue annotation.
java.lang.String	getMessageRef(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.String propertyName) Get message reference of an entity property.
java.lang.String	getMessageRef(com.haulmont.chile.core.model.MetaProperty property) Get message reference of an entity property.
protected java.lang.String	getNotNullMessage(com.haulmont.chile.core.model.MetaProperty metaProperty) Get default required message for specified property of MetaClass if it has NotNull annotation.
java.lang.String	getPropertyCaption(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.String propertyName) Get localized name of an entity property.
java.lang.String	getPropertyCaption(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.String propertyName, java.util.Locale locale) Get localized name of an entity property.
java.lang.String	getPropertyCaption(com.haulmont.chile.core.model.MetaProperty property) Get localized name of an entity property.
java.lang.String	getPropertyCaption(com.haulmont.chile.core.model.MetaProperty property, java.util.Locale locale) Get localized name of an entity property.
boolean	hasPropertyCaption(com.haulmont.chile.core.model.MetaProperty property) Checks whether a localized name of the property exists.
java.lang.String	inferMessagePack(java.lang.String attribute, com.haulmont.chile.core.model.Instance instance) Returns message pack inferred from LocalizedValue annotation.
java.lang.String	loadString(java.lang.String ref) Get localized message by reference provided in the full format.
java.lang.String	loadString(java.lang.String ref, java.util.Locale locale) Get localized message by reference provided in the full format.
java.lang.String	loadString(java.lang.String messagesPack, java.lang.String ref) Get localized message by reference provided in full or brief format.
java.lang.String	loadString(java.lang.String messagesPack, java.lang.String ref, java.util.Locale locale) Get localized message by reference provided in full or brief format.
java.lang.String	localeToString(java.util.Locale locale) Locale representation depending on cuba.useLocaleLanguageOnly application property.
java.util.Locale	trimLocale(java.util.Locale locale) Trims locale to language-only if useLocaleLanguageOnly() is true.
boolean	useLocaleLanguageOnly()

Methods inherited from class java.lang.Object

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

Field Detail

MARK

public static final java.lang.String MARK

Prefix defining that the string is actually a key in a localized messages pack.

See Also:

Constant Field Values

MAIN_MARK

public static final java.lang.String MAIN_MARK

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

useLocaleLanguageOnly

protected volatile java.lang.Boolean useLocaleLanguageOnly

messages

@Inject
protected Messages messages

metadata

@Inject
protected Metadata metadata

extendedEntities

@Inject
protected ExtendedEntities extendedEntities

globalConfig

protected GlobalConfig globalConfig

Constructor Detail

MessageTools

@Inject
public MessageTools(Configuration configuration)

Method Detail

loadString

public java.lang.String loadString(java.lang.String ref)

Get localized message by reference provided in the full format.

Parameters:

ref - reference to message in the following format: msg://message_pack/message_id

Returns:

localized message or input string itself if it doesn't begin with msg://

loadString

public java.lang.String loadString(java.lang.String ref,
                                   java.util.Locale locale)

Get localized message by reference provided in the full format.

Parameters:

ref - reference to message in the following format: msg://message_pack/message_id

Returns:

localized message or input string itself if it doesn't begin with msg://

loadString

@Nullable
public java.lang.String loadString(@Nullable
                                             java.lang.String messagesPack,
                                             @Nullable
                                             java.lang.String ref)

Get localized message by reference provided in full or brief format.

Parameters:

messagesPack - messages pack to use if the second parameter is in brief format

ref - reference to message in the following format:

• Full: msg://message_pack/message_id
• Brief: msg://message_id, in this case the first parameter is taken into account
• Message from a main messages pack: mainMsg://message_id

Returns:

localized message or input string itself if it doesn't begin with msg:// or mainMsg://

loadString

@Nullable
public java.lang.String loadString(@Nullable
                                             java.lang.String messagesPack,
                                             @Nullable
                                             java.lang.String ref,
                                             @Nullable
                                             java.util.Locale locale)

Get localized message by reference provided in full or brief format.

Parameters:

messagesPack - messages pack to use if the second parameter is in brief format

ref - reference to message in the following format:

locale - locale

• Full: msg://message_pack/message_id
• Brief: msg://message_id, in this case the first parameter is taken into account
• Message from a main messages pack: mainMsg://message_id

Returns:

localized message or input string itself if it doesn't begin with msg:// or mainMsg://

getEntityCaption

public java.lang.String getEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass)

Returns:

a localized name of an entity. Messages pack must be located in the same package as entity.

getEntityCaption

public java.lang.String getEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass,
                                         @Nullable
                                         java.util.Locale locale)

Returns:

a localized name of an entity with given locale or default if null. Messages pack must be located in the same package as entity.

getDetailedEntityCaption

public java.lang.String getDetailedEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass)

Returns:

a detailed localized name of an entity. Messages pack must be located in the same package as entity.

getDetailedEntityCaption

public java.lang.String getDetailedEntityCaption(com.haulmont.chile.core.model.MetaClass metaClass,
                                                 @Nullable
                                                 java.util.Locale locale)

Returns:

a detailed localized name of an entity with given locale or default if null. Messages pack must be located in the same package as entity.

getPropertyCaption

public java.lang.String getPropertyCaption(com.haulmont.chile.core.model.MetaClass metaClass,
                                           java.lang.String propertyName)

Get localized name of an entity property. Messages pack must be located in the same package as entity.

Parameters:

metaClass - MetaClass containing the property

propertyName - property's name

Returns:

localized name

getPropertyCaption

public java.lang.String getPropertyCaption(com.haulmont.chile.core.model.MetaClass metaClass,
                                           java.lang.String propertyName,
                                           @Nullable
                                           java.util.Locale locale)

Get localized name of an entity property. Messages pack must be located in the same package as entity.

Parameters:

metaClass - MetaClass containing the property

propertyName - property's name

locale - locale, if value is null locale of current user is used

Returns:

localized name

getPropertyCaption

public java.lang.String getPropertyCaption(com.haulmont.chile.core.model.MetaProperty property)

Get localized name of an entity property. Messages pack must be located in the same package as entity.

Parameters:

property - MetaProperty

Returns:

localized name

getPropertyCaption

public java.lang.String getPropertyCaption(com.haulmont.chile.core.model.MetaProperty property,
                                           @Nullable
                                           java.util.Locale locale)

Get localized name of an entity property. Messages pack must be located in the same package as entity.

Parameters:

property - MetaProperty

locale - locale, if value is null locale of current user is used

Returns:

localized name

hasPropertyCaption

public boolean hasPropertyCaption(com.haulmont.chile.core.model.MetaProperty property)

Checks whether a localized name of the property exists.

Parameters:

property - MetaProperty

Returns:

true if getPropertyCaption(com.haulmont.chile.core.model.MetaProperty) returns a string which has no dots inside or the first part before a dot is not equal to the declaring class

getDefaultRequiredMessage

@Deprecated
public java.lang.String getDefaultRequiredMessage(com.haulmont.chile.core.model.MetaProperty metaProperty)

Deprecated. Use getDefaultRequiredMessage(MetaClass, String)

Returns:

default required message for specified property.

getDefaultRequiredMessage

public java.lang.String getDefaultRequiredMessage(com.haulmont.chile.core.model.MetaClass metaClass,
                                                  java.lang.String propertyName)

Get default required message for specified property of MetaClass.

Parameters:

metaClass - MetaClass containing the property

propertyName - property's name

Returns:

default required message for specified property of MetaClass

getNotNullMessage

protected java.lang.String getNotNullMessage(com.haulmont.chile.core.model.MetaProperty metaProperty)

Get default required message for specified property of MetaClass if it has NotNull annotation.

Parameters:

metaProperty - MetaProperty

Returns:

localized not null message

getMessageRef

public java.lang.String getMessageRef(com.haulmont.chile.core.model.MetaClass metaClass,
                                      java.lang.String propertyName)

Get message reference of an entity property. Messages pack part of the reference corresponds to the entity's package.

Parameters:

metaClass - MetaClass containing the property

propertyName - property's name

Returns:

message key in the form msg://message_pack/message_id

getMessageRef

public java.lang.String getMessageRef(com.haulmont.chile.core.model.MetaProperty property)

Get message reference of an entity property. Messages pack part of the reference corresponds to the entity's package.

Parameters:

property - MetaProperty

Returns:

message key in the form msg://message_pack/message_id

getLocValue

@Nullable
public java.lang.String getLocValue(java.lang.String attribute,
                                              com.haulmont.chile.core.model.Instance instance)

Get localized value of an attribute based on LocalizedValue annotation.

Parameters:

attribute - attribute name

instance - entity instance

Returns:

localized value or the value itself, if the value is null or the message pack can not be inferred

inferMessagePack

@Nullable
public java.lang.String inferMessagePack(java.lang.String attribute,
                                                   com.haulmont.chile.core.model.Instance instance)

Returns message pack inferred from LocalizedValue annotation.

Parameters:

attribute - attribute name

instance - entity instance

Returns:

inferred message pack or null

useLocaleLanguageOnly

public boolean useLocaleLanguageOnly()

Returns:

whether to use a full locale representation, or language only. Returns true if all locales listed in cuba.availableLocales app property are language only.

localeToString

public java.lang.String localeToString(java.util.Locale locale)

Locale representation depending on cuba.useLocaleLanguageOnly application property.

Parameters:

locale - locale instance

Returns:

language code if cuba.useLocaleLanguageOnly=true, or full locale representation otherwise

trimLocale

public java.util.Locale trimLocale(java.util.Locale locale)

Trims locale to language-only if useLocaleLanguageOnly() is true.

Parameters:

locale - a locale

Returns:

the locale with the same language and empty country and variant

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns:

first locale from the list defined in cuba.availableLocales app property, taking into account useLocaleLanguageOnly() return value.

getDefaultDateFormat

public java.lang.String getDefaultDateFormat(javax.persistence.TemporalType temporalType)

Parameters:

temporalType - a temporal type

Returns:

default date format string for passed temporal type