com.force.i18n.grammar.parser

Class TestLanguageLabelSetDescriptor

java.lang.Object

com.force.i18n.grammar.parser.TestLanguageLabelSetDescriptor

All Implemented Interfaces:

LabelSetDescriptor, LanguageLabelSetDescriptor, LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

public class TestLanguageLabelSetDescriptor
extends Object
implements LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

A descriptor that includes some "text" that can be used in various label-related utilities for testing labels.

Author:

stamm

Nested Class Summary

Nested classes/interfaces inherited from interface com.force.i18n.LanguageLabelSetDescriptor

LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Field Summary

Fields inherited from interface com.force.i18n.LabelSetDescriptor

DICTIONARY_FILENAME, LABELS_FILENAME

Constructor Summary

Constructors

Constructor and Description
TestLanguageLabelSetDescriptor(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor delegate, String text, String grammarOverrides) Construct the test language label set descriptor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
URL	getDictionaryFile()
LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor	getForOtherLanguage(HumanLanguage otherLanguage) Return a label set descriptor for the other language.
String	getGrammar()
String	getLabelSetName()
HumanLanguage	getLanguage()
List<URL>	getModularizedFiles()
List<URL>	getOverridingDictionaryFiles()
List<URL>	getOverridingFiles()
URL	getRootDir()
URL	getRootFile()
String	getText()
int	hashCode()
boolean	hasModularizedFiles()
boolean	hasOverridingFiles()

Methods inherited from class java.lang.Object

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

Constructor Detail

TestLanguageLabelSetDescriptor

public TestLanguageLabelSetDescriptor(LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor delegate,
                                      String text,
                                      String grammarOverrides)

Construct the test language label set descriptor

Parameters:

delegate - The delegate that represents the label set to which the test should be added

text - the label XML file that is added to the set of the other labels

grammarOverrides - an optional sfdcnames.xml style file that contains overrides for the grammar

Method Detail

getRootDir

public URL getRootDir()

Specified by:

getRootDir in interface LabelSetDescriptor

Returns:

the root file for the label set.

getRootFile

public URL getRootFile()

Specified by:

getRootFile in interface LabelSetDescriptor

Returns:

the root file for the label set.

hasOverridingFiles

public boolean hasOverridingFiles()

Specified by:

hasOverridingFiles in interface LabelSetDescriptor

Returns:

true if the label set has files that override the root file.

getOverridingFiles

public List<URL> getOverridingFiles()

Specified by:

getOverridingFiles in interface LabelSetDescriptor

Returns:

a list of files that override the root file in the order that they should be processed.

getLanguage

public HumanLanguage getLanguage()

Specified by:

getLanguage in interface LanguageLabelSetDescriptor

Returns:

the language represented by this label set descriptor.

getForOtherLanguage

public LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor getForOtherLanguage(HumanLanguage otherLanguage)

Description copied from interface: LanguageLabelSetDescriptor

Return a label set descriptor for the other language. This allows the roots of different languages to be different for different languages

Specified by:

getForOtherLanguage in interface LanguageLabelSetDescriptor

Specified by:

getForOtherLanguage in interface LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Parameters:

otherLanguage - the other language for which to return the descriptor

Returns:

the label set descriptor suitable for use in a language other than this one. Usually it returns the same LabelSetDescriptor.getRootDir(), but this allows overriding to allow a different root for different languages.

getDictionaryFile

public URL getDictionaryFile()

Specified by:

getDictionaryFile in interface LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Returns:

the location of the base dictionary file

getOverridingDictionaryFiles

public List<URL> getOverridingDictionaryFiles()

Specified by:

getOverridingDictionaryFiles in interface LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Returns:

the location of the overriding dictionary files if applicable

See Also:

LabelSetDescriptor.getOverridingFiles()

getLabelSetName

public String getLabelSetName()

Specified by:

getLabelSetName in interface LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Returns:

a string that represents the name of the label set that is suitable for use as a directory in a path for caching.

hasModularizedFiles

public boolean hasModularizedFiles()

Specified by:

hasModularizedFiles in interface LabelSetDescriptor

Returns:

true if the label files should be loaded separately instead of through labels.xml.

getModularizedFiles

public List<URL> getModularizedFiles()

Specified by:

getModularizedFiles in interface LabelSetDescriptor

Returns:

a list of files which should be loaded separately instead of through labels.xml

getText

public String getText()

Returns:

the contents of the xml label file that should be added to those in the file system/

getGrammar

public String getGrammar()

Returns:

an optional sfdcnames.xml style file that contains overrides for the grammar

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object