com.foreach.common.spring.localization.text

Class AbstractLocalizedTextService

java.lang.Object

com.foreach.common.spring.localization.text.AbstractLocalizedTextService

All Implemented Interfaces:

LocalizedTextService

public abstract class AbstractLocalizedTextService
extends Object
implements LocalizedTextService

The AbstractLocalizedTextService is a basic implementation of the LocalizedTextService interface, providing all methods for lookup and creation of text items. It has a tight integration with the LocalizedTextSetImpl which provides an interface for quick text lookup in a collection of items.

The service requires a LocalizedTextDataStore implementation for access to the data store. There are also two optional properties: flaggingExecutorService and localizedTextSetCache.

The executorService is the ExecutorService that can be used to execute calls in the background. Calls to flagAsUsed(LocalizedText), saveLocalizedText(LocalizedText) and deleteLocalizedText(LocalizedText) will put additional calls on the ExecutorService (cache reloads and background updates). If no executorService is specified, all calls are executed synchronously.

The textSetCache is the LocalizedTextSetCache implementation that is used to cache all fetched LocalizedTextSet instances. Newly fetched instances will be stored in the cache and if an instance is found in the cache it will be returned directly without DAO interaction. See the EternalLocalizedTextSetCache for an implementation with eternal caching. By default no caching is being done.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLocalizedTextService(LocalizedTextDataStore localizedTextDao)

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.
void	setExecutorService(ExecutorService executorService)
void	setTextSetCache(LocalizedTextSetCache textSetCache)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected final org.apache.log4j.Logger LOG

Constructor Detail

AbstractLocalizedTextService

protected AbstractLocalizedTextService(LocalizedTextDataStore localizedTextDao)

Parameters:

localizedTextDao - DAO providing callback methods to the datastore.

Method Detail

setExecutorService

public final void setExecutorService(ExecutorService executorService)

Parameters:

executorService - The ExecutorService to use for the flagAsUsed(LocalizedText) calls.

setTextSetCache

public final void setTextSetCache(LocalizedTextSetCache textSetCache)

Parameters:

textSetCache - The LocalizedTextSetCache implementation to use for caching the textSet instances.

getLocalizedTextSet

public final LocalizedTextSet getLocalizedTextSet(String application,
                                                  String group)

Gets a LocalizedTextSetImpl for a group of items. Synchronizes access to the same application/group combination.

If the textSet is not found in the cache it will be fetched from the dataStore and stored in the cache. While this is happening, other threads trying to access the same textSet will wait.

Specified by:

getLocalizedTextSet in interface LocalizedTextService

Parameters:

application - Application to get the group of items from.

group - Name of the group.

Returns:

All items converted into a set instance.

getLocalizedTextItems

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

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

Specified by:

getLocalizedTextItems in interface LocalizedTextService

Parameters:

application - Application to get the group of items from.

group - Name of the group.

Returns:

List of items.

flagAsUsed

public final 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.

Specified by:

flagAsUsed in interface LocalizedTextService

Parameters:

text - Text item that should be flagged as used.

saveDefaultText

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

Creates a new text item with default values. If the item already exists in the datastore, the existing item will be returned instead. Otherwise this will also execute an insert call on the DAO. Note that no exceptions are being thrown in case saving fails. An ERROR message will be logged but the constructed text item will be returned.

Unlike a normal save or delete, this method will not trigger a cache reload for the text set the item belongs to. Because this method does a lookup first, it is assumed that other instances will fetch the recently created item and return it instead of trying to save twice. In that case fetching the single item is cheaper than reloading the entire set.

Specified by:

saveDefaultText in interface LocalizedTextService

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

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

Gets a single LocalizedText item from the datastore.

Specified by:

getLocalizedText in interface LocalizedTextService

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

public final 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.

Specified by:

saveLocalizedText in interface LocalizedTextService

Parameters:

text - Text item to save.

searchLocalizedTextItemsForText

public final List<LocalizedText> searchLocalizedTextItemsForText(String textToSearchFor)

Gets a list of all LocalizedText items containing a string.

Specified by:

searchLocalizedTextItemsForText in interface LocalizedTextService

Parameters:

textToSearchFor - String with the text to search for.

Returns:

List of items.

getApplications

public final List<String> getApplications()

Specified by:

getApplications in interface LocalizedTextService

Returns:

All applications with text items.

getGroups

public final List<String> getGroups(String application)

Specified by:

getGroups in interface LocalizedTextService

Parameters:

application - Name of an application.

Returns:

List of text item groups for this application.

deleteLocalizedText

public final 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.

Specified by:

deleteLocalizedText in interface LocalizedTextService

Parameters:

text - Text item to delete.

getLanguageMap

public final 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.

Specified by:

getLanguageMap in interface LocalizedTextService

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.