org.apache.chemistry.opencmis.server.support.query

Class QueryUtilBase<T extends org.antlr.runtime.tree.TreeParser>

java.lang.Object

org.apache.chemistry.opencmis.server.support.query.QueryUtilBase<T>

Type Parameters:

T - AntLR tree grammar, will usually be a CmisQueryWalker but can be custom class for customized (extended) parsers

Direct Known Subclasses:

QueryUtil, QueryUtilStrict

public abstract class QueryUtilBase<T extends org.antlr.runtime.tree.TreeParser>
extends Object

Utility class to help parsing and processing a query statement using the AntLR parser Subclasses have to implement methods that setup parser and query walker and parse and process a query. This class provides common methods for error handling and for storing the necessary opencmis objects for query support

Field Summary

Fields

Modifier and Type	Field and Description
protected org.antlr.runtime.tree.CommonTree	parserTree
protected PredicateWalkerBase	predicateWalker
protected QueryObject	queryObj
protected String	statement
protected org.antlr.runtime.TokenStream	tokens
protected T	walker

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryUtilBase(String statement, TypeManager tm, PredicateWalkerBase pw)

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorMessage(org.antlr.runtime.RecognitionException e)
PredicateWalkerBase	getPredicateWalker()
QueryObject	getQueryObject()
String	getStatement()
T	getWalker()
abstract org.antlr.runtime.tree.CommonTree	parseStatement() Perform the first phase of query processing.
void	processStatement() Fully process a query by parsing and walking it and setting up the supporting objects
void	processStatementUsingCmisExceptions() Same as traverseStatement but throws only CMIS Exceptions
abstract void	walkStatement() Perform the second phase of query processing, analyzes the select part, check for semantic errors, fill the query object.

Methods inherited from class java.lang.Object

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

Field Detail

walker

protected T extends org.antlr.runtime.tree.TreeParser walker

queryObj

protected QueryObject queryObj

predicateWalker

protected PredicateWalkerBase predicateWalker

statement

protected String statement

parserTree

protected org.antlr.runtime.tree.CommonTree parserTree

tokens

protected org.antlr.runtime.TokenStream tokens

Constructor Detail

QueryUtilBase

protected QueryUtilBase(String statement,
             TypeManager tm,
             PredicateWalkerBase pw)

Method Detail

parseStatement

public abstract org.antlr.runtime.tree.CommonTree parseStatement()
                                                          throws org.antlr.runtime.RecognitionException

Perform the first phase of query processing. Setup lexer and parser, parse the statement, check for syntax errors and create an AST

Returns:

the abstract syntax tree of the parsed statement

Throws:

org.antlr.runtime.RecognitionException

walkStatement

public abstract void walkStatement()
                            throws org.antlr.runtime.RecognitionException

Perform the second phase of query processing, analyzes the select part, check for semantic errors, fill the query object. Usually a walker will be CmisQueryWalker (or subclass) if the supporting OpenCMIS query classes are used.

Throws:

org.antlr.runtime.RecognitionException

processStatement

public void processStatement()
                      throws org.antlr.runtime.RecognitionException

Fully process a query by parsing and walking it and setting up the supporting objects

Throws:

org.antlr.runtime.RecognitionException

getWalker

public T getWalker()

getPredicateWalker

public PredicateWalkerBase getPredicateWalker()

getQueryObject

public QueryObject getQueryObject()

getStatement

public String getStatement()

processStatementUsingCmisExceptions

public void processStatementUsingCmisExceptions()

Same as traverseStatement but throws only CMIS Exceptions

Parameters:

statement - CMISQL statement to parse

getErrorMessage

public String getErrorMessage(org.antlr.runtime.RecognitionException e)