io.jmix.core

Class MessageTools

java.lang.Object

io.jmix.core.MessageTools

@Component(value="core_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.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExtendedEntities	extendedEntities
static java.lang.String	MARK Prefix defining that the string is actually a key in a localized messages pack.
protected java.util.List<MessageResolver>	messageResolvers
protected Messages	messages
protected Metadata	metadata
protected MetadataTools	metadataTools
protected CoreProperties	properties

Constructor Summary

Constructors

Constructor and Description
MessageTools()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Locale>	getAvailableLocalesMap() Returns locales set in the jmix.core.available-locales property as a map of the locale display name to the locale object.
java.lang.String	getDefaultDateFormat(javax.persistence.TemporalType temporalType)
java.util.Locale	getDefaultLocale() Returns the first locale from the list defined in jmix.core.available-locales app property.
java.lang.String	getDefaultRequiredMessage(MetaClass metaClass, java.lang.String propertyName) Get default required message for specified property of MetaClass.
java.lang.String	getDetailedEntityCaption(MetaClass metaClass)
java.lang.String	getDetailedEntityCaption(MetaClass metaClass, java.util.Locale locale)
java.lang.String	getEntityCaption(MetaClass metaClass)
java.lang.String	getEntityCaption(MetaClass metaClass, java.util.Locale locale)
java.lang.String	getLocaleDisplayName(java.util.Locale locale) Returns display name of the given locale set in the message bundle with the localeDisplayName.<code> key.
java.lang.String	getMessageRef(MetaClass metaClass, java.lang.String propertyName) Get message reference of an entity property.
java.lang.String	getMessageRef(MetaProperty property) Get message reference of an entity property.
protected java.lang.String	getNotNullMessage(MetaProperty metaProperty) Get default required message for specified property of MetaClass if it has NotNull annotation.
java.lang.String	getPropertyCaption(MetaClass metaClass, java.lang.String propertyName) Get localized name of an entity property.
java.lang.String	getPropertyCaption(MetaClass metaClass, java.lang.String propertyName, java.util.Locale locale) Get localized name of an entity property.
java.lang.String	getPropertyCaption(MetaProperty property) Get localized name of an entity property.
java.lang.String	getPropertyCaption(MetaProperty property, java.util.Locale locale) Get localized name of an entity property.
boolean	isMessageKey(java.lang.String message)
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 group, java.lang.String ref) Get localized message by reference provided in full or brief format.
java.lang.String	loadString(java.lang.String group, java.lang.String ref, java.util.Locale locale) Get localized message by reference provided in full or brief format.

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

messages

@Autowired
protected Messages messages

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

extendedEntities

@Autowired
protected ExtendedEntities extendedEntities

properties

@Autowired
protected CoreProperties properties

messageResolvers

@Autowired(required=false)
protected java.util.List<MessageResolver> messageResolvers

Constructor Detail

MessageTools

public MessageTools()

Method Detail

loadString

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

Get localized message by reference provided in the full format.

Parameters:

ref - reference to message in the following format: msg://group/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://group/message_id

Returns:

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

loadString

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

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

Parameters:

group - message group to use if the second parameter is in brief format

ref - reference to message in the following format:

• Full: msg://group/message_id
• Brief: msg://message_id, in this case the first parameter is taken into account

Returns:

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

loadString

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

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

Parameters:

group - message group to use if the second parameter is in brief format

ref - reference to message in the following format:

locale - locale

• Full: msg://group/message_id
• Brief: msg://message_id, in this case the first parameter is taken into account

Returns:

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

getEntityCaption

public java.lang.String getEntityCaption(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(MetaClass metaClass,
                                         @Nullable
                                         java.util.Locale locale)

Returns:

a localized name of an entity with given locale or default if null

getDetailedEntityCaption

public java.lang.String getDetailedEntityCaption(MetaClass metaClass)

Returns:

a detailed localized name of an entity

getDetailedEntityCaption

public java.lang.String getDetailedEntityCaption(MetaClass metaClass,
                                                 @Nullable
                                                 java.util.Locale locale)

Returns:

a detailed localized name of an entity with given locale or default if null

getPropertyCaption

public java.lang.String getPropertyCaption(MetaClass metaClass,
                                           java.lang.String propertyName)

Get localized name of an entity property.

Parameters:

metaClass - MetaClass containing the property

propertyName - property's name

Returns:

localized name

getPropertyCaption

public java.lang.String getPropertyCaption(MetaClass metaClass,
                                           java.lang.String propertyName,
                                           @Nullable
                                           java.util.Locale locale)

Get localized name of an entity property.

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(MetaProperty property)

Get localized name of an entity property.

Parameters:

property - MetaProperty

Returns:

localized name

getPropertyCaption

public java.lang.String getPropertyCaption(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

getDefaultRequiredMessage

public java.lang.String getDefaultRequiredMessage(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

@Nullable
protected java.lang.String getNotNullMessage(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(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(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

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns the first locale from the list defined in jmix.core.available-locales app property.

getLocaleDisplayName

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

Returns display name of the given locale set in the message bundle with the localeDisplayName.<code> key. If such message is not defined, returns Locale.getDisplayName().

getAvailableLocalesMap

public java.util.Map<java.lang.String,java.util.Locale> getAvailableLocalesMap()

Returns locales set in the jmix.core.available-locales property as a map of the locale display name to the locale object.

getDefaultDateFormat

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

Parameters:

temporalType - a temporal type

Returns:

default date format string for passed temporal type

isMessageKey

public boolean isMessageKey(@Nullable
                            java.lang.String message)

Parameters:

message - a message to check

Returns:

whether the given message is a key in a localized messages pack