uk.ac.ed.ph.snuggletex.upconversion

Class UpConversionUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.upconversion.UpConversionUtilities

public final class UpConversionUtilities
extends Object

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

Since:

1.1.0

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPCONVERSION_OPTIONS_XML_LOCAL_NAME Local name of XML container element when writing out options using appendUpConversionOptionsElement(Document, Element, UpConversionOptions, boolean)

Constructor Summary

Constructors

Constructor and Description
UpConversionUtilities()

Method Summary

Modifier and Type	Method and Description
static void	appendUpConversionOptionsElement(Document document, Element containerElement, UpConversionOptions options, boolean applyDefaults) Writes out the given UpConversionOptions Object as a child Element of the given element, using a simple ad-hoc XML format.
static UpConversionFailure	extractUpConversionFailure(Element sFailElement) Populates and returns an UpConversionFailure for the given Element, which is assumed to be a s:fail element having the appropriate structure.
static List<UpConversionFailure>	extractUpConversionFailures(Document upConvertedDocument) Searches the given DOM Document for all s:fail elements contained therein.
static List<UpConversionFailure>	extractUpConversionFailures(Element startSearchElement) Searches the given DOM Element and all its descendents for all s:fail elements contained therein.
static List<UpConversionFailure>	extractUpConversionFailures(UnwrappedParallelMathMLDOM unwrappedDocument) Extracts all of the s:fail elements within the given UnwrappedParallelMathMLDOM
static String	getErrorMessage(String upConversionErrorCodeAsString, Object... arguments) Returns a full error message for the given UpConversionErrorCode String and arguments, using the SnuggleTeX MessageFormatter class to do the hard work.
static String	getErrorMessage(UpConversionFailure failure) Returns a full error message for the given UpConversionFailure, using the SnuggleTeX MessageFormatter class to do the hard work.
static boolean	isUpConversionFailureElement(Node node) Checks to see whether the given DOM Node is an s:fail element.

Methods inherited from class java.lang.Object

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

Field Detail

UPCONVERSION_OPTIONS_XML_LOCAL_NAME

public static final String UPCONVERSION_OPTIONS_XML_LOCAL_NAME

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

See Also:

Constant Field Values

Constructor Detail

UpConversionUtilities

public UpConversionUtilities()

Method Detail

getErrorMessage

public static String getErrorMessage(UpConversionFailure failure)

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

Parameters:

failure -

getErrorMessage

public static String getErrorMessage(String upConversionErrorCodeAsString,
                                     Object... arguments)

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

extractUpConversionFailure

public static UpConversionFailure extractUpConversionFailure(Element sFailElement)

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

Parameters:

sFailElement -

extractUpConversionFailures

public static List<UpConversionFailure> extractUpConversionFailures(UnwrappedParallelMathMLDOM unwrappedDocument)

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

Since:

1.3.0

extractUpConversionFailures

public static List<UpConversionFailure> extractUpConversionFailures(Document upConvertedDocument)

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

extractUpConversionFailures

public static List<UpConversionFailure> extractUpConversionFailures(Element startSearchElement)

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

isUpConversionFailureElement

public static boolean isUpConversionFailureElement(Node node)

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

Since:

1.3.0

appendUpConversionOptionsElement

public static void appendUpConversionOptionsElement(Document document,
                                                    Element containerElement,
                                                    UpConversionOptions options,
                                                    boolean applyDefaults)

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

This is used internally to pass Java-specified options to the stylesheets that perform the up-conversion process and may be useful in other situations as well.

Parameters:

document - Document to append to

containerElement - Element that will be the parent of the resulting DOM fragment

options - UpConversionOptions to write, may be null.

applyDefaults - if true, then default values for each option are written out when not explicitly specified or if UpConversionOptions is null.

Since:

1.2.0