Package org.xwiki.query

Class WrappingQuery

java.lang.Object

org.xwiki.query.WrappingQuery

All Implemented Interfaces:

Query

public class WrappingQuery
extends Object
implements Query

Make it simple to change the behavior of a Query by extending this class and overriding only the behavior you wish to alter.

Since:

8.4.5, 9.3RC1

Version:

$Id: 2b293a9af62dccb413f18706591669c1308cd8df $

Field Summary

Fields inherited from interface org.xwiki.query.Query

HQL, XPATH, XWQL

Constructor Summary

Constructors

Constructor	Description
WrappingQuery(Query wrappedQuery)

Method Summary

Modifier and Type	Method	Description
Query	addFilter(QueryFilter filter)
Query	bindValue(int index, Object val)	Bind a positional parameter present in the statement (?index in XWQL) with a value.
QueryParameter	bindValue(String var)	Bind named parameter var with a value that will be constructed using calls to QueryParameter.literal(String), QueryParameter.anychar() and QueryParameter.anyChars().
Query	bindValue(String var, Object val)	Bind named parameter var with value val in query statement.
Query	bindValues(List<Object> values)	Bind a list of positional parameters values.
Query	bindValues(Map<String,?> values)	Bind a map of named parameters values.
<T> List<T>	execute()
List<QueryFilter>	getFilters()
String	getLanguage()
int	getLimit()
Map<String,Object>	getNamedParameters()
int	getOffset()
Map<Integer,Object>	getPositionalParameters()
String	getStatement()
String	getWiki()
Query	getWrappedQuery()
boolean	isNamed()	if the query is named, then Query.getStatement() returns a name of the query, else - a query statement.
Query	setLimit(int limit)
Query	setOffset(int offset)
Query	setWiki(String wiki)

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappingQuery

public WrappingQuery(Query wrappedQuery)

Parameters:

wrappedQuery - the query being wrapped

Method Detail

getWrappedQuery

public Query getWrappedQuery()

Returns:

the wrapped query

getStatement

public String getStatement()

Specified by:

getStatement in interface Query

Returns:

Query statement or query name depends on Query.isNamed()

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface Query

Returns:

Query language. See Query.HQL and others.

isNamed

public boolean isNamed()

Description copied from interface: Query

if the query is named, then Query.getStatement() returns a name of the query, else - a query statement.

Specified by:

isNamed in interface Query

Returns:

is the query named.

setWiki

public Query setWiki(String wiki)

Specified by:

setWiki in interface Query

Parameters:

wiki - virtual wiki to run the query. null is a current wiki.

Returns:

this query

getWiki

public String getWiki()

Specified by:

getWiki in interface Query

Returns:

virtual wiki to run the query. null is a current wiki.

See Also:

Query.setWiki(String)

bindValue

public Query bindValue(String var,
                       Object val)

Description copied from interface: Query

Bind named parameter var with value val in query statement.

Specified by:

bindValue in interface Query

Parameters:

var - variable in query statement (:var).

val - value of the variable.

Returns:

this query

bindValue

public Query bindValue(int index,
                       Object val)

Description copied from interface: Query

Bind a positional parameter present in the statement (?index in XWQL) with a value. It is recommended to use named parameters if it acceptable, see Query.bindValue(String, Object).

Specified by:

bindValue in interface Query

Parameters:

index - index of positional parameter. Index starting number depends on the query language. According to the JPQL standard index should start from 1.

val - value of the variable.

Returns:

this query

bindValues

public Query bindValues(List<Object> values)

Description copied from interface: Query

Bind a list of positional parameters values. This method is a convenience method allowing passing a list of values in one call instead of multiple calls to Query.bindValue(int, Object).

Specified by:

bindValues in interface Query

Parameters:

values - list of positional parameters values.

Returns:

this query

See Also:

Query.bindValue(int, Object)

bindValues

public Query bindValues(Map<String,?> values)

Description copied from interface: Query

Bind a map of named parameters values. This method is a convenience method allowing passing a map of values in one call instead of multiple calls to Query.bindValue(String, Object).

Specified by:

bindValues in interface Query

Parameters:

values - list of positional parameters values.

Returns:

this query

See Also:

Query.bindValue(String, Object)

getNamedParameters

public Map<String,Object> getNamedParameters()

Specified by:

getNamedParameters in interface Query

Returns:

map from parameter name to value.

See Also:

Query.bindValue(String, Object)

bindValue

public QueryParameter bindValue(String var)

Description copied from interface: Query

Bind named parameter var with a value that will be constructed using calls to QueryParameter.literal(String), QueryParameter.anychar() and QueryParameter.anyChars(). In order to perserve the fluent API, it's also possible to call QueryParameter.query() to get back the Query.

Specified by:

bindValue in interface Query

Parameters:

var - the variable in the query statement (:var).

Returns:

an empty QueryParameter that needs to be populated by calling QueryParameter.literal(String), QueryParameter.anychar() and QueryParameter.anyChars()

getPositionalParameters

public Map<Integer,Object> getPositionalParameters()

Specified by:

getPositionalParameters in interface Query

Returns:

list of positional parameters values.

See Also:

Query.bindValue(int, Object)

addFilter

public Query addFilter(QueryFilter filter)

Specified by:

addFilter in interface Query

Parameters:

filter - the QueryFilter to add to this query

Returns:

this query

getFilters

public List<QueryFilter> getFilters()

Specified by:

getFilters in interface Query

Returns:

the list of QueryFilters that will be applied to this query

setLimit

public Query setLimit(int limit)

Specified by:

setLimit in interface Query

Parameters:

limit - see Query.getLimit()

Returns:

this query

setOffset

public Query setOffset(int offset)

Specified by:

setOffset in interface Query

Parameters:

offset - offset of query result to set (skip first "offset" rows)

Returns:

this query

getLimit

public int getLimit()

Specified by:

getLimit in interface Query

Returns:

limit the limit of result list to set (execute().size() <= limit)

See Also:

Query.setLimit(int)

getOffset

public int getOffset()

Specified by:

getOffset in interface Query

Returns:

offset offset of query result.

See Also:

Query.setOffset(int)

execute

public <T> List<T> execute()
                    throws QueryException

Specified by:

execute in interface Query

Type Parameters:

T - expected type of elements in the result list.

Returns:

result list of the query. If several fields are selected then T=Object[].

Throws:

QueryException - if something goes wrong.