org.mule.runtime.extension.api.dsql

Class DefaultQueryBuilder

java.lang.Object

org.mule.runtime.extension.api.dsql.DefaultQueryBuilder

All Implemented Interfaces:

QueryBuilder

public class DefaultQueryBuilder
extends Object
implements QueryBuilder

Builder pattern implementation to build DsqlQuerys incrementally.

Intended to be used by Studio/Mozart.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
QueryBuilder	addField(Field field) Sets one of the selected fields from the queried entity.
QueryBuilder	addOrderByField(Field field) Sets one of the fields to order by from.
DsqlQuery	build() Returns the final builded DsqlQuery.
static DefaultQueryBuilder	getInstance()
QueryBuilder	setDirection(Direction direction) Sets the sorting direction of the query.
QueryBuilder	setFilterExpression(Expression expression) Sets an expression to filter the returned query elements.
QueryBuilder	setLimit(int limit) Sets the maximum results that can be retrieved by the builded query.
QueryBuilder	setOffset(int offset) Sets the number of items to skip from the beginning of the result set.
QueryBuilder	setType(EntityType type) Sets the queried entity exposed by the application.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DefaultQueryBuilder getInstance()

Returns:

a new DefaultQueryBuilder instance.

setType

public QueryBuilder setType(EntityType type)

Sets the queried entity exposed by the application.

Specified by:

setType in interface QueryBuilder

Parameters:

type - the queried entity type.

Returns:

this QueryBuilder instance.

addField

public QueryBuilder addField(Field field)

Sets one of the selected fields from the queried entity.

Specified by:

addField in interface QueryBuilder

Parameters:

field - a selected field from the queried entity

Returns:

this QueryBuilder instance.

addOrderByField

public QueryBuilder addOrderByField(Field field)

Sets one of the fields to order by from.

Specified by:

addOrderByField in interface QueryBuilder

Parameters:

field - a field used to sort the query.

Returns:

this QueryBuilder instance.

setDirection

public QueryBuilder setDirection(Direction direction)

Sets the sorting direction of the query.

Specified by:

setDirection in interface QueryBuilder

Parameters:

direction - the sorting direction, ASCENDING or DESCENDING.

Returns:

this QueryBuilder instance.

setFilterExpression

public QueryBuilder setFilterExpression(Expression expression)

Sets an expression to filter the returned query elements.

Specified by:

setFilterExpression in interface QueryBuilder

Parameters:

expression - a filter expression.

Returns:

this QueryBuilder instance.

setLimit

public QueryBuilder setLimit(int limit)

Sets the maximum results that can be retrieved by the builded query.

Specified by:

setLimit in interface QueryBuilder

Parameters:

limit - the number of max results that can be retrieved by the query.

Returns:

this QueryBuilder instance.

setOffset

public QueryBuilder setOffset(int offset)

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

Specified by:

setOffset in interface QueryBuilder

Parameters:

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

Returns:

this QueryBuilder instance.

build

public DsqlQuery build()

Returns the final builded DsqlQuery.

Specified by:

build in interface QueryBuilder

Returns:

a DsqlQuery instance.