uk.ac.ed.ph.snuggletex.upconversion

Class MathMLUpConverter

java.lang.Object

uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

public class MathMLUpConverter
extends Object

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().

Usage Notes

• If the up-conversion process fails because the input cannot be understood, you can find out what went wrong by passing the resulting Document to UpConversionUtilities.extractUpConversionFailures(Document), to get a List of UpConversionFailure Objects that can be inspected further.
• An implementation of this class is thread-safe
• If you use XSLT in your own application, consider using the constructor that takes a StylesheetCache to integrate with your own caching mechanism.
• If you don't use XSLT in your own application, you can use the default constructor that creates a cache used by the instance of this class. In this case, you'll want to ensure your instance has "application-wide" context to maximise performance.

Since:

1.1.0

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASCIIMATH_INPUT_ANNOTATION_NAME
static String	BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME
static String	CONTENT_FAILURES_ANNOTATION_NAME
static String	CONTENT_MATHML_ANNOTATION_NAME
static String	LATEX_ANNOTATION_NAME
static String	MAXIMA_ANNOTATION_NAME
static String	MAXIMA_FAILURES_ANNOTATION_NAME
static String	SNUGGLETEX_ANNOTATION_NAME

Constructor Summary

Constructors

Constructor and Description
MathMLUpConverter() Creates a new up-converter using a simple internal cache, hard-coded to use Saxon for XSLT 2.0 support.
MathMLUpConverter(StylesheetCache stylesheetCache) 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(StylesheetManager stylesheetManager) Creates a new up-converter using the given StylesheetManager for managing XSLT stylesheets and stuff.
MathMLUpConverter(TransformerFactoryChooser transformerFactoryChooser, StylesheetCache stylesheetCache) Creates a new up-converter using the given TransformerFactoryChooser and StylesheetCache to cache internal XSLT stylesheets.

Method Summary

Modifier and Type	Method and Description
Document	upConvertASCIIMathML(Document asciiMathMLDocument, UpConversionOptions upConversionOptions) Up-converts the ASCIIMathML output represented by the given Document.
Document	upConvertASCIIMathML(String rawASCIIMathML, UpConversionOptions upConversionOptions) Convenience version of upConvertASCIIMathML(Document, UpConversionOptions) that takes the raw ASCIIMathML as a String.
Document	upConvertSnuggleTeXMathML(Document document, UpConversionOptions upConversionOptions) Up-converts the SnuggleTeX XHTML output Document (assumed to contain islands of MathML), creating a new result Document.

Methods inherited from class java.lang.Object

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

Field Detail

SNUGGLETEX_ANNOTATION_NAME

public static final String SNUGGLETEX_ANNOTATION_NAME

See Also:

Constant Field Values

LATEX_ANNOTATION_NAME

public static final String LATEX_ANNOTATION_NAME

See Also:

Constant Field Values

BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME

public static final String BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME

See Also:

Constant Field Values

CONTENT_MATHML_ANNOTATION_NAME

public static final String CONTENT_MATHML_ANNOTATION_NAME

See Also:

Constant Field Values

CONTENT_FAILURES_ANNOTATION_NAME

public static final String CONTENT_FAILURES_ANNOTATION_NAME

See Also:

Constant Field Values

MAXIMA_ANNOTATION_NAME

public static final String MAXIMA_ANNOTATION_NAME

See Also:

Constant Field Values

MAXIMA_FAILURES_ANNOTATION_NAME

public static final String MAXIMA_FAILURES_ANNOTATION_NAME

See Also:

Constant Field Values

ASCIIMATH_INPUT_ANNOTATION_NAME

public static final String ASCIIMATH_INPUT_ANNOTATION_NAME

See Also:

Constant Field Values

Constructor Detail

MathMLUpConverter

public MathMLUpConverter()

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

Use this constructor if you don't use XSLT yourself. In this case, you'll want your instance of this class to be reused as much as possible to get the benefits of caching.

MathMLUpConverter

public MathMLUpConverter(StylesheetCache stylesheetCache)

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

Use this constructor if you do your own XSLT caching that you want to integrate in, or if the default doesn't do what you want.

MathMLUpConverter

public MathMLUpConverter(TransformerFactoryChooser transformerFactoryChooser,
                         StylesheetCache stylesheetCache)

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

Use this constructor if you do your own XSLT caching that you want to integrate in, or if the default doesn't do what you want and/or if you want to override the choice of Saxon for XSLT 2.0 support (which is currently a bad idea!)

Parameters:

transformerFactoryChooser - TransformerFactoryChooser to use, which must not be null.

stylesheetCache - StylesheetCache to use, which may be null to avoid caching.

MathMLUpConverter

public MathMLUpConverter(StylesheetManager stylesheetManager)

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

Method Detail

upConvertSnuggleTeXMathML

public Document upConvertSnuggleTeXMathML(Document document,
                                          UpConversionOptions upConversionOptions)

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

Parameters:

document - DOM Document, assumed to have been generated by SnuggleSession.buildDOMSubtree() or similar.

upConversionOptions - UpConversionOptions to use, or null to use defaults.

upConvertASCIIMathML

public Document upConvertASCIIMathML(Document asciiMathMLDocument,
                                     UpConversionOptions upConversionOptions)

Up-converts the ASCIIMathML output represented by the given Document. This would normally consist of a single MathML element, but can be arbitrary XML containing MathML islands.

Parameters:

asciiMathMLDocument - DOM Document, assumed to have been generated by ASCIIMathML

upConversionOptions - UpConversionOptions to use, or null to use defaults.

upConvertASCIIMathML

public Document upConvertASCIIMathML(String rawASCIIMathML,
                                     UpConversionOptions upConversionOptions)

Convenience version of upConvertASCIIMathML(Document, UpConversionOptions) that takes the raw ASCIIMathML as a String. You would normally extract this from ASCIIMathML using some of our JavaScript helper functions.

Parameters:

rawASCIIMathML - ASCIIMathML output string

upConversionOptions - UpConversionOptions to use, or null to use defaults.