com.articulate.sigma

Class HTMLformatter

java.lang.Object

com.articulate.sigma.HTMLformatter

public class HTMLformatter
extends java.lang.Object

A utility class that creates HTML-formatting Strings for various purposes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.ArrayList<java.lang.String>	availableFormalLanguages
static java.lang.String	htmlDivider
static java.lang.String	kbHref
static java.lang.String	language

Constructor Summary

Constructors

Constructor and Description
HTMLformatter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	browserSectionFormat(java.lang.String term, java.lang.String header, KB kb, java.lang.String language, java.lang.String flang, int arg, java.lang.String type) Create the HTML for a section of the Sigma term browser page.
static java.lang.String	browserSectionFormatLimit(java.lang.String term, java.lang.String header, KB kb, java.lang.String language, java.lang.String flang, int start, int limit, int arg, java.lang.String type) Create the HTML for a section of the Sigma term browser page.
static java.lang.String	createHrefStart() Create the HTML for a link, taking care of http/https, hostname and port
static java.lang.String	createKBHref(java.lang.String kbName, java.lang.String language) Create the HTML for a kb link.
static java.lang.String	createKBMenu(java.lang.String kbName) Create an HTML menu of KB names
static java.lang.String	createMenu(java.lang.String menuName, java.lang.String selectedOption, java.util.ArrayList<java.lang.String> options) Create an HTML menu, given an ArrayList of Strings.
static java.lang.String	createMenu(java.lang.String menuName, java.lang.String selectedOption, java.util.ArrayList<java.lang.String> options, java.lang.String params) Create an HTML menu with an ID, given an ArrayList of Strings.
static java.lang.String	createMultiMenu(java.lang.String menuName, java.util.TreeMap<java.lang.String,java.lang.String> options) Create an HTML menu with an ID, given an ArrayList of Strings, and possibly multiple selections.
static java.lang.String	createNumberedMenu(java.lang.String menuName, java.lang.String selectedOption, java.util.ArrayList<java.lang.String> options) Create an HTML menu, given an ArrayList of Strings where the value(s) are String representations of int(s) but the displayed menu items are String(s).
static java.lang.String	decodeFromHTML(java.lang.String s) change reserved characters to '&' tags
static java.lang.String	decodeFromURL(java.lang.String s) Change spaces to "%20"
static java.lang.String	encodeForHTML(java.lang.String s) change reserved characters from '&' tags
static java.lang.String	encodeForURL(java.lang.String s) Change spaces to "%20" along with many other URL codes.
static java.lang.String	formatConsistencyCheck(java.lang.String msg, java.lang.String ccheckResult, java.lang.String language, int page)
static java.lang.String	formatErrorsWarnings(java.util.TreeSet<java.lang.String> list, KB kb) hyperlink formulas in error messages.
static java.lang.String	formatFormulaList(java.util.ArrayList<Formula> forms, java.lang.String header, KB kb, java.lang.String language, java.lang.String flang, int start, int localLimit, java.lang.String limitString) Create the HTML for a section of the Sigma term browser page.
static java.lang.String	formatProofResult(java.util.ArrayList<BasicXMLelement> proof, java.lang.String stmt, java.lang.String processedStmt, java.lang.String lineHtml, java.lang.String kbName, java.lang.String language, int answerOffset)
static java.lang.String	formatProofResult(java.lang.String result, java.lang.String stmt, java.lang.String processedStmt, java.lang.String lineHtml, java.lang.String kbName, java.lang.String language) Create an HTML formatted result of a query.
static java.lang.String	formatProofResult(java.lang.String result, java.lang.String stmt, java.lang.String processedStmt, java.lang.String lineHtml, java.lang.String kbName, java.lang.String language, int answerOffset)
static java.lang.String	formatTPTP3ProofResult(TPTP3ProofProcessor tpp, java.lang.String stmt, java.lang.String lineHtml, java.lang.String kbName, java.lang.String language)
static java.util.ArrayList<java.lang.String>	getAllNonRelTerms(KB kb, java.util.ArrayList<java.lang.String> matchesList)
static java.util.ArrayList<java.lang.String>	getAllRelTerms(KB kb, java.util.ArrayList<java.lang.String> matchesList)
static java.lang.String	htmlDivider(java.lang.String label) Create the HTML for the labeled divider between the sections of the term display.
static void	main(java.lang.String[] args)
static java.lang.String	processFormalLanguage(java.lang.String flang)
static java.lang.String	processNaturalLanguage(java.lang.String lang, KB kb)
static java.lang.String	proofTableFormat(java.lang.String query, ProofStep step, java.lang.String kbName, java.lang.String language) Create the HTML for a single step in a proof.
static java.lang.String	showMap(KB kb, java.lang.String term) Show a map if coordinates are given in the kb
static java.lang.String	showNeighborTerms(KB kb, java.lang.String term)
static java.lang.String	showNeighborTerms(KB kb, java.lang.String nonRelTerm, java.lang.String relTerm) Show alphabetic list of neighbor terms
static java.lang.String	showNumberPictures(KB kb, java.lang.String term, int count) Show knowledge base pictures
static java.lang.String	showPictures(KB kb, java.lang.String term) Show knowledge base pictures
static java.lang.String	showREMatches(KB kb, java.lang.String relREmatch, java.lang.String nonRelREmatch, java.lang.String term) Show list of 30 relation & nonRelation terms that contain a match to the input RE term.
static java.lang.String	showStatistics(KB kb) Show knowledge base statistics
static java.lang.String	synsetList(java.util.ArrayList<java.lang.String> synsets, java.lang.String kbHref) Show a hyperlinked list of WordNet synsets.
static java.lang.String	termList(java.util.ArrayList<java.lang.String> terms, java.lang.String kbHref) Show a hyperlinked list of terms.
static java.lang.String	termMappingsList(java.lang.String terms, java.lang.String kbHref) Show a hyperlinked list of term mappings from WordNet.

Methods inherited from class java.lang.Object

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

Field Detail

htmlDivider

public static java.lang.String htmlDivider

kbHref

public static java.lang.String kbHref

language

public static java.lang.String language

availableFormalLanguages

public static java.util.ArrayList<java.lang.String> availableFormalLanguages

Constructor Detail

HTMLformatter

public HTMLformatter()

Method Detail

htmlDivider

public static java.lang.String htmlDivider(java.lang.String label)

Create the HTML for the labeled divider between the sections of the term display. Each section displays a sorted list of the Formulae for which a term appears in a specified argument position.

createKBHref

public static java.lang.String createKBHref(java.lang.String kbName,
                                            java.lang.String language)

Create the HTML for a kb link.

createHrefStart

public static java.lang.String createHrefStart()

Create the HTML for a link, taking care of http/https, hostname and port

proofTableFormat

public static java.lang.String proofTableFormat(java.lang.String query,
                                                ProofStep step,
                                                java.lang.String kbName,
                                                java.lang.String language)

Create the HTML for a single step in a proof.

processFormalLanguage

public static java.lang.String processFormalLanguage(java.lang.String flang)

processNaturalLanguage

public static java.lang.String processNaturalLanguage(java.lang.String lang,
                                                      KB kb)

termList

public static java.lang.String termList(java.util.ArrayList<java.lang.String> terms,
                                        java.lang.String kbHref)

Show a hyperlinked list of terms.

showStatistics

public static java.lang.String showStatistics(KB kb)

Show knowledge base statistics

showMap

public static java.lang.String showMap(KB kb,
                                       java.lang.String term)

Show a map if coordinates are given in the kb

showPictures

public static java.lang.String showPictures(KB kb,
                                            java.lang.String term)

Show knowledge base pictures

showNumberPictures

public static java.lang.String showNumberPictures(KB kb,
                                                  java.lang.String term,
                                                  int count)

Show knowledge base pictures

showNeighborTerms

public static java.lang.String showNeighborTerms(KB kb,
                                                 java.lang.String term)

showNeighborTerms

public static java.lang.String showNeighborTerms(KB kb,
                                                 java.lang.String nonRelTerm,
                                                 java.lang.String relTerm)

Show alphabetic list of neighbor terms

getAllRelTerms

public static java.util.ArrayList<java.lang.String> getAllRelTerms(KB kb,
                                                                   java.util.ArrayList<java.lang.String> matchesList)

getAllNonRelTerms

public static java.util.ArrayList<java.lang.String> getAllNonRelTerms(KB kb,
                                                                      java.util.ArrayList<java.lang.String> matchesList)

showREMatches

public static java.lang.String showREMatches(KB kb,
                                             java.lang.String relREmatch,
                                             java.lang.String nonRelREmatch,
                                             java.lang.String term)

Show list of 30 relation & nonRelation terms that contain a match to the input RE term. The inputed Strings relREmatch and nonRelREmatch are the two relation and nonRelation terms respectively that are the first terms at the top of the list. They are passed into the method to keep track of what 30 terms are being viewed.

termMappingsList

public static java.lang.String termMappingsList(java.lang.String terms,
                                                java.lang.String kbHref)

Show a hyperlinked list of term mappings from WordNet.

synsetList

public static java.lang.String synsetList(java.util.ArrayList<java.lang.String> synsets,
                                          java.lang.String kbHref)

