com.foreach.common.spring.localization.text

Class LocalizedTextSetImpl

java.lang.Object

com.foreach.common.spring.localization.text.LocalizedTextSetImpl

All Implemented Interfaces:

LocalizedTextSet

public class LocalizedTextSetImpl
extends Object
implements LocalizedTextSet

LocalizedTextSet is a collection of LocalizedText instances scoped to a particular group. It is a special structure to be used for:

• looking up text in the collection
• creating fields with default values if they do not yet exist
• setting a field as autogenerated upon creation or used upon first call

A LocalizedTextSet is hooked to a LocalizedTextService that should provide the actual implementation of the LocalizedText backend. Things like creating default values, saving in database, etc.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalizedTextSetImpl(String application, String group, LocalizedTextService localizedTextService) Constructs a new LocalizedTextSet based on a collection of items.

Method Summary

Modifier and Type	Method and Description
boolean	exists(String label)
String	getApplication()
String	getGroup()
Collection<LocalizedText>	getItems()
String	getText(String label, Language language) Returns the value for a specific language of a text item.
String	getText(String label, Language language, String defaultValue) Returns the value for a specific language of a text item.
String	getText(String label, Language language, String defaultValue, boolean storeDefault) Returns the value for a specific language of a text item.
void	reload() Reloads all items in this set from the backing data store.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizedTextSetImpl

protected LocalizedTextSetImpl(String application,
                               String group,
                               LocalizedTextService localizedTextService)

Constructs a new LocalizedTextSet based on a collection of items. The collection may contain duplicates but in case of multiples the item with the highest index in the collection will be retained.

Parameters:

application - Name of the application that new items in this set should be created in.

group - Name of the group that new items in this set should be created in.

localizedTextService - Service owning this set, where callbacks will occur based on set modifications.

Method Detail

getApplication

public final String getApplication()

Specified by:

getApplication in interface LocalizedTextSet

Returns:

The application this set belongs to, new items in this set will be created in this application.

getGroup

public final String getGroup()

Specified by:

getGroup in interface LocalizedTextSet

Returns:

The group this set represents, new items in this set will be created in this group.

getItems

public final Collection<LocalizedText> getItems()

Specified by:

getItems in interface LocalizedTextSet

Returns:

All items in this set.

getText

public final String getText(String label,
                            Language language)

Returns the value for a specific language of a text item. If the text item is found and it is the first time it has been requested (based on the Used property of LocalizedText), this method will trigger a flagAsUsed call on the LocalizedTextService provided.

Specified by:

getText in interface LocalizedTextSet

Parameters:

label - Label of the text item.

language - Language for which we want the value.

Returns:

Value as a string.

getText

public final String getText(String label,
                            Language language,
                            String defaultValue)

Returns the value for a specific language of a text item. If the text item is found and it is the first time it has been requested (based on the Used property of LocalizedText), this method will trigger a flagAsUsed call on the LocalizedTextService provided.

Specified by:

getText in interface LocalizedTextSet

Parameters:

label - Label of the text item.

language - Language for which we want the value.

defaultValue - Value to return in case the text item does not yet exist.

Returns:

Value as a string.

getText

public String getText(String label,
                      Language language,
                      String defaultValue,
                      boolean storeDefault)

Returns the value for a specific language of a text item. If the text item is found and it is the first time it has been requested (based on the Used property of LocalizedText), this method will trigger a flagAsUsed call on the LocalizedTextService provided.

Specified by:

getText in interface LocalizedTextSet

Parameters:

label - Label of the text item.

language - Language for which we want the value.

defaultValue - Value to return in case the text item does not yet exist.

storeDefault - Whether the default value should be stored when not found.

Returns:

Value as a string.

exists

public final boolean exists(String label)

Specified by:

exists in interface LocalizedTextSet

Parameters:

label - Label of the item to search for.

Returns:

True if the item exists in this set, false if not.

size

public final int size()

Specified by:

size in interface LocalizedTextSet

Returns:

Number of items (different label) in the set.

reload

public final void reload()

Reloads all items in this set from the backing data store.

Specified by:

reload in interface LocalizedTextSet