org.mule.runtime.extension.api.dsql

Class DsqlQuery

java.lang.Object

org.mule.runtime.extension.api.dsql.DsqlQuery

public final class DsqlQuery
extends Object

Represents a parsed DSQL query.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DsqlQuery(EntityType type, List<Field> fields, List<Field> orderByFields, Direction direction, Expression filterExpression, Integer limit, Integer offset) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Direction	getDirection()
List<Field>	getFields()
Expression	getFilterExpression()
int	getLimit()
int	getOffset()
List<Field>	getOrderByFields()
EntityType	getType()
String	translate(QueryTranslator queryTranslator) Translates this DsqlQuery to a query in another query language using the specified queryTranslator.

Methods inherited from class java.lang.Object

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

Constructor Detail

DsqlQuery

public DsqlQuery(EntityType type,
                 List<Field> fields,
                 List<Field> orderByFields,
                 Direction direction,
                 Expression filterExpression,
                 Integer limit,
                 Integer offset)

Creates a new instance.

Parameters:

type - the entity type to be queried

fields - the selected fields of the entity.

orderByFields - the fields to order the query

direction - ascending or descending sort order.

filterExpression - an expression to filter the result set items.

limit - the maximum number of items to be returned.

offset - the number of items to skip from the beginning of the result set.

Method Detail

getFields

public List<Field> getFields()

Returns:

the selected fields from the queried entity.

getOrderByFields

public List<Field> getOrderByFields()

Returns:

the fields used to sort the result set.

getDirection

public Direction getDirection()

Returns:

the sorting direction.

getFilterExpression

public Expression getFilterExpression()

Returns:

an Expression to filter the queried result set.

getType

public EntityType getType()

Returns:

the entity that is being queried.

getLimit

public int getLimit()

Returns:

the maximum number of item returned in the result set.

getOffset

public int getOffset()

Returns:

the number of items to skip from the beginning of the result set.

translate

public String translate(QueryTranslator queryTranslator)

Translates this DsqlQuery to a query in another query language using the specified queryTranslator.

Parameters:

queryTranslator - a QueryTranslator instance used to translate from DSQL to another query language.

Returns:

a String that represents a translated query using the queryTranslator.