Show a hyperlinked list of WordNet synsets.

formatFormulaList

public static java.lang.String formatFormulaList(java.util.ArrayList<Formula> forms,
                                                 java.lang.String header,
                                                 KB kb,
                                                 java.lang.String language,
                                                 java.lang.String flang,
                                                 int start,
                                                 int localLimit,
                                                 java.lang.String limitString)

Create the HTML for a section of the Sigma term browser page. Needs a ... enclosure to format HTML properly.

browserSectionFormatLimit

public static java.lang.String browserSectionFormatLimit(java.lang.String term,
                                                         java.lang.String header,
                                                         KB kb,
                                                         java.lang.String language,
                                                         java.lang.String flang,
                                                         int start,
                                                         int limit,
                                                         int arg,
                                                         java.lang.String type)

Create the HTML for a section of the Sigma term browser page.

browserSectionFormat

public static java.lang.String browserSectionFormat(java.lang.String term,
                                                    java.lang.String header,
                                                    KB kb,
                                                    java.lang.String language,
                                                    java.lang.String flang,
                                                    int arg,
                                                    java.lang.String type)

Create the HTML for a section of the Sigma term browser page.

encodeForURL

public static java.lang.String encodeForURL(java.lang.String s)

Change spaces to "%20" along with many other URL codes. (for passing regex expressions through hyperlinks)

decodeFromURL

public static java.lang.String decodeFromURL(java.lang.String s)

Change spaces to "%20"

encodeForHTML

public static java.lang.String encodeForHTML(java.lang.String s)

change reserved characters from '&' tags

decodeFromHTML

public static java.lang.String decodeFromHTML(java.lang.String s)

change reserved characters to '&' tags

createNumberedMenu

public static java.lang.String createNumberedMenu(java.lang.String menuName,
                                                  java.lang.String selectedOption,
                                                  java.util.ArrayList<java.lang.String> options)

Create an HTML menu, given an ArrayList of Strings where the value(s) are String representations of int(s) but the displayed menu items are String(s).

createMenu

public static java.lang.String createMenu(java.lang.String menuName,
                                          java.lang.String selectedOption,
                                          java.util.ArrayList<java.lang.String> options)

Create an HTML menu, given an ArrayList of Strings.

createKBMenu

public static java.lang.String createKBMenu(java.lang.String kbName)

Create an HTML menu of KB names

formatErrorsWarnings

public static java.lang.String formatErrorsWarnings(java.util.TreeSet<java.lang.String> list,
                                                    KB kb)

hyperlink formulas in error messages. It assumes that the errors are in and TreeSet of Strings in kb.errors. It further assumes that the error message is given first, followed by a colon, and then the axiom. There must be no other colon characters.

createMultiMenu

public static java.lang.String createMultiMenu(java.lang.String menuName,
                                               java.util.TreeMap<java.lang.String,java.lang.String> options)

Create an HTML menu with an ID, given an ArrayList of Strings, and possibly multiple selections.

createMenu

public static java.lang.String createMenu(java.lang.String menuName,
                                          java.lang.String selectedOption,
                                          java.util.ArrayList<java.lang.String> options,
                                          java.lang.String params)

Create an HTML menu with an ID, given an ArrayList of Strings.

formatProofResult

public static java.lang.String formatProofResult(java.lang.String result,
                                                 java.lang.String stmt,
                                                 java.lang.String processedStmt,
                                                 java.lang.String lineHtml,
                                                 java.lang.String kbName,
                                                 java.lang.String language)

Create an HTML formatted result of a query.

formatProofResult

public static java.lang.String formatProofResult(java.lang.String result,
                                                 java.lang.String stmt,
                                                 java.lang.String processedStmt,
                                                 java.lang.String lineHtml,
                                                 java.lang.String kbName,
                                                 java.lang.String language,
                                                 int answerOffset)

formatTPTP3ProofResult

public static java.lang.String formatTPTP3ProofResult(TPTP3ProofProcessor tpp,
                                                      java.lang.String stmt,
                                                      java.lang.String lineHtml,
                                                      java.lang.String kbName,
                                                      java.lang.String language)

formatProofResult

public static java.lang.String formatProofResult(java.util.ArrayList<BasicXMLelement> proof,
                                                 java.lang.String stmt,
                                                 java.lang.String processedStmt,
                                                 java.lang.String lineHtml,
                                                 java.lang.String kbName,
                                                 java.lang.String language,
                                                 int answerOffset)

formatConsistencyCheck

public static java.lang.String formatConsistencyCheck(java.lang.String msg,
                                                      java.lang.String ccheckResult,
                                                      java.lang.String language,
                                                      int page)

main

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