SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.upconversion.MathMLUpConverter

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.

Field Summary

Modifier and Type	Field and Description
private static final String	ASCIIMATH_FIXER_XSL_LOCATION Location of the initial XSLT for fixing up ASCIIMathML
public static final String	ASCIIMATH_INPUT_ANNOTATION_NAME
public static final String	BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME
public static final String	CONTENT_FAILURES_ANNOTATION_NAME
public static final String	CONTENT_MATHML_ANNOTATION_NAME
public static final String	LATEX_ANNOTATION_NAME
public static final String	MAXIMA_ANNOTATION_NAME
public static final String	MAXIMA_FAILURES_ANNOTATION_NAME
public static final String	SNUGGLETEX_ANNOTATION_NAME
private final StylesheetManager	stylesheetManager Helper to manage the `StylesheetCache`
private static final String	UPCONVERTER_BASE_LOCATION "Base" location for the XSLT stylesheets used here
private static final String	UPCONVERTER_XSL_LOCATION Location of the main up-converting XSLT

Constructor Summary

Access	Constructor and Description
public	MathMLUpConverter() Creates a new up-converter using a simple internal cache, hard-coded to use Saxon for XSLT 2.0 support.
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.
public	MathMLUpConverter(final TransformerFactoryChooser `TransformerFactoryChooser` to use, which must not be null. transformerFactoryChooser, StylesheetCache `StylesheetCache` to use, which may be null to avoid caching. stylesheetCache) Creates a new up-converter using the given `TransformerFactoryChooser` and `StylesheetCache` to cache internal XSLT stylesheets.
public	MathMLUpConverter(StylesheetManager stylesheetManager) Creates a new up-converter using the given `StylesheetManager` for managing XSLT stylesheets and stuff.

Method Summary

Modifier and Type	Method and Description
private Element	createUpConversionOptionsElement(final UpConversionOptions upConversionOptions) DEVELOPER NOTE: I have included the default value for this parameter within the XSLT as well so that people can reuse it easier in a standalone fashion.
public Document	upConvertASCIIMathML(final Document DOM `Document`, assumed to have been generated by ASCIIMathML asciiMathMLDocument, final UpConversionOptions `UpConversionOptions` to use, or null to use defaults. upConversionOptions) Up-converts the ASCIIMathML output represented by the given `Document`.
public Document	upConvertASCIIMathML(final String ASCIIMathML output string rawASCIIMathML, final UpConversionOptions `UpConversionOptions` to use, or null to use defaults. upConversionOptions) Convenience version of `upConvertASCIIMathML(Document, UpConversionOptions)` that takes the raw ASCIIMathML as a String.
public Document	upConvertSnuggleTeXMathML(final Document DOM `Document`, assumed to have been generated by `SnuggleSession#buildDOMSubtree()` or similar. document, final UpConversionOptions `UpConversionOptions` to use, or null to use defaults. upConversionOptions) Up-converts the SnuggleTeX XHTML output Document (assumed to contain islands of MathML), creating a new result `Document`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ASCIIMATH_FIXER_XSL_LOCATION	back to summary
private static final String ASCIIMATH_FIXER_XSL_LOCATION Location of the initial XSLT for fixing up ASCIIMathML

ASCIIMATH_INPUT_ANNOTATION_NAME	back to summary
public static final String ASCIIMATH_INPUT_ANNOTATION_NAME

BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME	back to summary
public static final String BRACKETED_PRESENTATION_MATHML_ANNOTATION_NAME

CONTENT_FAILURES_ANNOTATION_NAME	back to summary
public static final String CONTENT_FAILURES_ANNOTATION_NAME

CONTENT_MATHML_ANNOTATION_NAME	back to summary
public static final String CONTENT_MATHML_ANNOTATION_NAME

LATEX_ANNOTATION_NAME	back to summary
public static final String LATEX_ANNOTATION_NAME

