cz.muni.fi.mir.mathmlunificator

Class MathMLUnificator

java.lang.Object

cz.muni.fi.mir.mathmlunificator.MathMLUnificator

public class MathMLUnificator
extends Object

MathML Unificator is a tool which performs simple MathML (Mathematical Markup Language) unification as proposed, i.e. single MathML formula transforms to series of formulae with leaf elements substituted gradually for a special unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Author:

Michal Růžička

Constructor Summary

Constructors

Constructor and Description
MathMLUnificator()

Method Summary

Modifier and Type	Method and Description
static UnificationLevel	getNodeUnificationLevel(Node node) Determine the unification level of the Node and max level of the unification series.
static HashMap<Integer,Node>	getUnifiedMathMLNodes(Node mathNode, boolean operatorUnification) Transforms the given MathML Node for series of MathML formulae with leaf elements substituted gradually for a special unification representing symbol &#x25CD; (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or &#x25D0; (for Content MathML, see Constants.CMATHML_UNIFICATOR).
static boolean	isUnifiedMathNode(Node node) Test whether the given node is unified math node.
static void	replaceNodeWithUnificator(Node oldNode) Replace the given node with unification element containing unification representing symbol &#x25CD; (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or &#x25D0; (for Content MathML, see Constants.CMATHML_UNIFICATOR).
static void	unifyMathML(Document doc, boolean operatorUnification) In the given W3C DOM represented XML document find all maths nodes (see DocumentParser.findMathMLNodes(org.w3c.dom.Document)) and substitute them for series of formulae with leaf elements substituted gradually for a special unification representing symbol &#x25CD; (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or &#x25D0; (for Content MathML, see Constants.CMATHML_UNIFICATOR).
static void	unifyMathML(InputStream is, OutputStream os, boolean operatorUnification) In the given W3C DOM represented XML document find all maths nodes (see DocumentParser.findMathMLNodes(org.w3c.dom.Document)) and substitute them for series of formulae with leaf elements substituted gradually for a special unification representing symbol &#x25CD; (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or &#x25D0; (for Content MathML, see Constants.CMATHML_UNIFICATOR).
static void	unifyMathMLNode(Node mathNode, boolean operatorUnification) Substitute the given MathML Node for series of MathML formulae with leaf elements substituted gradually for a special unification representing symbol &#x25CD; (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or &#x25D0; (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Methods inherited from class java.lang.Object

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

Constructor Detail

MathMLUnificator

public MathMLUnificator()

Method Detail

unifyMathML

public static void unifyMathML(Document doc,
                               boolean operatorUnification)

In the given W3C DOM represented XML document find all maths nodes (see DocumentParser.findMathMLNodes(org.w3c.dom.Document)) and substitute them for series of formulae with leaf elements substituted gradually for a special unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Resulting series of the original and unified MathML nodes is itself encapsulated in a new element <unified-math> (see Constants.UNIFIED_MATHML_ROOT_ELEM) in XML namespace http://mir.fi.muni.cz/mathml-unification/ (see Constants.UNIFIED_MATHML_NS).

Parameters:

doc - W3C DOM representation of the XML document to work on.

operatorUnification - If true unify also operator nodes, otherwise keep operator nodes intact.

See Also:

DocumentParser.findMathMLNodes(org.w3c.dom.Document)

unifyMathML

public static void unifyMathML(InputStream is,
                               OutputStream os,
                               boolean operatorUnification)
                        throws IOException

In the given W3C DOM represented XML document find all maths nodes (see DocumentParser.findMathMLNodes(org.w3c.dom.Document)) and substitute them for series of formulae with leaf elements substituted gradually for a special unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Resulting series of the original and unified MathML nodes is itself encapsulated in a new element <unified-math> (see Constants.UNIFIED_MATHML_ROOT_ELEM) in XML namespace http://mir.fi.muni.cz/mathml-unification/ (see Constants.UNIFIED_MATHML_NS).

