com.articulate.sigma.nlg

Class NLGUtils

java.lang.Object

com.articulate.sigma.nlg.NLGUtils

public class NLGUtils
extends java.lang.Object

Utilities and variables used by LanguageFormatter and other NLG classes.

Constructor Summary

Constructors

Constructor and Description
NLGUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsProcess(java.util.Collection<java.lang.String> vals, KB kb) Return true if the given list includes "Process", or if one of its elements is a subclass of Process.
static java.lang.String	formatList(java.lang.String strseq, java.lang.String language) Format a list of variables which are not enclosed by parens.
static java.lang.String	getArticle(java.lang.String s, int count, int occurrence, java.lang.String language) Generate a linguistic article appropriate to how many times in a paraphrase a particular type has already occurred.
static java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>	getKeywordMap() Return a defensive copy of the keyword map.
static java.lang.String	htmlParaphrase(java.lang.String href, java.lang.String stmt, java.util.Map<java.lang.String,java.lang.String> phraseMap, java.util.Map<java.lang.String,java.lang.String> termMap, KB kb, java.lang.String language) Hyperlink terms in a natural language format string.
static java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>	readKeywordMap(java.lang.String dir) Read a set of standard words and phrases in several languages.
static java.lang.String	resolveFormatSpecifiers(java.lang.String template, java.lang.String href) Resolve the "format specifiers" in the given printf type of statement.
static java.lang.String	upcaseFirstVisibleChar(java.lang.String htmlParaphrase, boolean addFullStop, java.lang.String language) Capitalizes the first visible char of htmlParaphrase, if possible, and adds the full stop symbol for language at a workable place near the end of htmlParaphrase if addFullStop is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

NLGUtils

public NLGUtils()

Method Detail

resolveFormatSpecifiers

public static java.lang.String resolveFormatSpecifiers(java.lang.String template,
                                                       java.lang.String href)

Resolve the "format specifiers" in the given printf type of statement.

Parameters:

template -

href -

Returns:

formatList

public static java.lang.String formatList(java.lang.String strseq,
                                          java.lang.String language)

Format a list of variables which are not enclosed by parens. Formatting includes inserting the appropriate separator between the elements (usually a comma), as well as inserting the conjunction ("and" or its equivalent in another language) if the conjunction doesn't already exist.

Parameters:

strseq - the list of variables

language - the target language (used for the conjunction "and")

Returns:

the formatted string

readKeywordMap

public static java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> readKeywordMap(java.lang.String dir)

Read a set of standard words and phrases in several languages. Each phrase must appear on a new line with alternatives separated by '|'. The first entry should be a set of two letter language identifiers.

Returns:

a HashMap of HashMaps where the first HashMap has a key of the English phrase, and the interior HashMap has a key of the two letter language identifier.

getArticle

public static java.lang.String getArticle(java.lang.String s,
                                          int count,
                                          int occurrence,
                                          java.lang.String language)

Generate a linguistic article appropriate to how many times in a paraphrase a particular type has already occurred.

Parameters:

occurrence - is the number of times a variables of a given type have appeared

count - is the number of times a given variable has appeared

getKeywordMap

public static java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> getKeywordMap()

Return a defensive copy of the keyword map.

htmlParaphrase

public static java.lang.String htmlParaphrase(java.lang.String href,
                                              java.lang.String stmt,
                                              java.util.Map<java.lang.String,java.lang.String> phraseMap,
                                              java.util.Map<java.lang.String,java.lang.String> termMap,
                                              KB kb,
                                              java.lang.String language)

Hyperlink terms in a natural language format string. This assumes that terms to be hyperlinked are in the form &%termName$termString , where termName is the name of the term to be browsed in the knowledge base and termString is the text that should be displayed hyperlinked.

Parameters:

href - the anchor string up to the term= parameter, which this method will fill in.

stmt - the KIF statement that will be passed to paraphraseStatement for formatting.

phraseMap - the set of NL formatting statements that will be passed to paraphraseStatement.

termMap - the set of NL statements for terms that will be passed to paraphraseStatement.

language - the natural language in which the paraphrase should be generated.

upcaseFirstVisibleChar

public static java.lang.String upcaseFirstVisibleChar(java.lang.String htmlParaphrase,
                                                      boolean addFullStop,
                                                      java.lang.String language)

Capitalizes the first visible char of htmlParaphrase, if possible, and adds the full stop symbol for language at a workable place near the end of htmlParaphrase if addFullStop is true.

Parameters:

htmlParaphrase - Any String, but assumed to be a Formula paraphrase with HTML markup

addFullStop - If true, this method will try to add a full stop symbol to the result String.

language - The language of the paraphrase String.

Returns:

String

containsProcess

public static boolean containsProcess(java.util.Collection<java.lang.String> vals,
                                      KB kb)

Return true if the given list includes "Process", or if one of its elements is a subclass of Process.

Parameters:

vals -

kb -

Returns: