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

Modifier and Type	Field and Description
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)`

Access	Constructor and Description
public	UpConversionUtilities()

Method Summary

Modifier and Type	Method and Description
private static Element	appendSnuggleElement(Document document, Element parentElement, String localName)
public static void	appendUpConversionOptionsElement(Document Document to append to document, Element Element that will be the parent of the resulting DOM fragment containerElement, final UpConversionOptions `UpConversionOptions` to write, may be null. options, final boolean if true, then default values for each option are written out when not explicitly specified or if `UpConversionOptions` is null. applyDefaults) Writes out the given `UpConversionOptions` Object as a child Element of the given element, using a simple ad-hoc XML format.
public static UpConversionFailure	extractUpConversionFailure(final Element sFailElement) Populates and returns an `UpConversionFailure` for the given `Element`, which is assumed to be a `s:fail` element having the appropriate structure.
public static List<UpConversionFailure>	extractUpConversionFailures(UnwrappedParallelMathMLDOM unwrappedDocument) Extracts all of the `s:fail` elements within the given `UnwrappedParallelMathMLDOM`
private static void	extractUpConversionFailures(NodeList failureAnnotationContent, List<UpConversionFailure> resultBuilder)
public static List<UpConversionFailure>	extractUpConversionFailures(Document upConvertedDocument) Searches the given DOM `Document` for all `s:fail` elements contained therein.
public static List<UpConversionFailure>	extractUpConversionFailures(Element startSearchElement) Searches the given DOM `Element` and all its descendents for all `s:fail` elements contained therein.
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.
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.
public static boolean	isUpConversionFailureElement(Node node) Checks to see whether the given DOM Node is an `s:fail` element.
private static void	walkDOM(Element searchElement, List<UpConversionFailure> resultBuilder) Checks to see whether the given element is of the form: `<![CDATA[ <s:fail code="...`

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

UPCONVERSION_OPTIONS_XML_LOCAL_NAME	back to summary
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)`

UpConversionUtilities	back to summary
public UpConversionUtilities()

Method Detail

appendSnuggleElement	back to summary
private static Element appendSnuggleElement(Document document, Element parentElement, String localName)

appendUpConversionOptionsElement back to summary

appendUpConversionOptionsElement	back to summary
public static void appendUpConversionOptionsElement(Document document, Element containerElement, final UpConversionOptions options, final 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 Document to append to containerElement:Element Element that will be the parent of the resulting DOM fragment options:UpConversionOptions `UpConversionOptions` to write, may be null. applyDefaults:boolean if true, then default values for each option are written out when not explicitly specified or if `UpConversionOptions` is null. Since 1.2.0

public static void appendUpConversionOptionsElement(Document document, Element containerElement, final UpConversionOptions options, final 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: Document to append to
containerElement:Element: Element that will be the parent of the resulting DOM fragment
options:UpConversionOptions: UpConversionOptions to write, may be null.
applyDefaults:boolean: if true, then default values for each option are written out when not explicitly specified or if UpConversionOptions is null.

Since

1.2.0

extractUpConversionFailure	back to summary
public static UpConversionFailure extractUpConversionFailure(final Element sFailElement) Populates and returns an `UpConversionFailure` for the given `Element`, which is assumed to be a `s:fail` element having the appropriate structure.

extractUpConversionFailures back to summary

extractUpConversionFailures	back to summary
public static List<UpConversionFailure> extractUpConversionFailures(UnwrappedParallelMathMLDOM unwrappedDocument) Extracts all of the `s:fail` elements within the given `UnwrappedParallelMathMLDOM` Since 1.3.0

public static List<UpConversionFailure> extractUpConversionFailures(UnwrappedParallelMathMLDOM unwrappedDocument)

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

Since: 1.3.0

extractUpConversionFailures	back to summary
private static void extractUpConversionFailures(NodeList failureAnnotationContent, List<UpConversionFailure> resultBuilder)

extractUpConversionFailures	back to summary
public static List<UpConversionFailure> extractUpConversionFailures(Document upConvertedDocument) Searches the given DOM `Document` for all `s:fail` elements contained therein.

extractUpConversionFailures	back to summary
public static List<UpConversionFailure> extractUpConversionFailures(Element startSearchElement) Searches the given DOM `Element` and all its descendents for all `s:fail` elements contained therein.

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

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

isUpConversionFailureElement back to summary

isUpConversionFailureElement	back to summary
public static boolean isUpConversionFailureElement(Node node) Checks to see whether the given DOM Node is an `s:fail` element. Since 1.3.0

public static boolean isUpConversionFailureElement(Node node)

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

Since: 1.3.0

walkDOM back to summary

walkDOM	back to summary
private static void walkDOM(Element searchElement, List<UpConversionFailure> resultBuilder) Checks to see whether the given element is of the form: `<![CDATA[ <s:fail code="..."> <s:arg>...</s:arg> ... <s:context>...</s:context> </s:fail> ]]>` <![CDATA[ <s:fail code="..."> <s:arg>...</s:arg> ... <s:context>...</s:context> </s:fail> ]]> If so, creates an `UpConversionFailure` for this and adds to the result. If not, traverses downwards recursively.

private static void walkDOM(Element searchElement, List<UpConversionFailure> resultBuilder)

Checks to see whether the given element is of the form:

<![CDATA[
<s:fail code="...">
  <s:arg>...</s:arg>
  ...
  <s:context>...</s:context>
</s:fail>
]]>

If so, creates an UpConversionFailure for this and adds to the result. If not, traverses downwards recursively.

public final Class UpConversionUtilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail