fr.ove.openmath.jome.ctrl.om
Class OMTreeParserHandler

java.lang.Object
  fr.inria.openmath.omapi.ParserAdapter
      fr.ove.openmath.jome.ctrl.om.OMTreeParserHandler

All Implemented Interfaces:

fr.inria.openmath.omapi.ParserHandler, java.io.Serializable

public class OMTreeParserHandler

extends fr.inria.openmath.omapi.ParserAdapter

implements java.io.Serializable

The handler for the OpenMath parser.

Version:

2.0 19/11/1999

Author:

© 1999 DIRAT Laurent

See Also:

Serialized Form

Constructor Summary

OMTreeParserHandler()
The constructor.

Method Summary

void	endApplication() Receives notification of the end of an application element.
void	endAttributePairs() Receives notification of the end of an attribute-pairs element.
void	endAttribution() Receives notification of the end of an attribution element.
void	endBind() Receives notification of the beginning of a Bind element.
void	endBVars() Receives notification of the beginning of a BVars element.
void	endError() Receives notification of the end of an error element.
void	endObject() Receives notification of the end of an object element.
void	endParse() Receives notification of the end of parse.
void	readByteArray(byte[] value) Receives notification of a byteArray element.
void	readComment(java.lang.String value) Receives notification of a comment element.
void	readFloat(double value) Receives notification of a floating-point number element.
void	readInteger(fr.inria.openmath.omapi.BigInt value) Receives notification of an Integer element.
void	readString(java.lang.String value) Receives notification of a string element.
void	readSymbol(fr.inria.openmath.omapi.Symbol value) Receives notification of a symbol element.
void	readVariable(java.lang.String name) Receives notification of a variable element.
void	setEventSource(LinearParserEventSource eventSource) Sets the event source.
void	setLocator(fr.inria.openmath.omapi.Locator locator) Receives a Locator for parse events.
void	startApplication() Receives notification of the beginning of a application element.
void	startAttributePairs() Receives notification of the beginning of an attribute-pairs element.
void	startAttribution() Receives notification of the beginning of a attribution element.
void	startBind() Receives notification of the beginning of a Bind element.
void	startBVars() Receives notification of the beginning of a BVars element.
void	startError() Receives notification of the beginning of a error element.
void	startObject() Receives notification of the beginning of a object element.
void	startParse() Receives notification of the beginning of parse (of a set of OpenMath-objects).

Methods inherited from class fr.inria.openmath.omapi.ParserAdapter

readInteger

Methods inherited from class java.lang.Object

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

Constructor Detail

OMTreeParserHandler

public OMTreeParserHandler()

The constructor.
formula must be the root of an empty one.

Method Detail

setLocator

public void setLocator(fr.inria.openmath.omapi.Locator locator)

Receives a Locator for parse events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other events.

Specified by:

setLocator in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

locator - A locator for all OpenMath parse events.

See Also:

ParserHandler.setLocator(fr.inria.openmath.omapi.Locator), Locator

startParse

public void startParse()
                throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of parse (of a set of OpenMath-objects).

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startParse in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

endParse

public void endParse()
              throws fr.inria.openmath.omapi.OMException

Receives notification of the end of parse.

By default, do nothing. Application writers may override this method in a subclass.

The OpenMath parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of the input (no more OpenMath objects).

Specified by:

endParse in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

startObject

public void startObject()
                 throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a object element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startObject in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endObject()

endObject

public void endObject()
               throws fr.inria.openmath.omapi.OMException

Receives notification of the end of an object element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endObject in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startObject()

startApplication

public void startApplication()
                      throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a application element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startApplication in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endApplication()

endApplication

public void endApplication()
                    throws fr.inria.openmath.omapi.OMException

Receives notification of the end of an application element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endApplication in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startApplication()

startAttribution

public void startAttribution()
                      throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a attribution element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startAttribution in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endAttribution()

endAttribution

public void endAttribution()
                    throws fr.inria.openmath.omapi.OMException

Receives notification of the end of an attribution element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endAttribution in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startAttribution()

startAttributePairs

public void startAttributePairs()
                         throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of an attribute-pairs element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startAttributePairs in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endAttributePairs()

endAttributePairs

public void endAttributePairs()
                       throws fr.inria.openmath.omapi.OMException

Receives notification of the end of an attribute-pairs element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endAttributePairs in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startAttribution()

startBind

public void startBind()
               throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a Bind element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startBind in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endBind()

startBVars

public void startBVars()
                throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a BVars element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startBVars in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endBVars()

endBVars

public void endBVars()
              throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a BVars element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endBVars in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startBVars()

endBind

public void endBind()
             throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a Bind element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endBind in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endBind()

startError

public void startError()
                throws fr.inria.openmath.omapi.OMException

Receives notification of the beginning of a error element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

startError in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

endError()

endError

public void endError()
              throws fr.inria.openmath.omapi.OMException

Receives notification of the end of an error element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

endError in interface fr.inria.openmath.omapi.ParserHandler

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

startError()

readInteger

public void readInteger(fr.inria.openmath.omapi.BigInt value)
                 throws fr.inria.openmath.omapi.OMException

Receives notification of an Integer element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readInteger in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this Integer element. This is an infinite precision integer.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

BigInt

readFloat

public void readFloat(double value)
               throws fr.inria.openmath.omapi.OMException

Receives notification of a floating-point number element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readFloat in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this Float element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

readString

public void readString(java.lang.String value)
                throws fr.inria.openmath.omapi.OMException

Receives notification of a string element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readString in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this String element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

readVariable

public void readVariable(java.lang.String name)
                  throws fr.inria.openmath.omapi.OMException

Receives notification of a variable element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readVariable in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

name - the name of this Variable element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

readByteArray

public void readByteArray(byte[] value)
                   throws fr.inria.openmath.omapi.OMException

Receives notification of a byteArray element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readByteArray in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this ByteArray element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

readSymbol

public void readSymbol(fr.inria.openmath.omapi.Symbol value)
                throws fr.inria.openmath.omapi.OMException

Receives notification of a symbol element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readSymbol in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this Symbol element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

Symbol

readComment

public void readComment(java.lang.String value)
                 throws fr.inria.openmath.omapi.OMException

Receives notification of a comment element.

By default, do nothing. Application writers may override this method in a subclass.

Specified by:

readComment in interface fr.inria.openmath.omapi.ParserHandler

Parameters:

value - the value embeded in this Comment element.

Throws:

fr.inria.openmath.omapi.OMException - Any OpenMath exception.

See Also:

Comment

setEventSource

public void setEventSource(LinearParserEventSource eventSource)

Sets the event source.
Even if it is the instance which fires the events during the parsing, the instance (as a handler), just... handles the parser. Basically, in a common sense, it is the parser which fires the events. We try to respect the common sense by setting the right event source : the parser.

Parameters:

eventSource - the event source