A B C D E G H I L M O P R S T U V

A

ADD_OPTIONS_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

appendUpConversionOptionsElement(Document, Element, UpConversionOptions, boolean) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Writes out the given UpConversionOptions Object as a child Element of the given element, using a simple ad-hoc XML format.

ASCIIMATH_INPUT_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

ASCIIMathMLUpConversionExample - Class in uk.ac.ed.ph.snuggletex.upconversion.samples

Simple demonstration of how to use some of the utilities within SnuggleTeX to up-convert some raw MathML extracted from ASCIIMathML.

ASCIIMathMLUpConversionExample() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.samples.ASCIIMathMLUpConversionExample

assumeSymbol(Element, String) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

AssumeSymbolHandler - Class in uk.ac.ed.ph.snuggletex.upconversion.internal

Handler for the \\assumeSymbol{target}{property} command.

AssumeSymbolHandler() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.internal.AssumeSymbolHandler

AssumptionExample - Class in uk.ac.ed.ph.snuggletex.upconversion.samples

Basic example of up-converting some simple LaTeX input to Content MathML and Maxima forms.

AssumptionExample() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.samples.AssumptionExample

B

BasicUpConversionExample - Class in uk.ac.ed.ph.snuggletex.upconversion.samples

Basic example of up-converting some simple LaTeX input to Content MathML and Maxima forms.

BasicUpConversionExample() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.samples.BasicUpConversionExample

BOOLEAN_VALUES - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

Defines the value space for booleans

BRACKET_HANDLING_VALUES - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

Defines the values space for handling brackets

BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

C

clearSpecifiedOption(String) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

clone() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

CONTENT_FAILURES_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

CONTENT_MATHML_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

CURLY_FENCE_HANDLING - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

D

DO_BRACKETED_PRESENTATION_MATHML - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

DO_CONTENT_MATHML_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

DO_MAXIMA_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

E

ElementWrapper - Class in uk.ac.ed.ph.snuggletex.upconversion

Trivial "wrapper" for a DOM Element that makes it suitable for storing in a Map.

ElementWrapper(Element) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.ElementWrapper

EMPTY_FENCE_HANDLING - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

equals(Object) - Method in class uk.ac.ed.ph.snuggletex.upconversion.ElementWrapper

ERROR_MESSAGES_PROPERTIES_BASENAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.internal.UpConversionPackageDefinitions

Location of ResourceBundle providing error messages for this bundle

extractUpConversionFailure(Element) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Populates and returns an UpConversionFailure for the given Element, which is assumed to be a s:fail element having the appropriate structure.

extractUpConversionFailures(UnwrappedParallelMathMLDOM) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Extracts all of the s:fail elements within the given UnwrappedParallelMathMLDOM

extractUpConversionFailures(Document) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Searches the given DOM Document for all s:fail elements contained therein.

extractUpConversionFailures(Element) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Searches the given DOM Element and all its descendents for all s:fail elements contained therein.

G

getArguments() - Method in exception uk.ac.ed.ph.snuggletex.upconversion.IllegalUpconversionOptionException

getArguments() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

getAssumedSymbols() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getContext() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

getDefaultValue() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions.OptionValueDefinition

getEffectiveOptionValue(String, boolean) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getErrorCode() - Method in exception uk.ac.ed.ph.snuggletex.upconversion.IllegalUpconversionOptionException

getErrorCode() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

getErrorGroup() - Method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorCode

getErrorMessage(UpConversionFailure) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Returns a full error message for the given UpConversionFailure, using the SnuggleTeX MessageFormatter class to do the hard work.

getErrorMessage(String, Object...) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Returns a full error message for the given UpConversionErrorCode String and arguments, using the SnuggleTeX MessageFormatter class to do the hard work.

getName() - Method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorCode

getName() - Method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorGroup

getPackage() - Static method in class uk.ac.ed.ph.snuggletex.upconversion.internal.UpConversionPackageDefinitions

getPackage() - Method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorGroup

getSpecifiedOptionNames() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getSpecifiedOptionValue(String) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getSymbolAssumptionType(Element) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getSymbolAssumptionType(ElementWrapper) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

getSymbolElement() - Method in class uk.ac.ed.ph.snuggletex.upconversion.ElementWrapper

getUpconversionOptions() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConvertingPostProcessor

getValueSpace() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions.OptionValueDefinition

getXPath() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

H

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.upconversion.internal.AssumeSymbolHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.upconversion.internal.SetUpConversionOptionHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.upconversion.internal.UnassumeSymbolHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.upconversion.internal.UnsetUpConversionOptionHandler

hashCode() - Method in class uk.ac.ed.ph.snuggletex.upconversion.ElementWrapper

I

IllegalUpconversionOptionException - Exception in uk.ac.ed.ph.snuggletex.upconversion

This Exception is thrown when an attempt is made to set an illegal assertion, option or value using the UpConversionOptions API.

IllegalUpconversionOptionException(UpConversionErrorCode, String...) - Constructor for exception uk.ac.ed.ph.snuggletex.upconversion.IllegalUpconversionOptionException

isOptionSpecified(String) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

isUpConversionFailureElement(Node) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Checks to see whether the given DOM Node is an s:fail element.

L

LATEX_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

M

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.samples.ASCIIMathMLUpConversionExample

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.samples.AssumptionExample

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.upconversion.samples.BasicUpConversionExample

MathMLUpConverter - Class in uk.ac.ed.ph.snuggletex.upconversion

Standalone utility class for "up-converting" MathML Documents created by either SnuggleTeX or ASCIIMathML as follows: Presentation MathML is "enhanced" with extra semantics Conversion to Content MathML is optionally attempted (assuming PMathML follows certain conventions) Conversion to Maxima input is optionally attempted (assuming PMathML follows certain conventions) This can be invoked within the normal SnuggleTeX parsing process using by adding a UpConvertingPostProcessor to the List returned by DOMOutputOptions.getDOMPostProcessors().

MathMLUpConverter() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Creates a new up-converter using a simple internal cache, hard-coded to use Saxon for XSLT 2.0 support.

