uk.ac.ed.ph.snuggletex.utilities

类 MathMLUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

public final class MathMLUtilities
extends java.lang.Object

Some general utility methods for manipulating MathML via the DOM.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ANNOTATION_LOCAL_NAME
static java.lang.String	ANNOTATION_XML_LOCAL_NAME

构造器概要

构造器

构造器和说明
MathMLUtilities()

方法概要

限定符和类型	方法和说明
static void	convertExplicitFencesToMfenced(org.w3c.dom.Document document) Converts explicit fences generated by SnuggleTeX back to mfenced.
static void	convertMfencedToExplicitFences(org.w3c.dom.Document document) Replaces every deprecated MathML mfenced element in the supplied document with its explicit mrow/mo equivalent.
static void	ensureMathMLContainer(org.w3c.dom.Element mathElement)
static org.w3c.dom.Element	ensureMathMLDocument(org.w3c.dom.Document document) Checks that the given DOM Document contains a single MathML math Element.
static java.lang.String	extractAnnotationString(org.w3c.dom.Element mathElement, java.lang.String encodingAttribute) Extracts the first textual annotation found having the given encoding attribute from the given MathML math element, if such an annotation is found.
static org.w3c.dom.NodeList	extractAnnotationXML(org.w3c.dom.Element mathElement, java.lang.String encodingAttribute) Extracts the first XML-based annotation having the given encoding attribute from the given MathML math element, if such an annotation is found.
static org.w3c.dom.Element	extractFirstSemanticsBranch(org.w3c.dom.Element mathElement)
static boolean	isMathMLElement(org.w3c.dom.Node node) Convenience method to test whether the given DOM Node node is a MathML element having any localName.
static boolean	isMathMLElement(org.w3c.dom.Node node, java.lang.String localName) Convenience method to test whether the given DOM Node node is a MathML element having the given localName.
static org.w3c.dom.Document	isolateAnnotationXML(org.w3c.dom.Element mathElement, java.lang.String encodingAttribute) "Isolates" the XML annotation having the given encoding by producing a copy of the MathML element with only the given annotation contents as children.
static org.w3c.dom.Document	isolateAnnotationXML(UnwrappedParallelMathMLDOM unwrappedDOM, java.lang.String encodingAttribute) Version of isolateAnnotationXML(Element, String) that works on an UnwrappedParallelMathMLDOM.
static org.w3c.dom.Document	isolateFirstSemanticsBranch(org.w3c.dom.Element mathElement) "Isolates" the first <semantics/> branch of an annotation MathML element by producing a copy of the MathML element with a single child containing only the first child of the <semantics/> element.
static org.w3c.dom.Document	isolateFirstSemanticsBranch(UnwrappedParallelMathMLDOM unwrappedDOM) Version of isolateFirstSemanticsBranch(Element) that works on an UnwrappedParallelMathMLDOM.
static org.w3c.dom.Document	parseMathMLDocumentString(java.lang.String mathmlDocument) Convenience method that parses a MathML document specified as a UTF-8-encoded String.
static java.lang.String	serializeDocument(org.w3c.dom.Document document) Convenience method that serializes the given DOM Document as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, boolean indent, boolean omitXMLDeclaration) 已过时。 Use one of the alternative methods, including serializeDocument(Document, SerializationSpecifier) for ultimate control.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, SerializationSpecifier serializationOptions) Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, SerializationSpecifier serializationOptions, StylesheetManager stylesheetManager) Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, java.lang.String encoding) Convenience method that serializes the given DOM Document as a String, using the specified encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, java.lang.String encoding, boolean indent) Convenience method that serializes the given DOM Document as a String, using the specified encoding and indentation options and omitting the XML declaration, which is a reasonable way of serializing a MathML document.
static java.lang.String	serializeDocument(org.w3c.dom.Document document, java.lang.String encoding, boolean indent, boolean omitXMLDeclaration) 已过时。 Use one of the alternative methods, including serializeDocument(Document, SerializationSpecifier) for ultimate control.
static java.lang.String	serializeElement(org.w3c.dom.Element element) Convenience method that serializes the given DOM Element as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.
static java.lang.String	serializeElement(org.w3c.dom.Element element, boolean indent) Convenience method that serializes the given DOM Element as a String, indenting if specified and omitting the XML declaration which is a reasonable way of serializing MathML.
static java.lang.String	serializeElement(org.w3c.dom.Element element, boolean indent, boolean omitXMLDeclaration) 已过时。 Use one of the alternative methods, including serializeElement(Element, SerializationSpecifier) for ultimate control.
static java.lang.String	serializeElement(org.w3c.dom.Element element, SerializationSpecifier serializationOptions) Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.
static java.lang.String	serializeElement(org.w3c.dom.Element element, SerializationSpecifier serializationOptions, StylesheetManager stylesheetManager) Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.
static java.lang.String	serializeElement(org.w3c.dom.Element element, java.lang.String encoding) Convenience method that serializes the given DOM Element as a String, using the given encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.
static java.lang.String	serializeElement(org.w3c.dom.Element element, java.lang.String encoding, boolean indent) Convenience method that serializes the given DOM Element as a String, using the given parameters.
static java.lang.String	serializeElement(org.w3c.dom.Element element, java.lang.String encoding, boolean indent, boolean omitXMLDeclaration) 已过时。 Use serializeElement(Element, SerializationSpecifier) or serializeElement(Element, SerializationSpecifier, StylesheetManager)
static UnwrappedParallelMathMLDOM	unwrapParallelMathMLDOM(org.w3c.dom.Element mathElement) Convenience method to unwrap at MathML DOM Object containing top-level parallel markup, as defined Section 5.3.1 of the MathML 2.0 specification.

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

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

