cz.muni.fi.mir.mathmlcanonicalization

Class MathMLCanonicalizer

java.lang.Object

cz.muni.fi.mir.mathmlcanonicalization.MathMLCanonicalizer

public final class MathMLCanonicalizer
extends Object

An input class for MathML canonicalization.

Author:

David Formanek

Constructor Summary

Constructors

Constructor and Description
MathMLCanonicalizer() Initializes canonicalizer with no modules
MathMLCanonicalizer(InputStream xmlConfigurationStream) Initializes canonicalizer using configuration file

Method Summary

Modifier and Type	Method and Description
MathMLCanonicalizer	addModule(Module module) Adds the module to the process of canonicalization StreamModules are called before DOM modules and then in order of addition.
MathMLCanonicalizer	addModule(String moduleName) Adds the module by its class name.
void	canonicalize(InputStream in, OutputStream out) Canonicalize an input MathML stream.
static MathMLCanonicalizer	getDefaultCanonicalizer() Initializes canonicalizer with default settings
boolean	isEnforcingXHTMLPlusMathMLDTD() Test whether this instance of MathMLCanonicalizer is injecting XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD reference into any input document.
void	setEnforcingXHTMLPlusMathMLDTD(boolean mode) Enable/disable force injecting of XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD reference into any input document.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathMLCanonicalizer

public MathMLCanonicalizer()

Initializes canonicalizer with no modules

MathMLCanonicalizer

public MathMLCanonicalizer(InputStream xmlConfigurationStream)
                    throws ConfigException

Initializes canonicalizer using configuration file

Parameters:

xmlConfigurationStream - XML configuration constrained by XML Schema in cz.muni.fi.mir.mathmlcanonicalization.configuration.xsd resource file

Throws:

ConfigException - when configuration cannot be loaded

Method Detail

getDefaultCanonicalizer

public static MathMLCanonicalizer getDefaultCanonicalizer()

Initializes canonicalizer with default settings

Returns:

itialized canonicalizer

addModule

public MathMLCanonicalizer addModule(Module module)

Adds the module to the process of canonicalization StreamModules are called before DOM modules and then in order of addition. Each module can be added more than once if needed.

Parameters:

module - the module to be used in canonicalization

Returns:

the canonizer object to allow adding more modules at once

addModule

public MathMLCanonicalizer addModule(String moduleName)

Adds the module by its class name. Useful for setting modules from config files. When the module can't be found or instantiated the module is skipped and the warning is produced.

Parameters:

moduleName - the name of the module class

Returns:

the canonizer object to allow adding more modules at once

canonicalize

public void canonicalize(InputStream in,
                         OutputStream out)
                  throws org.jdom2.JDOMException,
                         IOException,
                         ModuleException,
                         XMLStreamException

Canonicalize an input MathML stream.

Parameters:

in - input stream to be canonicalized

out - canonical output stream of input

Throws:

org.jdom2.JDOMException - problem with DOM

IOException - problem with streams

ModuleException - some module cannot canonicalize the input

XMLStreamException - an error with XML processing occurs

isEnforcingXHTMLPlusMathMLDTD

public boolean isEnforcingXHTMLPlusMathMLDTD()

Test whether this instance of MathMLCanonicalizer is injecting XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD reference into any input document.

Returns:

XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD reference enforcement setting

setEnforcingXHTMLPlusMathMLDTD

public void setEnforcingXHTMLPlusMathMLDTD(boolean mode)

Enable/disable force injecting of XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD reference into any input document.

Parameters:

mode - XHTML 1.1 plus MathML 2.0 plus SVG 1.1 DTD enforcement mode