com.articulate.sigma

Class HTMLformatter

java.lang.Object

com.articulate.sigma.HTMLformatter

public class HTMLformatter
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayList<String>	availableFormalLanguages
static String	htmlDivider
static String	kbHref
static String	language

Constructor Summary

Constructors

Constructor and Description
HTMLformatter()

Method Summary

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

kbHref

public static String kbHref

language

public static String language

availableFormalLanguages

public static ArrayList<String> availableFormalLanguages

Constructor Detail

HTMLformatter

public HTMLformatter()

Method Detail

htmlDivider

public static String htmlDivider(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 String createKBHref(String kbName,
                                  String language)

Create the HTML for a single step in a proof.

proofTableFormat

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

Create the HTML for a single step in a proof.

processFormalLanguage

public static String processFormalLanguage(String flang)

processNaturalLanguage

public static String processNaturalLanguage(String lang,
                                            KB kb)

termList

public static String termList(ArrayList<String> terms,
                              String kbHref)

Show a hyperlinked list of terms.

showStatistics

public static String showStatistics(KB kb)

Show knowledge base statistics

showMap

public static String showMap(KB kb,
                             String term)

Show a map if coordinates are given in the kb

showPictures

public static String showPictures(KB kb,
                                  String term)

Show knowledge base pictures

showNumberPictures

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

Show knowledge base pictures

showNeighborTerms

public static String showNeighborTerms(KB kb,
                                       String term)

showNeighborTerms

public static String showNeighborTerms(KB kb,
                                       String nonRelTerm,
                                       String relTerm)

Show alphabetic list of neighbor terms

getAllRelTerms

public static ArrayList<String> getAllRelTerms(KB kb,
                                               ArrayList<String> matchesList)

getAllNonRelTerms

public static ArrayList<String> getAllNonRelTerms(KB kb,
                                                  ArrayList<String> matchesList)

showREMatches

public static String showREMatches(KB kb,
                                   String relREmatch,
                                   String nonRelREmatch,
                                   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 String termMappingsList(String terms,
                                      String kbHref)

Show a hyperlinked list of term mappings from WordNet.

synsetList

public static String synsetList(ArrayList<String> synsets,
                                String kbHref)

Show a hyperlinked list of WordNet synsets.

formatFormulaList

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

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

browserSectionFormatLimit

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

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

browserSectionFormat

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

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

encodeForURL

public static String encodeForURL(String s)

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

decodeFromURL

public static String decodeFromURL(String s)

Change spaces to "%20"

encodeForHTML

public static String encodeForHTML(String s)

change reserved characters from '&' tags

decodeFromHTML

public static String decodeFromHTML(String s)

change reserved characters to '&' tags

createNumberedMenu

public static String createNumberedMenu(String menuName,
                                        String selectedOption,
                                        ArrayList<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 String createMenu(String menuName,
                                String selectedOption,
                                ArrayList<String> options)

Create an HTML menu, given an ArrayList of Strings.

createKBMenu

public static String createKBMenu(String kbName)

Create an HTML menu of KB names

formatErrors

public static String formatErrors(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 String createMultiMenu(String menuName,
                                     TreeMap<String,String> options)

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

createMenu

public static String createMenu(String menuName,
                                String selectedOption,
                                ArrayList<String> options,
                                String params)

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

formatProofResult

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

Create an HTML formatted result of a query.

formatProofResult

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

formatTPTP3ProofResult

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

formatProofResult

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

formatConsistencyCheck

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

main

public static void main(String[] args)