com.articulate.sigma.nlg

Class LanguageFormatter

java.lang.Object

com.articulate.sigma.nlg.LanguageFormatter

public class LanguageFormatter
extends java.lang.Object

A class that handles the generation of natural language from logic.

Author:

Adam Pease - apease [at] articulatesoftware [dot] com, with thanks to Michal Sevcenko - sevcenko@vc.cvut.cz for development of the formatting language.

Constructor Summary

Constructors

Constructor and Description
LanguageFormatter(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)

Method Summary

Modifier and Type	Method and Description
java.lang.String	htmlParaphrase(java.lang.String href) Hyperlink terms in a natural language format string.
static void	main(java.lang.String[] args)
void	setDoInformalNLG(boolean doIt)
static java.lang.String	variableReplace(java.lang.String form, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> instMap, java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>> classMap, KB kb, java.lang.String language) Replace variables in a formula with paraphrases expressing their type.

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageFormatter

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

Parameters:

stmt - The statement to be formatted.

phraseMap - kb.getFormatMap() for this language

termMap - kb.getTermFormatMap() for this language

kb -

language -

Method Detail

setDoInformalNLG

public void setDoInformalNLG(boolean doIt)

htmlParaphrase

public java.lang.String htmlParaphrase(java.lang.String href)

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.

Returns:

variableReplace

public static java.lang.String variableReplace(java.lang.String form,
                                               java.util.Map<java.lang.String,java.util.Set<java.lang.String>> instMap,
                                               java.util.HashMap<java.lang.String,java.util.Set<java.lang.String>> classMap,
                                               KB kb,
                                               java.lang.String language)

Replace variables in a formula with paraphrases expressing their type.

main

public static void main(java.lang.String[] args)