uk.ac.ed.ph.snuggletex.upconversion

类 UpConversionUtilities

java.lang.Object

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

public final class UpConversionUtilities
extends java.lang.Object

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

从以下版本开始:

1.1.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	UPCONVERSION_OPTIONS_XML_LOCAL_NAME Local name of XML container element when writing out options using appendUpConversionOptionsElement(Document, Element, UpConversionOptions, boolean)

构造器概要

构造器

构造器和说明
UpConversionUtilities()

方法概要

限定符和类型	方法和说明
static void	appendUpConversionOptionsElement(org.w3c.dom.Document document, org.w3c.dom.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(org.w3c.dom.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 java.util.List<UpConversionFailure>	extractUpConversionFailures(org.w3c.dom.Document upConvertedDocument) Searches the given DOM Document for all s:fail elements contained therein.
static java.util.List<UpConversionFailure>	extractUpConversionFailures(org.w3c.dom.Element startSearchElement) Searches the given DOM Element and all its descendents for all s:fail elements contained therein.
static java.util.List<UpConversionFailure>	extractUpConversionFailures(uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM unwrappedDocument) Extracts all of the s:fail elements within the given UnwrappedParallelMathMLDOM
static java.lang.String	getErrorMessage(java.lang.String upConversionErrorCodeAsString, java.lang.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 java.lang.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(org.w3c.dom.Node node) Checks to see whether the given DOM Node is an s:fail element.

从类继承的方法 java.lang.Object

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

字段详细资料

UPCONVERSION_OPTIONS_XML_LOCAL_NAME

public static final java.lang.String UPCONVERSION_OPTIONS_XML_LOCAL_NAME

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

另请参阅:

常量字段值

构造器详细资料

UpConversionUtilities

public UpConversionUtilities()

方法详细资料

getErrorMessage

public static java.lang.String getErrorMessage(UpConversionFailure failure)

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

参数:

failure -

getErrorMessage

public static java.lang.String getErrorMessage(java.lang.String upConversionErrorCodeAsString,
                                               java.lang.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(org.w3c.dom.Element sFailElement)

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

参数:

sFailElement -

extractUpConversionFailures

public static java.util.List<UpConversionFailure> extractUpConversionFailures(uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM unwrappedDocument)

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

从以下版本开始:

1.3.0

extractUpConversionFailures

public static java.util.List<UpConversionFailure> extractUpConversionFailures(org.w3c.dom.Document upConvertedDocument)

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

extractUpConversionFailures

public static java.util.List<UpConversionFailure> extractUpConversionFailures(org.w3c.dom.Element startSearchElement)

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

isUpConversionFailureElement

public static boolean isUpConversionFailureElement(org.w3c.dom.Node node)

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

从以下版本开始:

1.3.0

appendUpConversionOptionsElement

public static void appendUpConversionOptionsElement(org.w3c.dom.Document document,
                                                    org.w3c.dom.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.

参数:

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.

从以下版本开始:

1.2.0