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

Class TranslationGroup

java.lang.Object
io.goobi.viewer.model.translations.admin.TranslationGroup
public final class TranslationGroup extends Object
Groups a set of translatable message keys of the same category for display and editing in the admin backend.

Each group has a TranslationGroup.TranslationGroupType that determines how its entries are loaded (e.g. from Solr field names, Solr field values, or message property files), along with a name, description, and a list of TranslationGroupItem patterns that define which keys belong to the group.

  • Method Details

    • create

      public static TranslationGroup create(int id, TranslationGroup.TranslationGroupType type, String name, String description, int numItems)
      Factory method.
      Parameters:
      id - unique ID number
      type - the type of this translation group
      name - display name of this group
      description - human-readable description of this group
      numItems - initial capacity for the items list
      Returns:
      Created TranslationGroup

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • findEntryByMessageKey

      public boolean findEntryByMessageKey(String key)
      Parameters:
      key - Message key to find
      Returns:
      true if message entry was found or added; false if no matching group item could be found

    • getId

      public int getId()

    • getType

      public TranslationGroup.TranslationGroupType getType()

    • getName

      public String getName()

    • getDescription

      public String getDescription()

    • getItems

      public List<TranslationGroupItem> getItems()

    • getEntryCount

      public int getEntryCount()
      Returns:
      Number of unique message keys across all groups

    • getUntranslatedEntryCount

      public Integer getUntranslatedEntryCount()
      Returns:
      Number of entries with no translations at all

    • getPartiallyTranslatedEntryCount

      public Integer getPartiallyTranslatedEntryCount()
      Returns the number of entries which finished (non-zzz) translations for at least one but less than all languages.
      Returns:
      Number of partially translated entries

    • getFullyTranslatedEntryCount

      public Integer getFullyTranslatedEntryCount()
      Returns the number of entries which finished (non-zzz) translations for all languages.
      Returns:
      Number of fully translated entries

    • getUntranslatedEntryCountPercentage

      public double getUntranslatedEntryCountPercentage()
      Returns:
      Percentage represented by untranslated entries

    • getPartiallyTranslatedEntryCountPercentage

      public double getPartiallyTranslatedEntryCountPercentage()
      Returns:
      Percentage represented by partially translated entries

    • getFullyTranslatedEntryCountPercentage

      public double getFullyTranslatedEntryCountPercentage()
      Returns:
      Percentage represented by fully translated entries

    • isFullyTranslated

      public boolean isFullyTranslated()
      Returns:
      true if all entries are fully translated; false otherwise

    • isAllFilteredEntriesFullyTranslated

      public boolean isAllFilteredEntriesFullyTranslated()
      Returns:
      true if all entries in the filtered list are fully translated; false otherwise

    • isHasEntries

      public boolean isHasEntries()
      Returns:
      true if the allEntries list for this group is not empty; false otherwise

    • getFilteredEntries

      public List<MessageEntry> getFilteredEntries()
      Returns:
      List

    • getAllEntries

      public List<MessageEntry> getAllEntries()
      Returns:
      Unique message keys across all groups

    • getSelectedEntry

      public MessageEntry getSelectedEntry()

    • setSelectedEntry

      public void setSelectedEntry(MessageEntry selectedEntry)

    • resetSelectedEntry

      public void resetSelectedEntry()
      Sets selectedEntry to null without prior saving.

    • getSelectedEntryIndex

      public int getSelectedEntryIndex()

    • setSelectedEntryIndex

      public void setSelectedEntryIndex(int selectedEntryIndex)

    • getFilterString

      public String getFilterString()

    • setFilterString

      public void setFilterString(String filterString)

    • isLoadError

      public boolean isLoadError()

    • setLoadError

      public void setLoadError(boolean loadError)

    • isNewEntryMode

      public boolean isNewEntryMode()

    • setNewEntryMode

      public void setNewEntryMode(boolean newEntryMode)

    • prevEntry

      public void prevEntry()
      Sets the previous MessageEntry element in the list active.

    • nextEntry

      public void nextEntry()
      Sets the next MessageEntry element in the list active.

    • saveSelectedEntry

      public void saveSelectedEntry()
      Persists the edited values of selectedEntry to all language messages.properties files.

    • isHasFileAccess

      public static boolean isHasFileAccess()
      Check whether the application has write access to all local messages files as well as the containing folder if any languages have no local message file. The tested languages are taken from ViewerResourceBundle.getAllLocales()
      Returns:
      true if all required access rights to edit messages are present. false otherwise

    • resetStatusCount

      public void resetStatusCount()
      Resets the counts for fully translated and untranslated entries to update the translation process.