org.openmrs.messagesource.impl

Class DefaultMessageSourceServiceImpl

java.lang.Object

org.openmrs.messagesource.impl.DefaultMessageSourceServiceImpl

All Implemented Interfaces:

MessageSourceService, MutableMessageSource, org.springframework.context.HierarchicalMessageSource, org.springframework.context.MessageSource

public class DefaultMessageSourceServiceImpl
extends Object
implements MessageSourceService

Loads messages from the default message properties file before spring starts up

Method Summary

Modifier and Type	Method and Description
void	addPresentation(PresentationMessage message) Adds a presentation message to the source.
MutableMessageSource	getActiveMessageSource() Gets the message source service which is currently providing services.
static DefaultMessageSourceServiceImpl	getInstance() Get the static/singular instance
Collection<Locale>	getLocales() Gets the locales for which messages are available from this source.
String	getMessage(org.springframework.context.MessageSourceResolvable resolvable, Locale locale)
String	getMessage(String s) Get the message with the given code from the current user's selected locale.
String	getMessage(String code, Object[] args, Locale locale)
String	getMessage(String code, Object[] args, String defaultMessage, Locale locale)
Set<MutableMessageSource>	getMessageSources()
org.springframework.context.MessageSource	getParentMessageSource()
PresentationMessage	getPresentation(String key, Locale forLocale) Gets the PresentationMessage for a particular locale.
Collection<PresentationMessage>	getPresentations() Gets all of the available messages, packaged as PresentationMessages.
Collection<PresentationMessage>	getPresentationsInLocale(Locale locale) Gets alll the available messages in a particular locale, packaged as PresentationMessages.
void	merge(MutableMessageSource fromSource, boolean overwrite) Merge messages from another source into this source.
void	removePresentation(PresentationMessage message) Removes a presentation message from the source.
void	setActiveMessageSource(MutableMessageSource activeMessageSource) Sets the message source service which will actually provide services.
void	setMessageSources(Set<MutableMessageSource> availableMessageSources)
void	setParentMessageSource(org.springframework.context.MessageSource parent)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DefaultMessageSourceServiceImpl getInstance()

Get the static/singular instance

Returns:

DefaultMessageSourceServiceImpl

getMessage

public String getMessage(String code,
                         Object[] args,
                         String defaultMessage,
                         Locale locale)

Specified by:

getMessage in interface org.springframework.context.MessageSource

getMessage

public String getMessage(String code,
                         Object[] args,
                         Locale locale)
                  throws org.springframework.context.NoSuchMessageException

Specified by:

getMessage in interface org.springframework.context.MessageSource

Throws:

org.springframework.context.NoSuchMessageException

getMessage

public String getMessage(String s)

Description copied from interface: MessageSourceService

Get the message with the given code from the current user's selected locale.

Specified by:

getMessage in interface MessageSourceService

Parameters:

s - message code to retrieve

Returns:

the translated message

See Also:

MessageSource.getMessage(String arg0, Object[] arg1, java.util.Locale arg2)

getLocales

public Collection<Locale> getLocales()

Description copied from interface: MutableMessageSource

Gets the locales for which messages are available from this source.

Specified by:

getLocales in interface MutableMessageSource

Returns:

available message locales

getPresentations

public Collection<PresentationMessage> getPresentations()

Description copied from interface: MutableMessageSource

Gets all of the available messages, packaged as PresentationMessages.

Specified by:

getPresentations in interface MutableMessageSource

Returns:

collection of presentation messages

getPresentationsInLocale

public Collection<PresentationMessage> getPresentationsInLocale(Locale locale)

Description copied from interface: MutableMessageSource

Gets alll the available messages in a particular locale, packaged as PresentationMessages.

Specified by:

getPresentationsInLocale in interface MutableMessageSource

Parameters:

locale - locale for which to get the messages

Returns:

collection of PresentationMessages in the locale

addPresentation

public void addPresentation(PresentationMessage message)

Description copied from interface: MutableMessageSource

Adds a presentation message to the source. This operation should overwrite any existing message which conflicts (has the same code and locale).

Specified by:

addPresentation in interface MutableMessageSource

Parameters:

message - message to add to the source

getPresentation

public PresentationMessage getPresentation(String key,
                                           Locale forLocale)

Description copied from interface: MutableMessageSource

Gets the PresentationMessage for a particular locale.

Specified by:

getPresentation in interface MutableMessageSource

Parameters:

key - textual key for the message

forLocale - locale for which to get the message

Returns:

corresponding PresentationMessage, or null if not available

removePresentation

public void removePresentation(PresentationMessage message)

Description copied from interface: MutableMessageSource

Removes a presentation message from the source.

Specified by:

removePresentation in interface MutableMessageSource

Parameters:

message - the message to remove

merge

public void merge(MutableMessageSource fromSource,
                  boolean overwrite)

Description copied from interface: MutableMessageSource

Merge messages from another source into this source.

Specified by:

merge in interface MutableMessageSource

Parameters:

fromSource - message source from which messages should be merge

overwrite - whether to overwrite existing messages

getMessage

public String getMessage(org.springframework.context.MessageSourceResolvable resolvable,
                         Locale locale)
                  throws org.springframework.context.NoSuchMessageException

Specified by:

getMessage in interface org.springframework.context.MessageSource

Throws:

org.springframework.context.NoSuchMessageException

setParentMessageSource

public void setParentMessageSource(org.springframework.context.MessageSource parent)

Specified by:

setParentMessageSource in interface org.springframework.context.HierarchicalMessageSource

getParentMessageSource

public org.springframework.context.MessageSource getParentMessageSource()

Specified by:

getParentMessageSource in interface org.springframework.context.HierarchicalMessageSource

getActiveMessageSource

public MutableMessageSource getActiveMessageSource()

Description copied from interface: MessageSourceService

Gets the message source service which is currently providing services.

Specified by:

getActiveMessageSource in interface MessageSourceService

Returns:

the activeMessageSource

setActiveMessageSource

public void setActiveMessageSource(MutableMessageSource activeMessageSource)

Description copied from interface: MessageSourceService

Sets the message source service which will actually provide services.

Specified by:

setActiveMessageSource in interface MessageSourceService

Parameters:

activeMessageSource - the MutableMessageSource to set

getMessageSources

public Set<MutableMessageSource> getMessageSources()

Specified by:

getMessageSources in interface MessageSourceService

Returns:

the availableMessageSources

setMessageSources

public void setMessageSources(Set<MutableMessageSource> availableMessageSources)

Specified by:

setMessageSources in interface MessageSourceService

Parameters:

availableMessageSources - the availableMessageSources to set