com.force.i18n

Enum LabelUtils

java.lang.Object

java.lang.Enum<LabelUtils>

com.force.i18n.LabelUtils

All Implemented Interfaces:

Serializable, Comparable<LabelUtils>

public enum LabelUtils
extends Enum<LabelUtils>

Set of routines to simplify access to LabelUtils

Author:

stamm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelUtils.Nounifier A structure generated from a dictionary that performs a simple "nounification" process to determine if there should be some "tokenization" of the string.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
static LabelUtils	get()
static List<URL>	getFileNames(HumanLanguage language, URL rootDirectory, String basename)
String	getFormDescriptionInEnglish(LanguageDeclension declension, NounForm form) Provide an english-list description of a noun form.
static String	getParentLevelPath(int levels) If you have a URL from Class.getResoruce, what do you provide to the URL constructor to get to the directory levels above the current one with that URL as the context
String	getPublicString(GrammaticalLabelSet labelSet, String section, String param)
static String	getSampleGrammarFile(String grammar) Construct a valid names.xml style file out of the user-entered grammar file.
static String	getSampleLabelFile(String text) Construct a valid labels.xml style file for the given text, where the label will be at LabelRef("Test","Test").
String	nounify(String input, LanguageDictionary dictionary) Given a non-nounified input, try to replace nouns and adjectives from the dictionary with the appropriate noun xml tags.
String	processMissingLabel(String message) Will either throw an exception or log the missing label, depending on whether or not we're in production
String	processMissingLabel(String labelSection, String labelId)
static LabelUtils	valueOf(String name) Returns the enum constant of this type with the specified name.
static LabelUtils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final LabelUtils INSTANCE

Method Detail

values

public static LabelUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LabelUtils c : LabelUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LabelUtils valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public static LabelUtils get()

processMissingLabel

public String processMissingLabel(String message)

Will either throw an exception or log the missing label, depending on whether or not we're in production

Parameters:

message - - String to return and log with

processMissingLabel

public String processMissingLabel(String labelSection,
                                  String labelId)

getFormDescriptionInEnglish

public String getFormDescriptionInEnglish(LanguageDeclension declension,
                                          NounForm form)

Provide an english-list description of a noun form. Note, if there is only one form supported, this will return the empty string.

Parameters:

declension - the language being declined

form - the noun form in question

Returns:

an english string that describes the noun form suitable for use in the metadata api

getPublicString

public String getPublicString(GrammaticalLabelSet labelSet,
                              String section,
                              String param)
                       throws IllegalArgumentException

Parameters:

labelSet - the label set that contains the

section - the section to return

param - the key to the label to return

Returns:

the public label at the given section and param, if the parameter is public

Throws:

IllegalArgumentException - if you cannot access this label

getSampleGrammarFile

public static String getSampleGrammarFile(String grammar)

Construct a valid names.xml style file out of the user-entered grammar file. This will check to see if the file is "valid" xml, and if so, it will remove the DTD which causes the parser to choke; otherwise it will turn the XML fragment into a fully formed names file.

Parameters:

grammar - XML snippet

Returns:

a sample dictionary file containing the xml snippet inside the "names" tag

getSampleLabelFile

public static String getSampleLabelFile(String text)

Construct a valid labels.xml style file for the given text, where the label will be at LabelRef("Test","Test").

Parameters:

text - the unescaped text to place inside the label, or to construct an alias if the string starts with "alias="

Returns:

a sample label file that can be used for evaluating a given label.

nounify

public String nounify(String input,
                      LanguageDictionary dictionary)

Given a non-nounified input, try to replace nouns and adjectives from the dictionary with the appropriate noun xml tags.

Returns:

the input string with Nouns and Articles converted to tags if possible

getFileNames

public static List<URL> getFileNames(HumanLanguage language,
                                     URL rootDirectory,
                                     String basename)

getParentLevelPath

public static String getParentLevelPath(int levels)

If you have a URL from Class.getResoruce, what do you provide to the URL constructor to get to the directory levels above the current one with that URL as the context

Parameters:

levels - the number of directories to go up

Returns:

what to pass into URL.URL(URL, String) to get the URL to be levels above