MathMLUpConverter(StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Creates a new up-converter using the given StylesheetCache to cache internal XSLT stylesheets, hard-coded to use Saxon for XSLT 2.0 support.

MathMLUpConverter(TransformerFactoryChooser, StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Creates a new up-converter using the given TransformerFactoryChooser and StylesheetCache to cache internal XSLT stylesheets.

MathMLUpConverter(StylesheetManager) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Creates a new up-converter using the given StylesheetManager for managing XSLT stylesheets and stuff.

MAXIMA_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

MAXIMA_FAILURES_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

MAXIMA_INVERSE_FUNCTION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

MAXIMA_OPERATOR_FUNCTION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

MAXIMA_UNITS_FUNCTION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

O

OPTION_DEFINITIONS - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

Defines all of the allowed options for controlling the up-conversion process.

OPTIONS_VARIABLE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

OptionValueDefinition(Set<String>, String) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions.OptionValueDefinition

P

postProcessDOM(Document, DOMOutputOptions, StylesheetManager) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConvertingPostProcessor

R

ROUND_BRACKET_HANDLING - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

ROUND_FENCE_HANDLING - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

S

setSpecifiedOption(String, String) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

SetUpConversionOptionHandler - Class in uk.ac.ed.ph.snuggletex.upconversion.internal

Handler for the \\setUpConversionOption{name}{value} command.

SetUpConversionOptionHandler() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.internal.SetUpConversionOptionHandler

setUpconversionOptions(UpConversionOptions) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConvertingPostProcessor

SNUGGLETEX_ANNOTATION_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

SQUARE_FENCE_HANDLING - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

SYMBOL_ASSUMPTION_TYPES - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

T

toString() - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

U

uk.ac.ed.ph.snuggletex.upconversion - package uk.ac.ed.ph.snuggletex.upconversion

uk.ac.ed.ph.snuggletex.upconversion.internal - package uk.ac.ed.ph.snuggletex.upconversion.internal

uk.ac.ed.ph.snuggletex.upconversion.samples - package uk.ac.ed.ph.snuggletex.upconversion.samples

unassumeSymbol(Element) - Method in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

UnassumeSymbolHandler - Class in uk.ac.ed.ph.snuggletex.upconversion.internal

Handler for the \\unassumeSymbol{target} command.

UnassumeSymbolHandler() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.internal.UnassumeSymbolHandler

UnsetUpConversionOptionHandler - Class in uk.ac.ed.ph.snuggletex.upconversion.internal

Handler for the \\unsetUpConversionOption{name} command.

UnsetUpConversionOptionHandler() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.internal.UnsetUpConversionOptionHandler

UPCONVERSION_OPTIONS_XML_LOCAL_NAME - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

Local name of XML container element when writing out options using UpConversionUtilities.appendUpConversionOptionsElement(Document, Element, UpConversionOptions, boolean)

UPCONVERSION_VARIABLE_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

UpConversionErrorCode - Enum in uk.ac.ed.ph.snuggletex.upconversion

Enumerates the various types of client-induced errors that can arise when using the SnuggleTeX Up-Conversion process.

UpConversionErrorGroup - Enum in uk.ac.ed.ph.snuggletex.upconversion

Enumerates the various ErrorGroups for the up-conversion module.

UpConversionFailure - Class in uk.ac.ed.ph.snuggletex.upconversion

This is the equivalent of an InputError for the up-conversion process, indicating that a particular island of Presentation MathML created by SnuggleTeX could not be up-converted to either Content MathML or Maxima input form.

UpConversionFailure(ErrorCode, String, String, Object[]) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConversionFailure

UpConversionOptionDefinitions - Class in uk.ac.ed.ph.snuggletex.upconversion

Defines the various options and values for the up-conversion process.

UpConversionOptionDefinitions() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptionDefinitions

UpConversionOptionDefinitions.OptionValueDefinition - Class in uk.ac.ed.ph.snuggletex.upconversion

Defines the default and allowed values for a particular Option.

UpConversionOptions - Class in uk.ac.ed.ph.snuggletex.upconversion

Encapsulates the various options and assumptions that can be used when running the up-conversion process.

UpConversionOptions() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConversionOptions

UpConversionPackageDefinitions - Class in uk.ac.ed.ph.snuggletex.upconversion.internal

This defines the SnugglePackage providing up-conversion functionality.

UpConversionPackageDefinitions() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.internal.UpConversionPackageDefinitions

UpConversionUtilities - Class in uk.ac.ed.ph.snuggletex.upconversion

Some static utility methods for the up-conversion process, including methods for extracting errors.

UpConversionUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

upConvertASCIIMathML(Document, UpConversionOptions) - Method in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Up-converts the ASCIIMathML output represented by the given Document.

upConvertASCIIMathML(String, UpConversionOptions) - Method in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Convenience version of MathMLUpConverter.upConvertASCIIMathML(Document, UpConversionOptions) that takes the raw ASCIIMathML as a String.

UpConvertingPostProcessor - Class in uk.ac.ed.ph.snuggletex.upconversion

Implementation of DOMPostProcessor that bootstraps into MathMLUpConverter, providing the functionality offered by it.

UpConvertingPostProcessor() - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConvertingPostProcessor

UpConvertingPostProcessor(UpConversionOptions) - Constructor for class uk.ac.ed.ph.snuggletex.upconversion.UpConvertingPostProcessor

upConvertSnuggleTeXMathML(Document, UpConversionOptions) - Method in class uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

Up-converts the SnuggleTeX XHTML output Document (assumed to contain islands of MathML), creating a new result Document.

V

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorGroup

Returns the enum constant of this type with the specified name.

values() - Static method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.upconversion.UpConversionErrorGroup

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I L M O P R S T U V