字段详细资料

ANNOTATION_LOCAL_NAME

public static final java.lang.String ANNOTATION_LOCAL_NAME

另请参阅:

常量字段值

ANNOTATION_XML_LOCAL_NAME

public static final java.lang.String ANNOTATION_XML_LOCAL_NAME

另请参阅:

常量字段值

构造器详细资料

MathMLUtilities

public MathMLUtilities()

方法详细资料

parseMathMLDocumentString

public static org.w3c.dom.Document parseMathMLDocumentString(java.lang.String mathmlDocument)
                                                      throws java.io.IOException,
                                                             org.xml.sax.SAXException

Convenience method that parses a MathML document specified as a UTF-8-encoded String.

抛出:

java.io.IOException

org.xml.sax.SAXException

convertMfencedToExplicitFences

public static void convertMfencedToExplicitFences(org.w3c.dom.Document document)

Replaces every deprecated MathML mfenced element in the supplied document with its explicit mrow/mo equivalent. The document is modified in place.

convertExplicitFencesToMfenced

public static void convertExplicitFencesToMfenced(org.w3c.dom.Document document)

Converts explicit fences generated by SnuggleTeX back to mfenced. This exists for compatibility with the legacy up-conversion stylesheets and modifies the document in place.

serializeDocument

public static java.lang.String serializeDocument(org.w3c.dom.Document document)

Convenience method that serializes the given DOM Document as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

参数:

document - DOM document to serialize, must not be null

serializeDocument

public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                 SerializationSpecifier serializationOptions)

Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.

参数:

document - DOM document to serialize, must not be null

serializationOptions - desired SerializationOptions, may be null.

从以下版本开始:

1.2.0

serializeDocument

public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                 SerializationSpecifier serializationOptions,
                                                 StylesheetManager stylesheetManager)

Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.

参数:

document - DOM document to serialize, must not be null

serializationOptions - desired SerializationOptions, may be null.

从以下版本开始:

1.2.0

serializeDocument

public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                 java.lang.String encoding)

Convenience method that serializes the given DOM Document as a String, using the specified encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

参数:

document - DOM document to serialize, must not be null

encoding - desired encoding, null is interpreted as UTF-8.

serializeDocument

public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                 java.lang.String encoding,
                                                 boolean indent)

Convenience method that serializes the given DOM Document as a String, using the specified encoding and indentation options and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

参数:

document - DOM document to serialize, must not be null

encoding - desired encoding, null is interpreted as UTF-8.

serializeDocument

@Deprecated
public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                              boolean indent,
                                                              boolean omitXMLDeclaration)

