com.force.i18n.grammar

Class GrammaticalLabelSetImpl

java.lang.Object

com.force.i18n.settings.BasePropertyFile

com.force.i18n.LabelSetImpl

com.force.i18n.grammar.GrammaticalLabelSetImpl

All Implemented Interfaces:

BaseNonConfigIniFile, NonConfigIniFile, GrammaticalLabelSet, LabelSet, SharedLabelSet, Serializable

Direct Known Subclasses:

GrammaticalLabelSetFallbackImpl

public class GrammaticalLabelSetImpl
extends LabelSetImpl
implements GrammaticalLabelSet

A label set that uses a LabelDictionary to provide the ability to rename nouns and use more "generic" functionality.

Author:

yoikawa,stamm

See Also:

Serialized Form

Nested Class Summary

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

BasePropertyFile.MetaDataInfo, BasePropertyFile.Parser, BasePropertyFile.SubstitutionException

Nested classes/interfaces inherited from interface com.force.i18n.grammar.GrammaticalLabelSet

GrammaticalLabelSet.GrammaticalLabelSetComposite

Field Summary

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

data, lastModified, metaData, MISSING_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
	GrammaticalLabelSetImpl(LanguageDictionary dictionary, GrammaticalLabelFileParser p)
	GrammaticalLabelSetImpl(LanguageDictionary dictionary, GrammaticalLabelFileParser p, PropertyFileData data)
protected	GrammaticalLabelSetImpl(LanguageDictionary dictionary, PropertyFileData data, Map<String,String> labelSectionToFilename, Set<String> publicSections) Used by sleepy cat, or other implementations that already have the data specified preparsed

Method Summary

Modifier and Type	Method and Description
protected boolean	allowOtherGrammaticalForms()
Object	get(String section, String param, boolean allowLabelException) Override so that missing labels don't throw gacks, but are logged instead
Object	get(String section, String param, Object ifNull) Get the object stored in section/param in the IniFile.
LanguageDictionary	getDictionary()
GrammaticalTerm	getGrammaticalTerm(String section, String param) Test to see if the parameter contains *solely* a grammatical term, and if it does, return it, otherwise null
Set<String>	getPublicSectionNames()
String	getString(LabelReference ref)
String	getString(String section, Renameable[] entities, String param)
String	getString(String section, Renameable[] entities, String param, boolean forMessageFormat)
String	getString(String section, Renameable[] entities, String param, String ifNull)
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, boolean forMessageFormat)
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.
static GrammaticalLabelSet	getTestLabelSet(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor descriptor) Use this only for testing or various values.
static GrammaticalLabelSet	getTestLabelSet(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor descriptor, GrammaticalLabelSetProvider parent)
protected Object	resolveLabelRef(Object o)
protected Object	resolveLabelRef(Object o, String section, String param)
void	setLabelSectionToFilename(Map<String,String> sectionMap)

Methods inherited from class com.force.i18n.LabelSetImpl

get, getFilenameFromLabelSection, getLabelSectionToFilename, getPropertyFileData, labelExists, processMissingLabel

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

attachSharedKeyMap, containsListParam, containsParam, containsSection, doSubstitutions, doSubstitutions, entrySet, 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.grammar.GrammaticalLabelSet

get, getPropertyFileData

Methods inherited from interface com.force.i18n.LabelSet

containsParam, containsSection, getLabelSectionToFilename, getLastModified, getParams, getParams, sectionNames

Methods inherited from interface com.force.i18n.SharedLabelSet

labelExists

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, getBoolean, getCensoredString, getFloat, getInt, getList

Constructor Detail

GrammaticalLabelSetImpl

public GrammaticalLabelSetImpl(LanguageDictionary dictionary,
                               GrammaticalLabelFileParser p)
                        throws IOException

Parameters:

dictionary - the dictionary that was filled in by the parser

p - the parser

Throws:

IOException

GrammaticalLabelSetImpl

public GrammaticalLabelSetImpl(LanguageDictionary dictionary,
                               GrammaticalLabelFileParser p,
                               PropertyFileData data)
                        throws IOException

Parameters:

dictionary - the dictionary that was filled in by the parser

p - the parser

data - the data that contains the public section names

Throws:

IOException

GrammaticalLabelSetImpl

protected GrammaticalLabelSetImpl(LanguageDictionary dictionary,
                                  PropertyFileData data,
                                  Map<String,String> labelSectionToFilename,
                                  Set<String> publicSections)

Used by sleepy cat, or other implementations that already have the data specified preparsed

Parameters:

dictionary - the dictionary associated with this label set

data - the preloaded data

labelSectionToFilename - the labelSectionToFilename

publicSections - The set of sections to be constructed. Usually comes from the prebuilt english labels. We used to use data.getPublicSectionNames(), but when building the non english labels DB, that value is null.

Method Detail

getTestLabelSet

public static GrammaticalLabelSet getTestLabelSet(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor descriptor)
                                           throws IOException

Use this only for testing or various values. This doesn't do any caching, and it, ahem. Evil. However, we provide this capability to our localization team.

Parameters:

descriptor - the descriptor to use to create the test label set

Returns:

a test label set that can be used

Throws:

IOException

getTestLabelSet

public static GrammaticalLabelSet getTestLabelSet(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor descriptor,
                                                  GrammaticalLabelSetProvider parent)
                                           throws IOException

Throws:

IOException

allowOtherGrammaticalForms

protected boolean allowOtherGrammaticalForms()

Returns:

whether or not other grammatical forms should be allowed when formatting labels

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 LabelSetImpl

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

Specified by:

getString in interface GrammaticalLabelSet

Parameters:

ref - the label to look up

Returns:

the label contained in this label set for the given reference.

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 LabelSetImpl

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 LabelSetImpl

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.

getString

public String getString(String section,
                        Renameable[] entities,
                        String param)

Specified by:

getString in interface GrammaticalLabelSet

getString

public String getString(String section,
                        Renameable[] entities,
                        String param,
                        String ifNull)

Specified by:

getString in interface GrammaticalLabelSet

getString

public String getString(String section,
                        String param,
                        boolean forMessageFormat)

Specified by:

getString in interface GrammaticalLabelSet

getString

public String getString(String section,
                        Renameable[] entities,
                        String param,
                        boolean forMessageFormat)

Specified by:

getString in interface GrammaticalLabelSet

get

public Object get(String section,
                  String param,
                  boolean allowLabelException)
           throws ParameterNotFoundException,
                  SettingsSectionNotFoundException

Override so that missing labels don't throw gacks, but are logged instead

Specified by:

get in interface GrammaticalLabelSet

Overrides:

get in class BasePropertyFile

Parameters:

section - the section to search

param - the key inside that section

allowLabelException - if an exception should be thrown instead of null returned for a bad label

Returns:

the value in the label set for the given section and param, throwing an exception depending on the boolean value

Throws:

ParameterNotFoundException - if the parameter is missing

SettingsSectionNotFoundException - if the section is undefined

get

public Object get(String section,
                  String param,
                  Object ifNull)
           throws SettingsSectionNotFoundException

Description copied from interface: BaseNonConfigIniFile

Get the object stored in section/param in the IniFile.

Specified by:

get in interface BaseNonConfigIniFile

Overrides:

get in class BasePropertyFile

Parameters:

section - the section to look in.

param - the param name to look for.

ifNull - the object to return if no value was found.

Returns:

the object, or ifNull if none was found.

Throws:

SettingsSectionNotFoundException

setLabelSectionToFilename

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

Overrides:

setLabelSectionToFilename in class LabelSetImpl

resolveLabelRef

protected final Object resolveLabelRef(Object o)

resolveLabelRef

protected final Object resolveLabelRef(Object o,
                                       String section,
                                       String param)

getGrammaticalTerm

public GrammaticalTerm getGrammaticalTerm(String section,
                                          String param)

Description copied from interface: GrammaticalLabelSet

Test to see if the parameter contains *solely* a grammatical term, and if it does, return it, otherwise null

Specified by:

getGrammaticalTerm in interface GrammaticalLabelSet

Parameters:

section - the section to search

param - the parameter to search.

Returns:

the grammatical term that is the only value contained for the given label, or null if the label is anything else

getPublicSectionNames

public Set<String> getPublicSectionNames()

Specified by:

getPublicSectionNames in interface GrammaticalLabelSet

Returns:

the set of section names that are marked "public" in the label files

getDictionary

public LanguageDictionary getDictionary()

Specified by:

getDictionary in interface GrammaticalLabelSet

Returns:

the dictionary associated with this label set