org.xwiki.query
Interface Query

public interface Query

This is a Query interface, representing all queries in various languages for various stores.

Note that it was modeled after the JCR Query interface.

Since:

1.6M1

Version:

$Id$

Field Summary

static String	HQL Indicator for Hibernate Query Language.
static String	XPATH Indicator for XPath language.
static String	XWQL Indicator for XWiki Query Language.

Method Summary

Query	addFilter(QueryFilter filter)
Query	bindValue(int index, Object val) Bind a positional parameter present in the statement (?index in XWQL) with a value.
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.
<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()
boolean	isNamed() if the query is named, then getStatement() returns a name of the query, else - a query statement.
Query	setLimit(int limit)
Query	setOffset(int offset)
Query	setWiki(String wiki)

Field Detail

HQL

static final String HQL

Indicator for Hibernate Query Language.

See Also:

Constant Field Values

XPATH

static final String XPATH

Indicator for XPath language.

See Also:

Constant Field Values

XWQL

static final String XWQL

Indicator for XWiki Query Language.

See Also:

Constant Field Values

Method Detail

getStatement

String getStatement()

Returns:

Query statement or query name depends on isNamed()

getLanguage

String getLanguage()

Returns:

Query language. See HQL and others.

isNamed

boolean isNamed()

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

Returns:

is the query named.

setWiki

Query setWiki(String wiki)

Parameters:

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

Returns:

this query.

getWiki

String getWiki()

Returns:

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

See Also:

setWiki(String)

bindValue

Query bindValue(String var,
                Object val)

Bind named parameter var with value val in query statement.

Parameters:

var - variable in query statement (:var).

val - value of the variable.

Returns:

this query.

bindValue

Query bindValue(int index,
                Object val)

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 bindValue(String, Object).

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

Query bindValues(List<Object> values)

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 bindValue(int, Object).

Parameters:

values - list of positional parameters values.

Returns:

this query.

See Also:

bindValue(int, Object)

getNamedParameters

Map<String,Object> getNamedParameters()

Returns:

map from parameter name to value.

See Also:

bindValue(String, Object)

getPositionalParameters

Map<Integer,Object> getPositionalParameters()

Returns:

list of positional parameters values.

See Also:

bindValue(int, Object)

addFilter

Query addFilter(QueryFilter filter)

Parameters:

filter - the QueryFilter to add to this query.

Returns:

this query.

getFilters

List<QueryFilter> getFilters()

Returns:

the list of QueryFilters that will be applied to this query.

setLimit

Query setLimit(int limit)

Parameters:

limit - limit of result list to set (so execute().size() will be <= limit).

Returns:

this query.

setOffset

Query setOffset(int offset)

Parameters:

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

Returns:

this query.

getLimit

int getLimit()

Returns:

limit limit of result list.

See Also:

setLimit(int)

getOffset

int getOffset()

Returns:

offset offset of query result.

See Also:

setOffset(int)

execute

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

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.