com.foreach.common.spring.localization.text

Interface LocalizedTextService

All Known Implementing Classes:

AbstractLocalizedTextService

public interface LocalizedTextService

Method Summary

Modifier and Type	Method and Description
void	deleteLocalizedText(LocalizedText text) Deletes a LocalizedText item from the backing datastore.
void	flagAsUsed(LocalizedText text) Flags a text item as used, this will also call a method on the DAO to flag the item in the data store.
List<String>	getApplications()
List<String>	getGroups(String application)
Map<String,String>	getLanguageMap(LocalizedTextSet localizedTextSet, Language language) Converts all LocalizedTexts in the provided language to a Map.
LocalizedText	getLocalizedText(String application, String group, String label) Gets a single LocalizedText item from the datastore.
List<LocalizedText>	getLocalizedTextItems(String application, String group) Gets a list of all LocalizedText items for a given group.
LocalizedTextSet	getLocalizedTextSet(String application, String group) Gets a LocalizedTextSetImpl for a group of items.
LocalizedText	saveDefaultText(String application, String group, String label, String defaultValue) Creates a new text item with default values.
void	saveLocalizedText(LocalizedText text) Saves a LocalizedText item in the backing datastore.
List<LocalizedText>	searchLocalizedTextItemsForText(String textToSearchFor) Gets a list of all LocalizedText items containing a string.

Method Detail

getLocalizedTextSet

LocalizedTextSet getLocalizedTextSet(String application,
                                     String group)

Gets a LocalizedTextSetImpl for a group of items.

Parameters:

application - Application to get the group of items from.

group - Name of the group.

Returns:

All items converted into a set instance.

getLocalizedTextItems

List<LocalizedText> getLocalizedTextItems(String application,
                                          String group)

Gets a list of all LocalizedText items for a given group.

Parameters:

application - Application to get the group of items from.

group - Name of the group.

Returns:

List of items.

searchLocalizedTextItemsForText

List<LocalizedText> searchLocalizedTextItemsForText(String textToSearchFor)

Gets a list of all LocalizedText items containing a string.

Parameters:

textToSearchFor - String with the text to search for.

Returns:

List of items.

flagAsUsed

void flagAsUsed(LocalizedText text)

Flags a text item as used, this will also call a method on the DAO to flag the item in the data store.

Parameters:

text - Text item that should be flagged as used.

saveDefaultText

LocalizedText saveDefaultText(String application,
                              String group,
                              String label,
                              String defaultValue)

Creates a new text item with default values. This will also execute an insert call on the DAO. Note that no exceptions are being thrown in case saving fails.

Parameters:

application - Application in which to create the text item.

group - Group the text item should belong to.

label - Label of the text item.

defaultValue - Default value to be set for the text.

Returns:

Constructed and saved text item.

getLocalizedText

LocalizedText getLocalizedText(String application,
                               String group,
                               String label)

Gets a single LocalizedText item from the datastore.

Parameters:

application - Application in which to find the text item.

group - Group the text item belongs to.

label - Label of the text item.

Returns:

Text item or null if not found.

saveLocalizedText

void saveLocalizedText(LocalizedText text)

Saves a LocalizedText item in the backing datastore. This will also trigger a reload of the cache for the set this item belongs to.

Parameters:

text - Text item to save.

deleteLocalizedText

void deleteLocalizedText(LocalizedText text)

Deletes a LocalizedText item from the backing datastore. This will also trigger a reload of the cache for the set this items belongs to.

Parameters:

text - Text item to delete.

getApplications

List<String> getApplications()

Returns:

All applications with text items..

getGroups

List<String> getGroups(String application)

Parameters:

application - Name of an application.

Returns:

List of text item groups for this application.

getLanguageMap

Map<String,String> getLanguageMap(LocalizedTextSet localizedTextSet,
                                  Language language)

Converts all LocalizedTexts in the provided language to a Map. The LocalizedTexts to be converted can be found in the given LocalizedTextSet.

Parameters:

localizedTextSet - The LocalizedTextSet to convert.

language - The language specifying which LocalizedTexts should be converted.

Returns:

The Map with the LocalizedTexts. The keys of the map are the labels of the LocalizedText and the value is the translation of that label in the given Language.