org.xqdoc.conversion
Interface XQDocParser

public interface XQDocParser

This interface is implemented by the Parsers automatically generated from the ANTLR grammar. The interface was needed because mulitple grammars have been created ... one per XQuery W3C Working Draft. The interface allows the common methods to be abstracted so that the correct Parser can be created through Java reflection yet still referenced via this common interface.

Version:

1.0

Author:

Darin McBeath

Method Summary

void	setContext(XQDocContext context) Set the XQDocContext as a member variable within this Parser.
void	xpath() The method that should be invoked to begin parsing a module.

Method Detail

xpath

void xpath()
           throws antlr.RecognitionException,
                  antlr.TokenStreamException

The method that should be invoked to begin parsing a module.

Throws:

antlr.RecognitionException

antlr.TokenStreamException

setContext

void setContext(XQDocContext context)

Set the XQDocContext as a member variable within this Parser. This allows the Parser to populate member variables (through callbacks) within XQDocContext that will be needed to generate the xqDoc XML. In essence, the context becomes a big 'container' to hold pertinent information.

Parameters:

context - The object that should be populated as the module is parsed.