已过时。 Use one of the alternative methods, including serializeDocument(Document, SerializationSpecifier) for ultimate control.

Convenience method that serializes the given DOM Document as a String (encoded in UTF-8).

参数:

document - DOM element to serialize

indent - whether to indent the results or not

omitXMLDeclaration - whether to omit the XML declaration or not.

serializeDocument

@Deprecated
public static java.lang.String serializeDocument(org.w3c.dom.Document document,
                                                              java.lang.String encoding,
                                                              boolean indent,
                                                              boolean omitXMLDeclaration)

已过时。 Use one of the alternative methods, including serializeDocument(Document, SerializationSpecifier) for ultimate control.

Convenience method that serializes the given DOM Document as a String, using the specified encoding.

参数:

document - DOM element to serialize

encoding - desired encoding, null is interpreted as UTF-8.

indent - whether to indent the results or not

omitXMLDeclaration - whether to omit the XML declaration or not.

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element)

Convenience method that serializes the given DOM Element as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.

参数:

element - DOM element to serialize, must not be null.

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                SerializationSpecifier serializationOptions)

Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.

参数:

element - DOM element to serialize, must not be null.

serializationOptions - SerializationSpecifier, may be null.

从以下版本开始:

1.2.0

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                SerializationSpecifier serializationOptions,
                                                StylesheetManager stylesheetManager)

Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.

参数:

element - DOM element to serialize, must not be null.

serializationOptions - SerializationSpecifier, may be null.

stylesheetManager - StylesheetManager, must not be null

从以下版本开始:

1.2.0

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                java.lang.String encoding)

Convenience method that serializes the given DOM Element as a String, using the given encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.

参数:

element - DOM element to serialize

encoding - desired encoding, null is interpreted as UTF-8.

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                boolean indent)

Convenience method that serializes the given DOM Element as a String, indenting if specified and omitting the XML declaration which is a reasonable way of serializing MathML.

参数:

element - DOM element to serialize

indent - whether to indent or not

serializeElement

@Deprecated
public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                             boolean indent,
                                                             boolean omitXMLDeclaration)

已过时。 Use one of the alternative methods, including serializeElement(Element, SerializationSpecifier) for ultimate control.

Convenience method that serializes the given DOM Element as a String (encoded in UTF-8).

参数:

element - DOM element to serialize

indent - whether to indent the results or not

omitXMLDeclaration - whether to omit the XML declaration or not.

serializeElement

@Deprecated
public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                             java.lang.String encoding,
                                                             boolean indent,
                                                             boolean omitXMLDeclaration)

已过时。 Use serializeElement(Element, SerializationSpecifier) or serializeElement(Element, SerializationSpecifier, StylesheetManager)

Convenience method that serializes the given DOM Element as a String, using the given parameters.

参数:

element - DOM element to serialize

encoding - desired encoding, null is interpreted as UTF-8.

indent - whether to indent the results or not

omitXMLDeclaration - whether to omit the XML declaration or not.

serializeElement

public static java.lang.String serializeElement(org.w3c.dom.Element element,
                                                java.lang.String encoding,
                                                boolean indent)

Convenience method that serializes the given DOM Element as a String, using the given parameters.

(This can be used in more general cases than MathML, through experienced programmers may want more control over what happens here.)

参数:

element - DOM element to serialize

encoding - desired encoding, null is interpreted as UTF-8.

indent - whether to indent the results or not

isMathMLElement

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

Convenience method to test whether the given DOM Node node is a MathML element having any localName.

参数:

node - Node to test

抛出:

java.lang.IllegalArgumentException - if node is null.

isMathMLElement

public static boolean isMathMLElement(org.w3c.dom.Node node,
                                      java.lang.String localName)

Convenience method to test whether the given DOM Node node is a MathML element having the given localName.

参数:

node - Node to test

localName - MathML local name to test for, such as mi or math, or null to indicate "any name in the MathML namespace".

抛出:

java.lang.IllegalArgumentException - if node is null.

ensureMathMLContainer

public static void ensureMathMLContainer(org.w3c.dom.Element mathElement)

ensureMathMLDocument

