com.force.i18n

Class LabelSetDescriptorImpl

java.lang.Object

com.force.i18n.LabelSetDescriptorImpl

All Implemented Interfaces:

LabelSetDescriptor, LanguageLabelSetDescriptor, LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

public class LabelSetDescriptorImpl
extends Object
implements LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Represents a descriptor of a standard language-specific language set

Author:

yoikawa,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
LabelSetDescriptorImpl(URL rootDirectory, HumanLanguage language, String labelSetName) Construct a LabelSetDescriptor for the given labelSetName.
LabelSetDescriptorImpl(URL rootDirectory, HumanLanguage language, String setName, String basename, String dictionaryName) Constructor to override the default file basename with the specified basename.
LabelSetDescriptorImpl(URL rootDirectory, String labelSetName) Construct a LabelSetDescriptor for the given labelSetName in the default language Uses the label and dictionary file name from the properties files

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
URL	getDictionaryDir()
URL	getDictionaryFile()
LabelSetDescriptorImpl	getForOtherLanguage(HumanLanguage otherLanguage) Return a label set descriptor for the other language.
static com.google.common.base.Function<HumanLanguage,URL>	getLabelRootFunction(String rootPath, String labelName, ClassLoader resourceLocator)
String	getLabelSetName()
HumanLanguage	getLanguage()
List<URL>	getModularizedFiles()
List<URL>	getOverridingDictionaryFiles()
List<URL>	getOverridingFiles()
URL	getRootDir()
URL	getRootFile()
static LabelSetDescriptorImpl	getWithMultipleRoots(com.google.common.base.Function<HumanLanguage,URL> rootMap, HumanLanguage baseLanguage, String setName, String basename, String dictionaryName) Construct a LabelSetDescriptor with a function to determine the root per language instead of a fixed one
int	hashCode()
boolean	hasModularizedFiles()
boolean	hasOverridingFiles()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelSetDescriptorImpl

public LabelSetDescriptorImpl(URL rootDirectory,
                              String labelSetName)

Construct a LabelSetDescriptor for the given labelSetName in the default language Uses the label and dictionary file name from the properties files

Parameters:

rootDirectory - the root directory of the files in the given language

labelSetName - the name of the label set

LabelSetDescriptorImpl

public LabelSetDescriptorImpl(URL rootDirectory,
                              HumanLanguage language,
                              String labelSetName)

Construct a LabelSetDescriptor for the given labelSetName. Uses the label and dictionary file name from the properties files

Parameters:

rootDirectory - the root directory of the files in the given language

language - the language of the label set

labelSetName - the name of the label set

LabelSetDescriptorImpl

public LabelSetDescriptorImpl(URL rootDirectory,
                              HumanLanguage language,
                              String setName,
                              String basename,
                              String dictionaryName)

Constructor to override the default file basename with the specified basename.

Method Detail

getForOtherLanguage

public LabelSetDescriptorImpl 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.

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.

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.

getDictionaryDir

public URL getDictionaryDir()

getDictionaryFile

public URL getDictionaryFile()

Specified by:

getDictionaryFile in interface LanguageLabelSetDescriptor.GrammaticalLabelSetDescriptor

Returns:

the location of the base dictionary file

hasOverridingFiles

public boolean hasOverridingFiles()

Specified by:

hasOverridingFiles in interface LabelSetDescriptor

Returns:

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

getLanguage

public HumanLanguage getLanguage()

Specified by:

getLanguage in interface LanguageLabelSetDescriptor

Returns:

the language represented by this label set descriptor.

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.

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getWithMultipleRoots

public static LabelSetDescriptorImpl getWithMultipleRoots(com.google.common.base.Function<HumanLanguage,URL> rootMap,
                                                          HumanLanguage baseLanguage,
                                                          String setName,
                                                          String basename,
                                                          String dictionaryName)

Construct a LabelSetDescriptor with a function to determine the root per language instead of a fixed one

Parameters:

rootMap - a map from HumanLanguage to URL root

baseLanguage - the first language you need (it still assumes base language is base)

setName - the name of the label set

basename - the "labels.xml" or equivalent for the set

dictionaryName - the "names.xml" or equivalent for the set

getLabelRootFunction

public static com.google.common.base.Function<HumanLanguage,URL> getLabelRootFunction(String rootPath,
                                                                                      String labelName,
                                                                                      ClassLoader resourceLocator)

Parameters:

rootPath - the path to the directory containing the labels

labelName - the name of the label file in the directory.

resourceLocator - the relevant classloader to use to find the labels

Returns:

a non-caching function that uses the ClassLoader to find label files on the classpath

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