cz.ues.platform.commons.query

Class UESQuery

java.lang.Object

cz.ues.platform.commons.query.UESQuery

public abstract class UESQuery
extends java.lang.Object

UES Query is a SQL-like language for arbitrary criteria definition on APIs. This immutable class parses ues query from String and encapsulates it.

Since:

UES6-06

Constructor Summary

Constructors

Constructor and Description
UESQuery()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.Class<? extends java.lang.Object>	getConfigurationBean() Returns the bean class containing ues query configuration
abstract QueryASTElement	getQueryAST() Returns an abstract syntactic tree representation of parsed ues query
abstract java.lang.String	getQueryString() Returns ues query String
static UESQuery	parseQuery(java.lang.String queryString, java.lang.Class<? extends java.lang.Object> queryConfigurationBean) Factory for UESQuery.

Methods inherited from class java.lang.Object

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

Constructor Detail

UESQuery

public UESQuery()

Method Detail

parseQuery

public static UESQuery parseQuery(java.lang.String queryString,
java.lang.Class<? extends java.lang.Object> queryConfigurationBean)
throws UESQueryParserRTException

Factory for UESQuery. It parses ues query String and returns a new instance or throws an exception if the syntax is wrong.

Parameters:

queryString - ues query String to be parsed

queryConfigurationBean - ues query attributes definition based on annotated bean

Returns:

parsed ues query

Throws:

UESQueryParserRTException - when syntax error is detected

getQueryString

public abstract java.lang.String getQueryString()

Returns ues query String

Returns:

ues query String

getQueryAST

public abstract QueryASTElement getQueryAST()

Returns an abstract syntactic tree representation of parsed ues query

Returns:

abstract syntactic tree representation of parsed ues query

getConfigurationBean

public abstract java.lang.Class<? extends java.lang.Object> getConfigurationBean()

Returns the bean class containing ues query configuration

Returns: