com.force.i18n

Class LabelSetImpl

java.lang.Object

com.force.i18n.settings.BasePropertyFile

com.force.i18n.LabelSetImpl

All Implemented Interfaces:

BaseNonConfigIniFile, NonConfigIniFile, LabelSet, SharedLabelSet, Serializable

Direct Known Subclasses:

GrammaticalLabelSetImpl

public class LabelSetImpl
extends BasePropertyFile
implements LabelSet

Set of label definitions that do not require grammatical correctness. This can be used for various localization files.

Labels are stored in a one or more XML files as defined by a LabelSetDescriptor.

A LabelSet is created/loaded by the GrammaticalLabelSetLoader

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.force.i18n.settings.BasePropertyFile

BasePropertyFile.MetaDataInfo, BasePropertyFile.Parser, BasePropertyFile.SubstitutionException

Field Summary

Fields inherited from class com.force.i18n.settings.BasePropertyFile

data, lastModified, metaData, MISSING_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
	LabelSetImpl(BasePropertyFile.Parser p)
	LabelSetImpl(BasePropertyFile.Parser p, PropertyFileData data)
protected	LabelSetImpl(PropertyFileData data, Map<String,String> labelSectionToFilename) Construct a label set from the given data and optional labelSectionToFileName

Method Summary

Modifier and Type	Method and Description
Object	get(LabelReference reference)
String	getFilenameFromLabelSection(String sectionName)
Map<String,String>	getLabelSectionToFilename()
PropertyFileData	getPropertyFileData()
String	getString(String section, String param) Get the value stored in section/param in the IniFile as a string.
String	getString(String section, String param, String ifNull) Get the value stored in section/param in the IniFile as a string.
String	getStringThrow(String section, String param) Get the value stored in section/param in the IniFile as a string.
boolean	labelExists(String section, String param)
String	processMissingLabel(String message, boolean allowLabelException) Will either throw an exception or send an error depending on whether we are in production / test running more or note.
protected void	setLabelSectionToFilename(Map<String,String> sectionMap)

Methods inherited from class com.force.i18n.settings.BasePropertyFile

attachSharedKeyMap, containsListParam, containsParam, containsSection, doSubstitutions, doSubstitutions, entrySet, get, get, get, getBoolean, getBoolean, getCensoredString, getFloat, getFloat, getInt, getInt, getLastModified, getList, getList, getListConfigValues, getNumListEntryParams, getParams, getParams, getSection, inner_get, isProductionMode, makeListEntryParam, outputValueXML, outputValueXMLCensored, outputXML, outputXML, put, remove, removeSection, sectionNames, setLastModified, stringToBoolean, substitute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.force.i18n.LabelSet

containsParam, containsSection, getLastModified, getParams, getParams, sectionNames

Methods inherited from interface com.force.i18n.commons.util.settings.NonConfigIniFile

get, getBoolean, getFloat, getInt, getList, getSection

Methods inherited from interface com.force.i18n.commons.util.settings.BaseNonConfigIniFile

entrySet, get, getBoolean, getCensoredString, getFloat, getInt, getList

Constructor Detail

LabelSetImpl

protected LabelSetImpl(PropertyFileData data,
                       Map<String,String> labelSectionToFilename)

Construct a label set from the given data and optional labelSectionToFileName

Parameters:

data - the data

labelSectionToFilename - the map from label section to filename (not super useful)

LabelSetImpl

public LabelSetImpl(BasePropertyFile.Parser p)
             throws IOException

Throws:

IOException

LabelSetImpl

public LabelSetImpl(BasePropertyFile.Parser p,
                    PropertyFileData data)
             throws IOException

Throws:

IOException

Method Detail

getLabelSectionToFilename

public Map<String,String> getLabelSectionToFilename()

Specified by:

getLabelSectionToFilename in interface LabelSet

Returns:

the mapping from label section to file name, if it exists, otherwise null

labelExists

public boolean labelExists(String section,
                           String param)

Specified by:

labelExists in interface SharedLabelSet

getString

public String getString(String section,
                        String param)

Description copied from interface: NonConfigIniFile

Get the value stored in section/param in the IniFile as a string. Will return null if it was not found.

Specified by:

getString in interface NonConfigIniFile

Overrides:

getString in class BasePropertyFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the String value of the given section/param, or null.

getStringThrow

public String getStringThrow(String section,
                             String param)

Description copied from interface: NonConfigIniFile

Get the value stored in section/param in the IniFile as a string. Will throw exception if not found

Specified by:

getStringThrow in interface NonConfigIniFile

Overrides:

getStringThrow in class BasePropertyFile

Parameters:

section - the section to look in.

param - the param name to look for.

Returns:

the String value of the given section/param, or null.

getString

public String getString(String section,
                        String param,
                        String ifNull)

Description copied from interface: BaseNonConfigIniFile

Get the value stored in section/param in the IniFile as a string.

Specified by:

getString in interface BaseNonConfigIniFile

Overrides:

getString in class BasePropertyFile

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the default value to use.

Returns:

the String value of the given section/param, or ifNull.

get

public Object get(LabelReference reference)

getPropertyFileData

public PropertyFileData getPropertyFileData()

Overrides:

getPropertyFileData in class BasePropertyFile

getFilenameFromLabelSection

public String getFilenameFromLabelSection(String sectionName)

setLabelSectionToFilename

protected void setLabelSectionToFilename(Map<String,String> sectionMap)

processMissingLabel

public String processMissingLabel(String message,
                                  boolean allowLabelException)
                           throws ParameterNotFoundException

Will either throw an exception or send an error depending on whether we are in production / test running more or note. TODO : LabelUtils.java also has a processMissingLabel() method used by other classes. We should have this method just depend on Config.isProduction() and merge the two methods together

Parameters:

message - the message to return as the label

allowLabelException - - true to always throw an exception for a missing label

Throws:

ParameterNotFoundException - if label exception is allowed