com.force.i18n.grammar

Class LanguageDictionary

java.lang.Object

com.force.i18n.grammar.LanguageDictionary

All Implemented Interfaces:

Serializable

public final class LanguageDictionary
extends Object
implements Serializable

The base class of new label set for a language. This class is constructed by LabelSet so each language would share the same instance of LabelInfo through the application. This class does: - Construct and keep all generic entity names, nouns (includes "compound noun") and modifier. - format array of (String | LabelTag)+ to string

Author:

yoikawa,stamm

See Also:

LabelSet, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LanguageDictionary(HumanLanguage language)

Method Summary

Modifier and Type	Method and Description
Adjective	createAdjective(String name, LanguageStartsWith startsWith, LanguagePosition position, boolean copiedFromDefault)
Article	createArticle(String name, LanguageArticle articleType, boolean copiedFromDefault)
Noun	createNoun(String tableEnumOrId, Noun.NounType type, ResultSet rs, Uniquefy uniquefy) construct new noun from result set.
Noun	createNoun(String name, String pluralAlias, Noun.NounType type, String entityName, LanguageStartsWith startsWith, LanguageGender gender, String access, boolean isStandardField, boolean isCopied)
boolean	equals(Object o)
String	format(Object obj, Renameable[] entities, boolean overrideForms, boolean forMessageFormat) Construct String value from the given Label structure, which could be either String or LabelTag.
Adjective	getAdjective(String name)
Set<String>	getAllInheritedTermNames(GrammaticalTerm.TermType type)
Set<String>	getAllTermNames(GrammaticalTerm.TermType type)
Article	getArticle(String name)
LanguageDeclension	getDeclension()
Noun	getDynamicNoun(String name, Renameable ei, boolean getRenamedValue, boolean doFormat) used to resolve custom object name at runtime.
HumanLanguage	getLanguage()
SortedSet<String>	getNames(String tableEnum, boolean includeEntity) return a sorted list of noun names for the given entity.
Noun	getNoun(String name, boolean getRenamedValue)
Noun	getNounByPluralAlias(String name, boolean getRenamedValue)
com.google.common.collect.Multimap<String,Noun>	getNounsByEntity()
Adjective	getOrCreateAdjective(String name, LanguageStartsWith startsWith, LanguagePosition position)
Article	getOrCreateArticle(String name, LanguageArticle articleType)
Noun	getOrCreateNoun(String tableEnum, String name, String pluralAlias, Noun.NounType type, LanguageGender gender, LanguageStartsWith startsWith, String access, boolean isStandardField)
int	hashCode()
boolean	isAdjective(String name)
boolean	isArticle(String name)
boolean	isCustom(String name)
boolean	isEntity(String name)
boolean	isEntityPlural(String name)
boolean	isNoun(String name)
void	makeSkinny() LanguageDictionary store metadata in Map's that have a high memory per element cost.
void	put(String name, GrammaticalTerm term)
void	putAll(LanguageDictionary otherDictionary) Copy the terms from the other dictionary into this one.
void	setString(Adjective m, AdjectiveForm form, String value)
void	setString(Article m, ArticleForm form, String value)
void	setString(Noun n, NounForm form, String value)
String	toString()
void	validateAll()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LanguageDictionary

public LanguageDictionary(HumanLanguage language)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLanguage

public HumanLanguage getLanguage()

getDeclension

public LanguageDeclension getDeclension()

createNoun

public Noun createNoun(String name,
                       String pluralAlias,
                       Noun.NounType type,
                       String entityName,
                       LanguageStartsWith startsWith,
                       LanguageGender gender,
                       String access,
                       boolean isStandardField,
                       boolean isCopied)

createNoun

public Noun createNoun(String tableEnumOrId,
                       Noun.NounType type,
                       ResultSet rs,
                       Uniquefy uniquefy)
                throws SQLException

construct new noun from result set.

Throws:

SQLException

getAllTermNames

public Set<String> getAllTermNames(GrammaticalTerm.TermType type)

getAllInheritedTermNames

public Set<String> getAllInheritedTermNames(GrammaticalTerm.TermType type)

Parameters:

type - the term type to search

Returns:

the names of all the terms of the given type that are copied from the default language

createAdjective

public Adjective createAdjective(String name,
                                 LanguageStartsWith startsWith,
                                 LanguagePosition position,
                                 boolean copiedFromDefault)

createArticle

public Article createArticle(String name,
                             LanguageArticle articleType,
                             boolean copiedFromDefault)

format

public String format(Object obj,
                     Renameable[] entities,
                     boolean overrideForms,
                     boolean forMessageFormat)

Construct String value from the given Label structure, which could be either String or LabelTag.

Parameters:

obj - the object to parse

entities - the renameable objects that are the parameters for the value

forMessageFormat - if the MessageFormat values need to be preserved, such as {0}

overrideForms - if true, it means that the forms in the term refs in the objects do not match the current dictionary and need to be recalculated

getDynamicNoun

public Noun getDynamicNoun(String name,
                           Renameable ei,
                           boolean getRenamedValue,
                           boolean doFormat)

used to resolve custom object name at runtime. For the most case, this is for resolving label like: <entity entity="0"/> <entity_xxxx entity="0"/>

getNoun

public Noun getNoun(String name,
                    boolean getRenamedValue)

getNounByPluralAlias

public Noun getNounByPluralAlias(String name,
                                 boolean getRenamedValue)

getAdjective

public Adjective getAdjective(String name)

getArticle

public Article getArticle(String name)

getNounsByEntity

public com.google.common.collect.Multimap<String,Noun> getNounsByEntity()

put

public void put(String name,
                GrammaticalTerm term)

putAll

public void putAll(LanguageDictionary otherDictionary)

Copy the terms from the other dictionary into this one. Note, this will *not* clone the Grammatical Terms, so changes made to the nouns in the child label set will override the parent.

Parameters:

otherDictionary - the other dictionary which contains all of the values.

validateAll

public void validateAll()

getNames

public final SortedSet<String> getNames(String tableEnum,
                                        boolean includeEntity)

return a sorted list of noun names for the given entity.

isEntity

public boolean isEntity(String name)

Returns:

true if the given name has entity dictionary data

isEntityPlural

public boolean isEntityPlural(String name)

isAdjective

public boolean isAdjective(String name)

isArticle

public boolean isArticle(String name)

isNoun

public boolean isNoun(String name)

isCustom

public boolean isCustom(String name)

Returns:

true if the given name is for custom entity

getOrCreateNoun

public Noun getOrCreateNoun(String tableEnum,
                            String name,
                            String pluralAlias,
                            Noun.NounType type,
                            LanguageGender gender,
                            LanguageStartsWith startsWith,
                            String access,
                            boolean isStandardField)

getOrCreateAdjective

public Adjective getOrCreateAdjective(String name,
                                      LanguageStartsWith startsWith,
                                      LanguagePosition position)

getOrCreateArticle

public Article getOrCreateArticle(String name,
                                  LanguageArticle articleType)

setString

public void setString(Noun n,
                      NounForm form,
                      String value)

setString

public void setString(Adjective m,
                      AdjectiveForm form,
                      String value)

setString

public void setString(Article m,
                      ArticleForm form,
                      String value)

toString

public String toString()

Overrides:

toString in class Object

makeSkinny

public void makeSkinny()

LanguageDictionary store metadata in Map's that have a high memory per element cost. The various dictionaries are static in nature and would not change after the initial load. ImmutableSortedMap's have a 8 byte overhead cost which is attractive to keep the required space of LanguageDictionary to a minimum. Since LanguageDictionary's are static, this make them a perfect candidate for ImmutableSortedMap.