MAXIMA_ANNOTATION_NAME	back to summary
public static final String MAXIMA_ANNOTATION_NAME

MAXIMA_FAILURES_ANNOTATION_NAME	back to summary
public static final String MAXIMA_FAILURES_ANNOTATION_NAME

SNUGGLETEX_ANNOTATION_NAME	back to summary
public static final String SNUGGLETEX_ANNOTATION_NAME

stylesheetManager	back to summary
private final StylesheetManager stylesheetManager Helper to manage the `StylesheetCache`

UPCONVERTER_BASE_LOCATION	back to summary
private static final String UPCONVERTER_BASE_LOCATION "Base" location for the XSLT stylesheets used here

UPCONVERTER_XSL_LOCATION	back to summary
private static final String UPCONVERTER_XSL_LOCATION Location of the main up-converting XSLT

Constructor Detail

MathMLUpConverter	back to summary
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

back to summary

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 back to summary

MathMLUpConverter	back to summary
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.

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 back to summary

MathMLUpConverter	back to summary
public MathMLUpConverter(final 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 `TransformerFactoryChooser` to use, which must not be null. stylesheetCache:StylesheetCache `StylesheetCache` to use, which may be null to avoid caching.

public MathMLUpConverter(final 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: TransformerFactoryChooser to use, which must not be null.
stylesheetCache:StylesheetCache: StylesheetCache to use, which may be null to avoid caching.

MathMLUpConverter	back to summary
public MathMLUpConverter(StylesheetManager stylesheetManager) Creates a new up-converter using the given `StylesheetManager` for managing XSLT stylesheets and stuff.

Method Detail

createUpConversionOptionsElement	back to summary
private Element createUpConversionOptionsElement(final UpConversionOptions upConversionOptions) DEVELOPER NOTE: I have included the default value for this parameter within the XSLT as well so that people can reuse it easier in a standalone fashion. Make sure you update the XSLT if any of the defaults change here.

upConvertASCIIMathML back to summary

upConvertASCIIMathML	back to summary
public Document upConvertASCIIMathML(final Document asciiMathMLDocument, final 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:Document DOM `Document`, assumed to have been generated by ASCIIMathML upConversionOptions:UpConversionOptions `UpConversionOptions` to use, or null to use defaults.

public Document upConvertASCIIMathML(final Document asciiMathMLDocument, final 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:Document: DOM Document, assumed to have been generated by ASCIIMathML
upConversionOptions:UpConversionOptions: UpConversionOptions to use, or null to use defaults.

upConvertASCIIMathML back to summary

upConvertASCIIMathML	back to summary
public Document upConvertASCIIMathML(final String rawASCIIMathML, final 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:String ASCIIMathML output string upConversionOptions:UpConversionOptions `UpConversionOptions` to use, or null to use defaults.

public Document upConvertASCIIMathML(final String rawASCIIMathML, final 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:String: ASCIIMathML output string
upConversionOptions:UpConversionOptions: UpConversionOptions to use, or null to use defaults.

upConvertSnuggleTeXMathML back to summary

upConvertSnuggleTeXMathML	back to summary
public Document upConvertSnuggleTeXMathML(final Document document, final UpConversionOptions upConversionOptions) Up-converts the SnuggleTeX XHTML output Document (assumed to contain islands of MathML), creating a new result `Document`. Parameters document:Document DOM `Document`, assumed to have been generated by `SnuggleSession#buildDOMSubtree()` or similar. upConversionOptions:UpConversionOptions `UpConversionOptions` to use, or null to use defaults.

public Document upConvertSnuggleTeXMathML(final Document document, final UpConversionOptions upConversionOptions)

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

Parameters

document:Document: DOM Document, assumed to have been generated by SnuggleSession#buildDOMSubtree() or similar.
upConversionOptions:UpConversionOptions: UpConversionOptions to use, or null to use defaults.

public Class MathMLUpConverter

Usage Notes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail