cz.muni.fi.mir.mathmlcanonicalization.modules

Class ElementMinimizer

java.lang.Object

cz.muni.fi.mir.mathmlcanonicalization.modules.ElementMinimizer

All Implemented Interfaces:

Module, StreamModule

public class ElementMinimizer
extends Object
implements StreamModule

Remove useless elements and attributes from MathML.

Input:

• Well-formed MathML, first module
• Property file(s) with names of elements and attributes for removal or preservation

Output:

The original code with:

• removed elements insignificant for the formula searching and indexing purpose (e.q. spacing and appearance altering tags) including the content between open and close tag or preserving it (depending on the tag)
• removed useless attributes but preserved those that are used in other modules, e.q. separator attribute in mfenced element
• removed attributes with default values?
• removed redundant spaces?

Author:

Maros Kucbel

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FENCED
protected static String	IDENTIFIER
protected static String	MATH
protected static String	OPERATOR
protected static String	OVERSCRIPT
protected Properties	properties
protected static String	ROW
protected static String	SUBSCRIPT
protected static String	SUBSUP
protected static String	SUPERSCRIPT
protected static String	UNDEROVER
protected static String	UNDERSCRIPT

Constructor Summary

Constructors

Constructor and Description
ElementMinimizer()

Method Summary

Modifier and Type	Method and Description
ByteArrayOutputStream	execute(InputStream input) Executes the canonicalization module.
String	getProperty(String key) Gets given property of the module
Set<String>	getPropertyNames() Gets the module property names
protected Set<String>	getPropertySet(String property)
protected boolean	isEnabled(String key)
protected boolean	isOperator(org.jdom2.Element element)
protected boolean	isOperator(org.jdom2.Element element, String operator)
boolean	isProperty(String key) Finds out if the property is set
protected void	loadProperties(String propertiesFilename)
protected void	replaceElement(org.jdom2.Element toReplace, String replacementName)
void	setProperty(String key, String value) Sets given property of the module

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.muni.fi.mir.mathmlcanonicalization.modules.Module

getProperty, getPropertyNames, isProperty, setProperty

Field Detail

properties

protected final Properties properties

FENCED

protected static final String FENCED

See Also:

Constant Field Values

IDENTIFIER

protected static final String IDENTIFIER

See Also:

Constant Field Values

MATH

protected static final String MATH

See Also:

Constant Field Values

OPERATOR

protected static final String OPERATOR

See Also:

Constant Field Values

OVERSCRIPT

protected static final String OVERSCRIPT

See Also:

Constant Field Values

ROW

protected static final String ROW

See Also:

Constant Field Values

SUBSCRIPT

protected static final String SUBSCRIPT

See Also:

Constant Field Values

SUPERSCRIPT

protected static final String SUPERSCRIPT

See Also:

Constant Field Values

SUBSUP

protected static final String SUBSUP

See Also:

Constant Field Values

UNDEROVER

protected static final String UNDEROVER

See Also:

Constant Field Values

UNDERSCRIPT

protected static final String UNDERSCRIPT

See Also:

Constant Field Values

Constructor Detail

ElementMinimizer

public ElementMinimizer()

Method Detail

execute

public ByteArrayOutputStream execute(InputStream input)
                              throws ModuleException

Description copied from interface: StreamModule

Executes the canonicalization module. Returned ByteArrayOutputStream can be converted to InputStream instance using ByteArrayInputStream.ByteArrayInputStream(byte[]).

Specified by:

execute in interface StreamModule

Parameters:

input - input stream to be processed

Returns:

the result in accordance with the module specification

Throws:

ModuleException - when cannot transform the input by this module

getProperty

public String getProperty(String key)

Description copied from interface: Module

Gets given property of the module

Specified by:

getProperty in interface Module

Parameters:

key - property name

Returns:

property value (not null)

isProperty

public boolean isProperty(String key)

Description copied from interface: Module

Finds out if the property is set

Specified by:

isProperty in interface Module

Parameters:

key - property name

Returns:

true if property is set, false otherwise

setProperty

public void setProperty(String key,
                        String value)

Description copied from interface: Module

Sets given property of the module

Specified by:

setProperty in interface Module

Parameters:

key - property name

value - property value

getPropertyNames

public Set<String> getPropertyNames()

Description copied from interface: Module

Gets the module property names

Specified by:

getPropertyNames in interface Module

Returns:

the module property names of type String

isEnabled

protected boolean isEnabled(String key)

loadProperties

protected void loadProperties(String propertiesFilename)

getPropertySet

protected Set<String> getPropertySet(String property)

isOperator

protected boolean isOperator(org.jdom2.Element element,
                             String operator)

isOperator

protected boolean isOperator(org.jdom2.Element element)

replaceElement

protected void replaceElement(org.jdom2.Element toReplace,
                              String replacementName)