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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LanguageFormatter.RelationArgumentAnnotation
static class	LanguageFormatter.VariableAnnotation

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug
static java.util.HashMap<java.lang.String,CoreLabel>	outputMap

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	generateFormalNaturalLanguage(java.util.List<java.lang.String> args, java.lang.String pred, boolean isNegMode)
java.lang.String	htmlParaphrase(java.lang.String href) Hyperlink terms in a natural language format string.
static void	main(java.lang.String[] args)
java.lang.String	paraphraseStatement(java.lang.String stmt, boolean isNegMode, boolean isQuestionMode, int depth) Create a natural language paraphrase of a logical statement.
static java.lang.String	removePreamble(java.lang.String input) Remove the type declarations from the text
void	setDoInformalNLG(boolean doIt)
static void	test1()
static void	test2()
static void	test3()
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

Field Detail

debug

public static boolean debug

outputMap

public static java.util.HashMap<java.lang.String,CoreLabel> outputMap

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:

paraphraseStatement

public java.lang.String paraphraseStatement(java.lang.String stmt,
                                            boolean isNegMode,
                                            boolean isQuestionMode,
                                            int depth)

Create a natural language paraphrase of a logical statement.

Parameters:

stmt - The statement to be paraphrased.

isNegMode - Whether the statement is negated.

isQuestionMode - Whether the statement is a question.

depth - An int indicating the level of nesting, for control of indentation.

Returns:

A String, which is the paraphrased statement.

generateFormalNaturalLanguage

public java.lang.String generateFormalNaturalLanguage(java.util.List<java.lang.String> args,
                                                      java.lang.String pred,
                                                      boolean isNegMode)

removePreamble

public static java.lang.String removePreamble(java.lang.String input)

Remove the type declarations from the text

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.

test1

public static void test1()

test2

public static void test2()

test3

public static void test3()

main

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