Package io.goobi.viewer.model.translations.admin

Class MessageEntry

java.lang.Object

io.goobi.viewer.model.translations.admin.MessageEntry

All Implemented Interfaces:

Comparable<MessageEntry>

public class MessageEntry
extends Object
implements Comparable<MessageEntry>

A single message key with all its available translations for admin backend editing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessageEntry.TranslationStatus	Represents the completeness of translations for a MessageEntry across all configured locales.

Constructor Summary

Constructors

Constructor	Description
MessageEntry(String keyPrefix, String keySuffix, List<MessageValue> values)	Constructor with a composite key.
MessageEntry(String key, List<MessageValue> values)

Method Summary

Modifier and Type	Method	Description
int	compareTo(MessageEntry o)
static MessageEntry	create(String keyPrefix, String keySuffix, List<Locale> allLocales)	Factory method that creates a MessageEntry instance with values initialized for all given locales.
boolean	equals(Object obj)
String	getKey()
String	getKeyPrefix()
String	getKeySuffix()
MessageEntry.TranslationStatus	getTranslationStatus()	Returns the translation status over all languages.
MessageEntry.TranslationStatus	getTranslationStatusForLanguage(String language)	Returns the translation status for the requested language.
List<MessageValue>	getValues()
int	hashCode()
boolean	isKeySuffixBlank()
boolean	isNewEntryMode()
void	setKeyPrefix(String keyPrefix)
void	setKeySuffix(String keySuffix)
void	setNewEntryMode(boolean newEntryMode)

Methods inherited from class java.lang.Object

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

Constructor Details

MessageEntry

public MessageEntry(String key,
 List<MessageValue> values)

Parameters:

key - the full message key

values - list of translated values for this entry

MessageEntry

public MessageEntry(String keyPrefix,
 String keySuffix,
 List<MessageValue> values)

Constructor with a composite key.

Parameters:

keyPrefix - prefix part of the composite message key

keySuffix - suffix part of the composite message key

values - list of translated values for this entry

Method Details

create

public static MessageEntry create(String keyPrefix,
 String keySuffix,
 List<Locale> allLocales)
                           throws IllegalArgumentException

Factory method that creates a MessageEntry instance with values initialized for all given locales.

Parameters:

keyPrefix - Message key prefix (optional)

keySuffix - Message key suffix (or entire key if no prefix)

allLocales - List of locales

Returns:

new MessageEntry

Throws:

IllegalArgumentException - if keySuffix or allLocales is null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(MessageEntry o)

Specified by:

compareTo in interface Comparable<MessageEntry>

getTranslationStatus

public MessageEntry.TranslationStatus getTranslationStatus()

Returns the translation status over all languages.

Returns:

appropriate MessageEntry.TranslationStatus

getTranslationStatusForLanguage

public MessageEntry.TranslationStatus getTranslationStatusForLanguage(String language)

Returns the translation status for the requested language.

Parameters:

language - Requested language

Returns:

appropriate MessageEntry.TranslationStatus

getKey

public String getKey()

Returns:

the full message key composed of prefix and trimmed suffix

getKeyPrefix

public String getKeyPrefix()

setKeyPrefix

public void setKeyPrefix(String keyPrefix)

getKeySuffix

public String getKeySuffix()

setKeySuffix

public void setKeySuffix(String keySuffix)

isKeySuffixBlank

public boolean isKeySuffixBlank()

Returns:

true if keySuffix blank; false otherwise

getValues

public List<MessageValue> getValues()

isNewEntryMode

public boolean isNewEntryMode()

setNewEntryMode

public void setNewEntryMode(boolean newEntryMode)