com.force.i18n.grammar.parser

Class TermRefTag

java.lang.Object

com.force.i18n.grammar.parser.TermRefTag

All Implemented Interfaces:

Serializable

public abstract class TermRefTag
extends Object
implements Serializable

Base class of Term Reference Tag elements in labels file. This keeps any elements appears in contents of param element.

Author:

yoikawa

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	SEP

Constructor Summary

Constructors

Constructor and Description
TermRefTag(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
protected abstract boolean	equalsValue(TermRefTag obj) Abstract method to force subclasses to correctly implement equals
abstract GrammaticalForm	getForm(LanguageDictionary dictionary, boolean overrideForms)
abstract String	getKey()
String	getName()
protected abstract GrammaticalTerm.TermType	getType()
int	hashCode()
boolean	isAdjective()
boolean	isArticle()
boolean	isDynamic()
boolean	isModifier()
boolean	isNoun()
String	toString()
abstract String	toString(LanguageDictionary dictionary, boolean overrideForms, Renameable... entities) Format this reference into a user-readable format based on the given dictionary and dynamic entities

Methods inherited from class java.lang.Object

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

Field Detail

SEP

public static final char SEP

See Also:

Constant Field Values

Constructor Detail

TermRefTag

public TermRefTag(String name)

Method Detail

getName

public String getName()

getKey

public abstract String getKey()

Returns:

a "key" that uniquely identifies all the attributes of the reference tag. Used by toString to provide some usefulness

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equalsValue

protected abstract boolean equalsValue(TermRefTag obj)

Abstract method to force subclasses to correctly implement equals

Parameters:

obj - the other object being compared.

Returns:

true if the values of this reference, besides the tag, are equivalent.

isNoun

public boolean isNoun()

isArticle

public boolean isArticle()

isAdjective

public boolean isAdjective()

isModifier

public boolean isModifier()

getType

protected abstract GrammaticalTerm.TermType getType()

Returns:

the particle type that this reference represents

getForm

public abstract GrammaticalForm getForm(LanguageDictionary dictionary,
                                        boolean overrideForms)

Returns:

the form of this GrammaticalTerm for the given dictionary.

isDynamic

public boolean isDynamic()

Returns:

whether this GrammaticalTerm is "dynamic", i.e. it requires a Renameable to be used.

toString

public abstract String toString(LanguageDictionary dictionary,
                                boolean overrideForms,
                                Renameable... entities)

Format this reference into a user-readable format based on the given dictionary and dynamic entities

Parameters:

dictionary - the dictionary of language particles.

entities - the set of dynamic renameable entities

overrideForms - if the form contained inside this term ref might be a different language than the dictionary provided. In this case, the implementation must try to find the closest term to the one stored with this term ref.

Returns:

a user-readable string for this reference

toString

public String toString()

Overrides:

toString in class Object