com.foreach.common.spring.localization.text

Interface LocalizedTextSet

All Known Implementing Classes:

LocalizedTextSetImpl

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

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()

Method Detail

getApplication

String getApplication()

Returns:

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

getGroup

String getGroup()

Returns:

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

getItems

Collection<LocalizedText> getItems()

Returns:

All items in this set.

getText

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.

Parameters:

label - Label of the text item.

language - Language for which we want the value.

Returns:

Value as a string.

getText

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.

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

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.

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

boolean exists(String label)

Parameters:

label - Label of the item to search for.

Returns:

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

size

int size()

Returns:

Number of items (different label) in the set.

reload

void reload()

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