All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface fr.inria.openmath.omapi.Locator

public interface Locator
Interface for associating an Open-Math parsing event with a location in imput.

If an OpenMath parser provides location information to the application, it does so by implementing this interface and then passing an instance to the application using the handler's setLocator() method. The application can use the object to obtain the location of any event in the source document.

Note that the results returned by the object will be valid only during the scope of each handler method: the application will receive unpredictable results if it attempts to use the locator at any other time.

OpenMath parsers are not required to supply a locator, but they are strongly encouraged to do so. If the parser supplies a locator, it must do so before reporting any other parsing events. If no locator has been set by the time the application receives the startParse event, the application should assume that a locator is not available.

See Also:
setLocator

Method Index

 o getColumnNumber()
Returns the column number where the current parsing event ends.
 o getLineNumber()
Returns the line number where the current parsing event ends.

Methods

 o getLineNumber
 public abstract int getLineNumber()
Returns the line number where the current parsing event ends.

Note that this is the line position of the first character after the text associated with the event.

Returns:
The line number, or -1 if none is available.
See Also:
getColumnNumber
 o getColumnNumber
 public abstract int getColumnNumber()
Returns the column number where the current parsing event ends.

Note that this is the column number of the first character after the text associated with the event. The first column in a line is position 1.

Returns:
The column number, or -1 if none is available.
See Also:
getLineNumber

All Packages  Class Hierarchy  This Package  Previous  Next  Index