com.force.i18n.grammar

Class Noun

java.lang.Object

com.force.i18n.grammar.GrammaticalTerm

com.force.i18n.grammar.Noun

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ArticledDeclension.LegacyArticledNoun, LanguageDeclension.SimplePluralNoun, TamilDeclension.TamilNoun

public abstract class Noun
extends GrammaticalTerm
implements Cloneable

A linguistic noun, containing a set of strings associated with the various noun forms of the given language.

Author:

yoikawa,stamm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Noun.NounType What "type" of noun.

Nested classes/interfaces inherited from class com.force.i18n.grammar.GrammaticalTerm

GrammaticalTerm.TermType

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	VALIDATION_ERROR_HEADER
protected static String	VALIDATION_WARNING_HEADER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Noun(LanguageDeclension declension, String name, String pluralAlias, Noun.NounType type, String entityName, LanguageStartsWith startsWith, LanguageGender gender, String access, boolean isStandardField, boolean isCopiedFromDefault) Construct a noun for the given declension

Method Summary

Modifier and Type	Method and Description
Noun	clone()
Noun	clone(LanguageGender genderOverride, LanguageStartsWith startsWithOverride)
Noun	clone(LanguageGender genderOverride, LanguageStartsWith startsWithOverride, Map<NounForm,String> valueOverrides) Make a clone of the given noun, overwriting the given values with the provided overrides
boolean	defaultValidate(String name, Collection<? extends NounForm> requiredForms)
boolean	equals(Object obj)
protected boolean	equalsValue(Object obj)
String	getAccess()
abstract Map<? extends NounForm,String>	getAllDefinedValues()
String	getCloseButNoCigarString(NounForm form)
String	getClosestString(NounForm form)
String	getDefaultString(boolean isPlural)
String	getEntityName()
LanguageGender	getGender()
Noun.NounType	getNounType()
String	getPluralAlias()
LanguageStartsWith	getStartsWith() The "startsWith" is based on the next term in the sequence, not the next noun
abstract String	getString(NounForm nid)
String	getString(NounForm nid, boolean lowerCase)
protected GrammaticalTerm.TermType	getTermType()
int	hashCode()
boolean	isCopiedFromDefault()
boolean	isStandardField()
abstract void	makeSkinny() Provides clients the capability of indicating when members of Noun's can be converted to space efficient data structures.
<T extends NounForm> Map<T,String>	makeSkinny(Map<T,String> map) Utility method used to convert static Map's concrete type to a ImmutableSortedMap.
protected void	setGender(LanguageGender gender)
protected void	setStartsWith(LanguageStartsWith startsWith)
void	setString(LanguageDeclension declension, ResultSet rs)
protected abstract void	setString(String value, NounForm nid)
String	toString()
boolean	validate(String name) validate and fix-up missing data if possible.
protected boolean	validateGender(String name)
protected boolean	validateValues(String name)
protected abstract boolean	validateValues(String name, LanguageCase _case)

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

getDeclension, getName

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_ERROR_HEADER

protected static final String VALIDATION_ERROR_HEADER

See Also:

Constant Field Values

VALIDATION_WARNING_HEADER

protected static final String VALIDATION_WARNING_HEADER

See Also:

Constant Field Values

Constructor Detail

Noun

protected Noun(LanguageDeclension declension,
               String name,
               String pluralAlias,
               Noun.NounType type,
               String entityName,
               LanguageStartsWith startsWith,
               LanguageGender gender,
               String access,
               boolean isStandardField,
               boolean isCopiedFromDefault)

Construct a noun for the given declension

Parameters:

declension - the declension for the language associated with this noun

name - the name of the noun

pluralAlias - an alias used in the label files to refer to this noun in plural

type - the NounType of this noun

entityName - TODO

startsWith - what this noun starts with

gender - the grammatical gender of the noun

access - a string preresenting the access of this object

isStandardField - whether this noun represents a standard field (as opposed to a concept). Determines the section the noun is placed in for rename tabs

