Package com.singularsys.extensions.mathml

Class MathMLContentParser

java.lang.Object

com.singularsys.extensions.mathml.MathMLContentParser

public class MathMLContentParser
extends Object

Main class for the Content-MathML parser. The standard single argument constructor builds a parser with a default set of parsing rules. Other rules can be added using the various put(String, TagHandler) methods.

Various parse methods are available for parsing complete documents or fragments of mathml code. To enable mathml documents containing entities like π to be processed the setPrependMathMLEntities(boolean) method can be called, if true a simple doctype declaration defining the entities is inserted at the start of the document.

Author:

Richard Morris

See Also:

• Standard setup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MathMLContentParser.Behaviour	Behaviour for unknown tags when parsing with parseAll(Reader, Behaviour).

Field Summary

Fields

Modifier and Type	Field	Description
protected AnnotationHandler	annotationHandler
protected ApplyHandler	applyHandler
protected ConstantHandler	constantHandler
protected DeclareHandler	declareHandler
protected IdentifierHandler	identifierHandler
protected final Jep	jep
protected MathTagHandler	mathElementHandler
protected final Map<String,String>	mathMLEntities
protected static final String	MathMLEntitiesEnd
protected static final String	MathMLEntitiesStart
protected String	mathMLEntitiesString	String with a simple DOCTYPE declaration defining MathML entities.
protected MatrixHandler	matrixHandler
protected final MathMLDocumentHandler	mdh
protected OperatorHandler	operatorHandler
protected final OperatorTableI	ot
protected SemanticHandler	semanticHandler
protected SpecialNodeHandler	specialNodeHandler
protected SAXParserFactory	spf
protected StandardFunctionHandler	standardFunctionHandler
protected UnSupportedHandler	unsupportedHandler

Constructor Summary

Constructors

Constructor	Description
MathMLContentParser(Jep jep)	Creates a standard MathML parser.
MathMLContentParser(Jep jep, SAXParserFactory spf, MathMLDocumentHandler mdh)	Creates a MathML parser with a given parser factory and MathMLDocumentHandler.

Method Summary

Modifier and Type	Method	Description
String	getMathMLEntitiesString()	Returns a string with a simple DOCTYPE declaration with defined entities.
SAXParserFactory	getSAXParserFactory()
boolean	isPrependMathMLEntities()
Object	parseAll(Reader reader, MathMLContentParser.Behaviour behaviour)	Parse a complete xml document containing one or more math tags, with one or more child elements.
Object	parseAll(Reader reader, TagHandler unknownHandler)	Parse a complete xml document containing one or more math tags, with one or more child elements.
Object	parseAll(InputSource is, TagHandler unknownHandler)	Parse a document containing one or more math tags, with one or more child elements.
List<Node>	parseAllMath(Reader reader)	Parse a document containing one or more math tags, with one or more child elements.
List<Node>	parseAllMath(String xml)	Parse a document containing one or more math tags, with one or more child elements.
List<Node>	parseAllMath(InputSource is)	Parse a document containing one or more math tags, with one or more child elements.
Node	parseFragment(Reader reader)	Parse a document containing a mathml fragment, not enclosed in a math tag.
Node	parseFragment(InputSource is)	Parse a document containing a mathml fragment, not enclosed in a math tag.
Node	parseSingle(Reader reader)	Parse a document containing a single <math> element with a single child node.
Node	parseSingle(String xml)	Parse a document containing a single <math> element with a single child node.
Node	parseSingle(InputSource is)	Parse a document containing a single <math> element with a single child node.
TagHandler	put(String key, TagHandler handler)	Adds the handler for a given element
TagHandler	putConstantElement(String key, String jepName)	Add a handler for elements representing a constant.
TagHandler	putEntity(String entityName, String unicode, String jepVariableName)	Adds a handler for a MathML Entity representing a constant.
TagHandler	putFunction(String key, String jepName)	Adds a handler for a Jep function, uses the standardFunctionHandler
TagHandler	putOperator(String key, Operator op)	Adds a handler for a Jep operator, uses the operatorHandler
TagHandler	putSpecialNode(String key, int nchildren)	Adds a handler for special nodes like <sep/>, <logbase> and >degree< which only have meaning inside other elements.
TagHandler	remove(String key)	Remove the handler associated with a give mathml element.
TagHandler	removeEntity(String key)
void	setPrependMathMLEntities(boolean prependMathMLEntities)	Whether to prepend a simple deceleration to the start of the document.
void	setSAXParserFactory(SAXParserFactory spf)

