com.force.i18n.grammar

Class Article

java.lang.Object

com.force.i18n.grammar.GrammaticalTerm

com.force.i18n.grammar.NounModifier

com.force.i18n.grammar.Article

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArticledDeclension.SimpleArticle

public abstract class Article
extends NounModifier

In an articled declension, this represents the different forms of articles

Author:

stamm

See Also:

Serialized Form

Nested Class Summary

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

GrammaticalTerm.TermType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Article(ArticledDeclension declension, String name, LanguageArticle articleType)

Method Summary

Modifier and Type	Method and Description
boolean	defaultValidate(String name, Set<? extends ArticleForm> requiredForms) A "simple" method for validating required terms and validating that they exist.
abstract Map<? extends ArticleForm,String>	getAllValues()
LanguageArticle	getArticleType()
ArticledDeclension	getDeclension() Get the declension associated with the language.
String	getDefaultValue()
LanguagePosition	getPosition()
protected abstract String	getString(ArticleForm form)
String	getString(LanguageNumber number, LanguageGender gender, LanguageStartsWith startsWith)
String	getString(ModifierForm form)
protected GrammaticalTerm.TermType	getTermType()
protected abstract void	setString(ArticleForm form, String value) Set the value of one of the forms of this adjective.
String	toString()
boolean	validate(String name) After all of the parsing has been done for a noun or modifier, "fix up" any missing values needed.

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

getStartsWith, isCopiedFromDefault

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

Article

protected Article(ArticledDeclension declension,
                  String name,
                  LanguageArticle articleType)

Method Detail

getDeclension

public ArticledDeclension getDeclension()

Description copied from class: GrammaticalTerm

Get the declension associated with the language. This

Overrides:

getDeclension in class GrammaticalTerm

getArticleType

public LanguageArticle getArticleType()

getAllValues

public abstract Map<? extends ArticleForm,String> getAllValues()

Specified by:

getAllValues in class NounModifier

Returns:

all the forms of the adjective

getString

protected abstract String getString(ArticleForm form)

Returns:

the value of this adjective for the given form

getString

public final String getString(ModifierForm form)

Specified by:

getString in class NounModifier

Parameters:

form - the form to return

Returns:

the defined string for this modifier for the given form, or null if there is no string for that form

getDefaultValue

public String getDefaultValue()

Specified by:

getDefaultValue in class NounModifier

Returns:

an arbitrary but deterministic value for a specific form for this object.

getPosition

public LanguagePosition getPosition()

Specified by:

getPosition in class NounModifier

Returns:

the position of this noun modifier WRT the noun. In this case, it is *always* pre, otherwise for all the languages, so far, the article is attached to the noun form.

getString

public String getString(LanguageNumber number,
                        LanguageGender gender,
                        LanguageStartsWith startsWith)

setString

protected abstract void setString(ArticleForm form,
                                  String value)

Set the value of one of the forms of this adjective.

Parameters:

form - the form to set

value - the value to set

validate

public boolean validate(String name)

Description copied from class: GrammaticalTerm

After all of the parsing has been done for a noun or modifier, "fix up" any missing values needed. TODO: This may not be very necessary.

Specified by:

validate in class GrammaticalTerm

Parameters:

name - the name of the term

Returns:

true if the term is valid

defaultValidate

public boolean defaultValidate(String name,
                               Set<? extends ArticleForm> requiredForms)

A "simple" method for validating required terms and validating that they exist. This generally depends on the declensions "return all forms" TODO: This should compare the difference between specified forms and choose the most similar (ie. the smallest Hamming distance)

Parameters:

requiredForms - the set of required forms for articles in this language

Returns:

true if the forms provided are valid. Also fills in missing forms if necessary

getTermType

protected GrammaticalTerm.TermType getTermType()

Specified by:

getTermType in class GrammaticalTerm

Returns:

the type of this term

toString

public String toString()

Overrides:

toString in class Object