isCopiedFromDefault - if true, means that this noun was not defined in the language of the declension, but instead is copied from english or another fallback language

Method Detail

isCopiedFromDefault

public boolean isCopiedFromDefault()

Specified by:

isCopiedFromDefault in class GrammaticalTerm

Returns:

whether this grammatical term was inherited from english

getGender

public final LanguageGender getGender()

getStartsWith

public final LanguageStartsWith getStartsWith()

Description copied from class: GrammaticalTerm

The "startsWith" is based on the next term in the sequence, not the next noun

Specified by:

getStartsWith in class GrammaticalTerm

Returns:

the startsWith of this grammatical term

getPluralAlias

public String getPluralAlias()

getAccess

public String getAccess()

getEntityName

public String getEntityName()

Returns:

the name of the entity this noun is associated with

getDefaultString

public String getDefaultString(boolean isPlural)

setString

protected abstract void setString(String value,
                                  NounForm nid)

getString

public abstract String getString(NounForm nid)

getAllDefinedValues

public abstract Map<? extends NounForm,String> getAllDefinedValues()

Returns:

all of the noun forms defined in the sfdcnames.xml file.

isStandardField

public boolean isStandardField()

getString

public String getString(NounForm nid,
                        boolean lowerCase)

equalsValue

protected boolean equalsValue(Object obj)

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

validateGender

protected boolean validateGender(String name)

Parameters:

name - the name of the noun called by validate(String, LanguageDictionary.
Override this method if you need more validation. or fixup gender and startsWith values. For English, we may be able to figure out Vowel letter, but can't do that for vowel sounds like "Hour".

setGender

protected void setGender(LanguageGender gender)

setStartsWith

protected void setStartsWith(LanguageStartsWith startsWith)

getNounType

public Noun.NounType getNounType()

validateValues

protected boolean validateValues(String name)

validateValues

protected abstract boolean validateValues(String name,
                                          LanguageCase _case)

validate

public final boolean validate(String name)

validate and fix-up missing data if possible.

Specified by:

validate in class GrammaticalTerm

Parameters:

name - the name of the term

Returns:

true if the term is valid

clone

public Noun clone()

Overrides:

clone in class Object

clone

public Noun clone(LanguageGender genderOverride,
                  LanguageStartsWith startsWithOverride)

clone

public Noun clone(LanguageGender genderOverride,
                  LanguageStartsWith startsWithOverride,
                  Map<NounForm,String> valueOverrides)

Make a clone of the given noun, overwriting the given values with the provided overrides

Parameters:

genderOverride - the gender to override, if not null

startsWithOverride - the starts with to override, if not null

valueOverrides - the overrides for values (usually from end-user customization)

Returns:

a new clone of this noun with the various values overridden

setString

public final void setString(LanguageDeclension declension,
                            ResultSet rs)
                     throws SQLException

Throws:

SQLException

defaultValidate

public boolean defaultValidate(String name,
                               Collection<? extends NounForm> requiredForms)

getClosestString

public String getClosestString(NounForm form)

Parameters:

form - the form to find

Returns:

the noun form that is closest to the form, including an exact match.

getCloseButNoCigarString

public String getCloseButNoCigarString(NounForm form)

Parameters:

form - the form to find the closest.

Returns:

the closest noun form that would match the form, but isn't actually the form

getTermType

protected final GrammaticalTerm.TermType getTermType()

Specified by:

getTermType in class GrammaticalTerm

Returns:

the type of this term

toString

public String toString()

Overrides:

toString in class Object

makeSkinny

public abstract void makeSkinny()

Provides clients the capability of indicating when members of Noun's can be converted to space efficient data structures.

makeSkinny

public <T extends NounForm> Map<T,String> makeSkinny(Map<T,String> map)

Utility method used to convert static Map's concrete type to a ImmutableSortedMap. ImmutableSortedMap have a 8 byte overhead per element and are useful for reducing the per element overhead, that is traditionally high on most Map implementations.

Returns:

A ImmutableSortedMap created from a Map of NounForm's (key) to String's (value).