Methods inherited from class java.lang.Object

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

Field Details

spf

protected SAXParserFactory spf

mdh

protected final MathMLDocumentHandler mdh

jep

protected final Jep jep

ot

protected final OperatorTableI ot

mathElementHandler

protected MathTagHandler mathElementHandler

unsupportedHandler

protected UnSupportedHandler unsupportedHandler

constantHandler

protected ConstantHandler constantHandler

identifierHandler

protected IdentifierHandler identifierHandler

operatorHandler

protected OperatorHandler operatorHandler

applyHandler

protected ApplyHandler applyHandler

standardFunctionHandler

protected StandardFunctionHandler standardFunctionHandler

specialNodeHandler

protected SpecialNodeHandler specialNodeHandler

matrixHandler

protected MatrixHandler matrixHandler

declareHandler

protected DeclareHandler declareHandler

semanticHandler

protected SemanticHandler semanticHandler

annotationHandler

protected AnnotationHandler annotationHandler

mathMLEntitiesString

protected String mathMLEntitiesString

String with a simple DOCTYPE declaration defining MathML entities.

MathMLEntitiesStart

protected static final String MathMLEntitiesStart

See Also:

• Constant Field Values

MathMLEntitiesEnd

protected static final String MathMLEntitiesEnd

See Also:

• Constant Field Values

mathMLEntities

protected final Map<String,String> mathMLEntities

Constructor Details

MathMLContentParser

public MathMLContentParser(Jep jep,
 SAXParserFactory spf,
 MathMLDocumentHandler mdh)

Creates a MathML parser with a given parser factory and MathMLDocumentHandler.

MathMLContentParser

public MathMLContentParser(Jep jep)

Creates a standard MathML parser. Uses the default SAXParserFactory, standard MathMLDocumentHandler and default methods for MathML Content elements. Not all elements are supported.

Parameters:

jep - the Jep instance

Method Details

parseSingle

public Node parseSingle(InputSource is)
                 throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing a single <math> element with a single child node.

Parameters:

is -

Returns:

node representing the child node

Throws:

ParserConfigurationException

SAXException - if document does not contain exactly one math tag, or any non mathml data

IOException

parseSingle

public Node parseSingle(Reader reader)
                 throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing a single <math> element with a single child node.

Parameters:

reader -

Returns:

node representing the child node

Throws:

ParserConfigurationException

SAXException - if document does not contain exactly one math tag, or any non mathml data

IOException

parseSingle

public Node parseSingle(String xml)
                 throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing a single <math> element with a single child node.

Parameters:

xml - string containing mathml

Returns:

node representing the child node

Throws:

ParserConfigurationException

SAXException - if document does not contain exactly one math tag, or any non mathml data

IOException

parseFragment

public Node parseFragment(InputSource is)
                   throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing a mathml fragment, not enclosed in a math tag.

Parameters:

is -

Returns:

node representing the child node

Throws:

ParserConfigurationException

SAXException - If the document contains non mathml data.

IOException

parseFragment

public Node parseFragment(Reader reader)
                   throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing a mathml fragment, not enclosed in a math tag.

Parameters:

reader -

Returns:

node representing the child node

Throws:

ParserConfigurationException

SAXException - If the document contains non mathml data.

IOException

parseAllMath

public List<Node> parseAllMath(InputSource is)
                        throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing one or more math tags, with one or more child elements. Surrounding xml elements are silently ignored.

Parameters:

is -

Returns:

a list of all nodes one for each child of the math elements.

Throws:

ParserConfigurationException

SAXException

IOException

parseAllMath

public List<Node> parseAllMath(Reader reader)
                        throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing one or more math tags, with one or more child elements. Surrounding xml elements are silently ignored.

Parameters:

reader -

Returns:

a list of all nodes for all child of the math elements.

Throws:

ParserConfigurationException

SAXException

IOException

parseAllMath

