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

Class TranslationGroupItem

java.lang.Object

io.goobi.viewer.model.translations.admin.TranslationGroupItem

Direct Known Subclasses:

CoreMessagesTranslationGroupItem, LocalMessagesTranslationGroupItem, SolrFieldNameTranslationGroupItem, SolrFieldValueTranslationGroupItem

public abstract class TranslationGroupItem
extends Object

A single element as part of a translation group.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<MessageEntry>	entries
protected final String	key	A single message key or a regular expression for multiple message keys.
protected final boolean	regex	If true, key will contain a regular expression.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TranslationGroupItem(String key, boolean regex)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
static TranslationGroupItem	create(TranslationGroup.TranslationGroupType type, String key, boolean regex)	Factory method.
protected void	createMessageKeyStatusMap(List<String> keys)	Checks the translation status for each of the given keys and populates messageKeys accordingly.
List<MessageEntry>	getEntries()
String	getKey()
MessageEntry.TranslationStatus	getTranslationStatus()	Returns the translation status over all existing entries.
MessageEntry.TranslationStatus	getTranslationStatusLanguage(String language)	Returns the translation status for the requested language over all existing entries.
boolean	isRegex()
protected abstract void	loadEntries()	Populates the message key map by first loading the appropriate keys and then calling createMessageKeyStatusMap.

Methods inherited from class java.lang.Object

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

Field Details

key

protected final String key

A single message key or a regular expression for multiple message keys.

regex

protected final boolean regex

If true, key will contain a regular expression.

entries

protected List<MessageEntry> entries

Constructor Details

TranslationGroupItem

protected TranslationGroupItem(String key,
 boolean regex)

Protected constructor.

Parameters:

key -

regex -

Method Details

create

public static TranslationGroupItem create(TranslationGroup.TranslationGroupType type,
 String key,
 boolean regex)

Factory method.

Parameters:

type -

key -

regex -

Returns:

Created TranslationGroupItem

getTranslationStatus

public MessageEntry.TranslationStatus getTranslationStatus()
                                                    throws IndexUnreachableException,
PresentationException

Returns the translation status over all existing entries.

Returns:

TranslationStatu; FULL if all entries are FULL; NONE if all entries are NONE; PARTIAL otherwise

Throws:

PresentationException

IndexUnreachableException

getTranslationStatusLanguage

public MessageEntry.TranslationStatus getTranslationStatusLanguage(String language)
                                                            throws IndexUnreachableException,
PresentationException

Returns the translation status for the requested language over all existing entries.

Parameters:

language - Requested language

Returns:

TranslationStatu; FULL if all entries are FULL; NONE if all entries are NONE; PARTIAL otherwise

Throws:

PresentationException

IndexUnreachableException

Exception

getKey

public String getKey()

Returns:

the key

isRegex

public boolean isRegex()

Returns:

the regex

getEntries

public List<MessageEntry> getEntries()
                              throws IndexUnreachableException,
PresentationException

Returns:

the messageKeys

Throws:

IndexUnreachableException

PresentationException

Exception

loadEntries

protected abstract void loadEntries()
                             throws IndexUnreachableException,
PresentationException

Populates the message key map by first loading the appropriate keys and then calling createMessageKeyStatusMap. Each subclass will have its specific data source, so each subclass must implement this method.

Throws:

IndexUnreachableException

PresentationException

createMessageKeyStatusMap

protected void createMessageKeyStatusMap(List<String> keys)

Checks the translation status for each of the given keys and populates messageKeys accordingly.

Parameters:

keys -