Untouched input will be returned and error logged in case of any error during the processing.

Parameters:

is - Input stream with UTF-8 encoded string representation of the XML document to work on.

os - Output stream to write UTF-8 encoded string representation of the processed XML document.

operatorUnification - If true unify also operator nodes, otherwise keep operator nodes intact.

Throws:

IOException - If any I/O error occurs while reading the input stream.

See Also:

DocumentParser.findMathMLNodes(org.w3c.dom.Document)

unifyMathMLNode

public static void unifyMathMLNode(Node mathNode,
                                   boolean operatorUnification)

Substitute the given MathML Node for series of MathML formulae with leaf elements substituted gradually for a special unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Resulting series of the original and unified MathML nodes is itself encapsulated in a new element <unified-math> (see Constants.UNIFIED_MATHML_ROOT_ELEM) in XML namespace http://mir.fi.muni.cz/mathml-unification/ (see Constants.UNIFIED_MATHML_NS).

Parameters:

mathNode - W3C DOM XML document representation attached MathML node to work on.

operatorUnification - If true unify also operator nodes, otherwise keep operator nodes intact.

getUnifiedMathMLNodes

public static HashMap<Integer,Node> getUnifiedMathMLNodes(Node mathNode,
                                                          boolean operatorUnification)

Transforms the given MathML Node for series of MathML formulae with leaf elements substituted gradually for a special unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Parameters:

mathNode - W3C DOM XML document representation attached MathML node to work on.

operatorUnification - If true unify also operator nodes, otherwise keep operator nodes intact.

Returns:

Collection of unified versions of the mathNode with key of the HashMap describing order (level of unification) of elements in the collection.

replaceNodeWithUnificator

public static void replaceNodeWithUnificator(Node oldNode)

Replace the given node with unification element containing unification representing symbol ◍ (for Presentation MathML, see Constants.PMATHML_UNIFICATOR) or ◐ (for Content MathML, see Constants.CMATHML_UNIFICATOR).

Parameters:

oldNode - The node to be replaced with the unification representing element.

Throws:

IllegalArgumentException - If the given node does not have parent.

isUnifiedMathNode

public static boolean isUnifiedMathNode(Node node)

Test whether the given node is unified math node. The node is considered to be unified math node if

1. the node is not null,
2. the node is math node,
3. the node has current unification level attribute (see Constants.UNIFIED_MATHML_LEVEL_ATTR) in MathML Unification XML namespace (see Constants.UNIFIED_MATHML_NS) with valid value, i.e. integer greather than 0.

The method is XML namespace aware and expects the node DOM to be build as XML aware (see DocumentBuilderFactory.setNamespaceAware(boolean)).

In case the input DOM was created as namespace unaware or the input XML document does not correctly use namespaces the method tries to fall back to element-plain-name-only math node detection. The element is considered to be math element if

• the element is in MathML namespace XML namespace http://www.w3.org/1998/Math/MathML (see Constants.MATHML_NS),
• or the local name of the element is <math> (see Constants.UNIFIED_MATHML_ROOT_ELEM) without any namespace definition.

Parameters:

node - The node to test.

Returns:

true if the above description is fulfilled, false otherwise.

getNodeUnificationLevel

public static UnificationLevel getNodeUnificationLevel(Node node)

Determine the unification level of the Node and max level of the unification series. If the node does not possess the appropriate unification level XML attributes the UnificationLevel object will indicate that by having both UnificationLevel.nodeLevel and UnificationLevel.maxLevel set to null.

Please note that only existance of valid unification level XML attributes is tested. If you want to be sure the node is a valid unified math node use isUnifiedMathNode(org.w3c.dom.Node)!

Parameters:

node - The node to determine the unification level for.

Returns:

The node's unification level represented by an instance of UnificationLevel.

See Also:

unifyMathMLNode(org.w3c.dom.Node, boolean)