public List<Node> parseAllMath(String xml)
                        throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing one or more math tags, with one or more child elements. Surrounding xml elements are silently ignored.

Parameters:

xml - String with MathML.

Returns:

a list of all nodes for all child of the math elements.

Throws:

ParserConfigurationException

SAXException

IOException

parseAll

public Object parseAll(InputSource is,
 TagHandler unknownHandler)
                throws ParserConfigurationException,
SAXException,
IOException

Parse a document containing one or more math tags, with one or more child elements. Surrounding xml elements are silently ignored.

Parameters:

is -

unknownHandler - a handler for unknown elements

Returns:

the result of parsing

Throws:

ParserConfigurationException

SAXException

IOException

parseAll

public Object parseAll(Reader reader,
 TagHandler unknownHandler)
                throws ParserConfigurationException,
SAXException,
IOException

Parse a complete xml document containing one or more math tags, with one or more child elements.

Parameters:

reader - the Reader to read from

unknownHandler - a handler for unknown elements

Returns:

the result of parsing, actual type depends on the unknownHandler

Throws:

ParserConfigurationException

SAXException

IOException

parseAll

public Object parseAll(Reader reader,
 MathMLContentParser.Behaviour behaviour)
                throws ParserConfigurationException,
SAXException,
IOException

Parse a complete xml document containing one or more math tags, with one or more child elements.

Parameters:

reader - the Reader to read from

behaviour -

Returns:

the result of parsing, actual type depends on the unknownHandler

Throws:

ParserConfigurationException

SAXException

IOException

put

public TagHandler put(String key,
 TagHandler handler)

Adds the handler for a given element

Parameters:

key - the name of the element

handler - the handler used for this type of element

Returns:

handler

putOperator

public TagHandler putOperator(String key,
 Operator op)

Adds a handler for a Jep operator, uses the operatorHandler

Parameters:

key - the name of the mathml element

op - the jep operator

Returns:

the operatorHandler

putFunction

public TagHandler putFunction(String key,
 String jepName)

Adds a handler for a Jep function, uses the standardFunctionHandler

Parameters:

key - name of the MathML element

jepName - name of the function used in jep

Returns:

standardFunctionHandler

putConstantElement

public TagHandler putConstantElement(String key,
 String jepName)

Add a handler for elements representing a constant.

Parameters:

key - the name of the mathml element

jepName - name of the variable used in jep

Returns:

constantHandler

putSpecialNode

public TagHandler putSpecialNode(String key,
 int nchildren)

Adds a handler for special nodes like <sep/>, <logbase> and >degree< which only have meaning inside other elements. These are handled by the SpecialNodeHandler

Parameters:

key - tag name

nchildren - number of children

Returns:

the handler

remove

public TagHandler remove(String key)

Remove the handler associated with a give mathml element.

Parameters:

key - name of element

Returns:

the handler

getMathMLEntitiesString

public String getMathMLEntitiesString()

Returns a string with a simple DOCTYPE declaration with defined entities.

Returns:

string containing DOCTYPE deceleration

isPrependMathMLEntities

public boolean isPrependMathMLEntities()

setPrependMathMLEntities

public void setPrependMathMLEntities(boolean prependMathMLEntities)

Whether to prepend a simple deceleration to the start of the document. This can be used to parse documents containing entities like &ExponentialE; without having to include the full MathML DTD.

Parameters:

prependMathMLEntities -

See Also:

• putEntity(java.lang.String, java.lang.String, java.lang.String)

putEntity

public TagHandler putEntity(String entityName,
 String unicode,
 String jepVariableName)

Adds a handler for a MathML Entity representing a constant. Entity deceleration will be added to MathMLEntitiesString which will be added to the start of the document if preprendMathMLEntities is true.

Parameters:

entityName - name of the entity, e.g. "ExponentialE"

unicode - unicode character for entity, "\\u2147"

jepVariableName - name of variable used in jep, "e"

Returns:

the constantHandler

See Also:

• setPrependMathMLEntities(boolean)

removeEntity

public TagHandler removeEntity(String key)

getSAXParserFactory

public SAXParserFactory getSAXParserFactory()

setSAXParserFactory

public void setSAXParserFactory(SAXParserFactory spf)