public static org.w3c.dom.Element ensureMathMLDocument(org.w3c.dom.Document document)

Checks that the given DOM Document contains a single MathML math Element. If so, the Element is returned. Otherwise, an IllegalArgumentException is thrown.

unwrapParallelMathMLDOM

public static UnwrappedParallelMathMLDOM unwrapParallelMathMLDOM(org.w3c.dom.Element mathElement)

Convenience method to unwrap at MathML DOM Object containing top-level parallel markup, as defined Section 5.3.1 of the MathML 2.0 specification.

If there is no parallel markup detected then null if returned.

If the given element is null or is not a MathML "math" element, then an IllegalArgumentException is thrown.

extractFirstSemanticsBranch

public static org.w3c.dom.Element extractFirstSemanticsBranch(org.w3c.dom.Element mathElement)

extractAnnotationString

public static java.lang.String extractAnnotationString(org.w3c.dom.Element mathElement,
                                                       java.lang.String encodingAttribute)

Extracts the first textual annotation found having the given encoding attribute from the given MathML math element, if such an annotation is found.

This assumes the following structure:

 <math>
   <semantics>
     ...
     <annotation encoding="...">text</annotation>
   </semantics>
 </math>
 

参数:

mathElement -

返回:

first matching annotation, or null if not present.

extractAnnotationXML

public static org.w3c.dom.NodeList extractAnnotationXML(org.w3c.dom.Element mathElement,
                                                        java.lang.String encodingAttribute)

Extracts the first XML-based annotation having the given encoding attribute from the given MathML math element, if such an annotation is found.

This assumes the following structure:

 <math>
   <semantics>
     ...
     <annotation-xml encoding="...">XML annotation</annotation>
   </semantics>
 </math>
 

参数:

mathElement -

返回:

DOM NodeList corresponding to the child Nodes of the first matching annotation-xml element, or null if no such annotation found.

isolateFirstSemanticsBranch

public static org.w3c.dom.Document isolateFirstSemanticsBranch(org.w3c.dom.Element mathElement)

"Isolates" the first <semantics/> branch of an annotation MathML element by producing a copy of the MathML element with a single child containing only the first child of the <semantics/> element.

For example:

   <math>
     <semantics>
       <mi>x</mi>
       <annotation-xml encoding='blah'><x/></annotation-xml>
     </semantics>
   </math>
   

results in:

   <math>
     <mi>x</mi>
   </math>
   

返回:

new MathML Document with the given structure or null if the given math element is not annotated.

抛出:

java.lang.IllegalArgumentException - if passed null or the given element is not a math element.

isolateFirstSemanticsBranch

public static org.w3c.dom.Document isolateFirstSemanticsBranch(UnwrappedParallelMathMLDOM unwrappedDOM)

Version of isolateFirstSemanticsBranch(Element) that works on an UnwrappedParallelMathMLDOM.

返回:

new MathML Document with the given structure or null if the given wrapper has no first branch.

抛出:

java.lang.IllegalArgumentException - if passed null.

isolateAnnotationXML

public static org.w3c.dom.Document isolateAnnotationXML(org.w3c.dom.Element mathElement,
                                                        java.lang.String encodingAttribute)

"Isolates" the XML annotation having the given encoding by producing a copy of the MathML element with only the given annotation contents as children.

For example:

   <math>
     <semantics>
       <mi>x</mi>
       <annotation-xml encoding='blah'><x/></annotation-xml>
     </semantics>
   </math>
   

results in:

   <math>
     <x/>
   </math>
   

返回:

new MathML Document with the given structure or null if the given math element is not annotated or does not have the required annotation.

抛出:

java.lang.IllegalArgumentException - if passed null or the given element is not a math element.

isolateAnnotationXML

public static org.w3c.dom.Document isolateAnnotationXML(UnwrappedParallelMathMLDOM unwrappedDOM,
                                                        java.lang.String encodingAttribute)

Version of isolateAnnotationXML(Element, String) that works on an UnwrappedParallelMathMLDOM.

返回:

new MathML Document with the given structure or null if the given wrapper does not have the required annotation.

抛出:

java.lang.IllegalArgumentException - if passed null.