com.force.i18n.grammar

Class GrammaticalLabelSetFallbackImpl

java.lang.Object

com.force.i18n.settings.BasePropertyFile

com.force.i18n.LabelSetImpl

com.force.i18n.grammar.GrammaticalLabelSetImpl

com.force.i18n.grammar.GrammaticalLabelSetFallbackImpl

All Implemented Interfaces:

BaseNonConfigIniFile, NonConfigIniFile, GrammaticalLabelSet, GrammaticalLabelSet.GrammaticalLabelSetComposite, LabelSet, SharedLabelSet, Serializable

public final class GrammaticalLabelSetFallbackImpl
extends GrammaticalLabelSetImpl
implements GrammaticalLabelSet.GrammaticalLabelSetComposite

A GrammaticalLabel set that contains two different sets, one "main" set that, and a fallback set that can be used to retrieve labels that don't exist in the "main" set.

Author:

stamm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrammaticalLabelSetFallbackImpl.ImmutableMapUnion<K,V> Implementation of a MapUnion where there is a immutable overlay and a "backing" map.

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

Constructor and Description
GrammaticalLabelSetFallbackImpl(GrammaticalLabelSet main, GrammaticalLabelSet fallback)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowOtherGrammaticalForms()
protected Object	ask_inner_get(String section, String param, boolean throwSettingsSectionNotFoundException, boolean doLogFallback)
boolean	containsParam(String sectionName, String paramName)
LanguageDictionary	getDictionary()
GrammaticalLabelSet	getFallback()
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
GrammaticalLabelSet	getOverlay()
Set<String>	getPublicSectionNames()
protected Object	inner_get(String section, String param, boolean throwSettingsSectionNotFoundException) We need to resolve aliases here in the fallback, because delegating it won't allow overrides in the "main" set to be seen by the "fallback" set
protected Object	writeReplace() Use the serialization proxy for random noun forms (with a 7-ish byte cost) If you have a map, using SerializeMap below is *much* better

Methods inherited from class com.force.i18n.grammar.GrammaticalLabelSetImpl

get, get, getString, getString, getString, getString, getString, getString, getString, getStringThrow, getTestLabelSet, getTestLabelSet, resolveLabelRef, resolveLabelRef, setLabelSectionToFilename

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, containsSection, doSubstitutions, doSubstitutions, entrySet, get, getBoolean, getBoolean, getCensoredString, getFloat, getFloat, getInt, getInt, getLastModified, getList, getList, getListConfigValues, getNumListEntryParams, getParams, getParams, getSection, 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, get, getPropertyFileData, getString, getString, getString, getString, getString

Methods inherited from interface com.force.i18n.LabelSet

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, getString, getStringThrow

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

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

Constructor Detail

GrammaticalLabelSetFallbackImpl

public GrammaticalLabelSetFallbackImpl(GrammaticalLabelSet main,
                                       GrammaticalLabelSet fallback)

Method Detail

getOverlay

public GrammaticalLabelSet getOverlay()

Specified by:

getOverlay in interface GrammaticalLabelSet.GrammaticalLabelSetComposite

Returns:

the "overlay" label set on top of the fallback set

getFallback

public GrammaticalLabelSet getFallback()

Specified by:

getFallback in interface GrammaticalLabelSet.GrammaticalLabelSetComposite

Returns:

the "fallback" label set to provide values if they are missing from the overlay

inner_get

protected Object inner_get(String section,
                           String param,
                           boolean throwSettingsSectionNotFoundException)
                    throws SettingsSectionNotFoundException

We need to resolve aliases here in the fallback, because delegating it won't allow overrides in the "main" set to be seen by the "fallback" set

Overrides:

inner_get in class BasePropertyFile

Throws:

SettingsSectionNotFoundException

ask_inner_get

protected Object ask_inner_get(String section,
                               String param,
                               boolean throwSettingsSectionNotFoundException,
                               boolean doLogFallback)
                        throws SettingsSectionNotFoundException

Returns:

the object for the section and param in either the main or fallback, logging bad label feedback if necessary

Throws:

SettingsSectionNotFoundException

allowOtherGrammaticalForms

protected boolean allowOtherGrammaticalForms()

Overrides:

allowOtherGrammaticalForms in class GrammaticalLabelSetImpl

Returns:

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

getDictionary

public LanguageDictionary getDictionary()

Specified by:

getDictionary in interface GrammaticalLabelSet

Overrides:

getDictionary in class GrammaticalLabelSetImpl

Returns:

the dictionary associated with this label set

getPublicSectionNames

public Set<String> getPublicSectionNames()

Specified by:

getPublicSectionNames in interface GrammaticalLabelSet

Overrides:

getPublicSectionNames in class GrammaticalLabelSetImpl

Returns:

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

containsParam

public boolean containsParam(String sectionName,
                             String paramName)

Specified by:

containsParam in interface LabelSet

Overrides:

containsParam in class BasePropertyFile

Parameters:

sectionName - name of the section

paramName - key for the parameter

Returns:

true if the label set contains the given parameter

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

Overrides:

getGrammaticalTerm in class GrammaticalLabelSetImpl

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

writeReplace

protected final Object writeReplace()

Use the serialization proxy for random noun forms (with a 7-ish byte cost) If you have a map, using SerializeMap below is *much* better