org.openmrs.messagesource.impl

Class CachedMessageSource

java.lang.Object

org.springframework.context.support.MessageSourceSupport

org.springframework.context.support.AbstractMessageSource

org.openmrs.messagesource.impl.CachedMessageSource

All Implemented Interfaces:

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

public class CachedMessageSource
extends org.springframework.context.support.AbstractMessageSource
implements MutableMessageSource

A MutableMessageSource backed by a localized map of PresentationMessageCollections, providing in-memory storage of PresentationMessages. Useful for temporary storage, as a cache for other sources, and for testing.

Field Summary

Fields inherited from class org.springframework.context.support.MessageSourceSupport

logger

Constructor Summary

Constructors

Constructor and Description
CachedMessageSource()

Method Summary

Modifier and Type	Method and Description
void	addPresentation(PresentationMessage message) Adds a presentation message to the source.
Collection<Locale>	getLocales() Gets the locales for which messages are available from this source.
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.
protected MessageFormat	resolveCode(String code, Locale locale)

Methods inherited from class org.springframework.context.support.AbstractMessageSource

getCommonMessages, getDefaultMessage, getDefaultMessage, getMessage, getMessage, getMessage, getMessageFromParent, getMessageInternal, getParentMessageSource, isUseCodeAsDefaultMessage, resolveArguments, resolveCodeWithoutArguments, setCommonMessages, setParentMessageSource, setUseCodeAsDefaultMessage

Methods inherited from class org.springframework.context.support.MessageSourceSupport

createMessageFormat, formatMessage, isAlwaysUseMessageFormat, renderDefaultMessage, setAlwaysUseMessageFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.HierarchicalMessageSource

getParentMessageSource, setParentMessageSource

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Constructor Detail

CachedMessageSource

public CachedMessageSource()

Method Detail

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

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

See Also:

Should should be able to contain multiple 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

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

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

See Also:

Should match get message with presentation message

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

See Also:

MutableMessageSource.getPresentationsInLocale(java.util.Locale)

resolveCode

protected MessageFormat resolveCode(String code,
                                    Locale locale)

Specified by:

resolveCode in class org.springframework.context.support.AbstractMessageSource

See Also:

AbstractMessageSource.resolveCode(java.lang.String, java.util.Locale)