org.xwiki.query
Interface Query

All Known Implementing Classes:

DefaultQuery

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 java.lang.String	HQL Indicator for Hibernate Query Language.
static java.lang.String	XPATH Indicator for XPath language.
static java.lang.String	XWQL Indicator for XWiki Query Language.

Method Summary

Query	bindValue(int index, java.lang.Object val) Bind positional parameter (?index in JPQL) with value val in query statement.
Query	bindValue(java.lang.String var, java.lang.Object val) Bind named parameter var with value val in query statement.
Query	bindValues(java.util.List<java.lang.Object> values) Bind list of positional parameters values.
<T> java.util.List<T>	execute()
java.lang.String	getLanguage()
int	getLimit()
java.util.Map<java.lang.String,java.lang.Object>	getNamedParameters()
int	getOffset()
java.util.Map<java.lang.Integer,java.lang.Object>	getPositionalParameters()
java.lang.String	getStatement()
java.lang.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(java.lang.String wiki)

Field Detail

HQL

static final java.lang.String HQL

Indicator for Hibernate Query Language.

See Also:

Constant Field Values

XPATH

static final java.lang.String XPATH

Indicator for XPath language.

See Also:

Constant Field Values

XWQL

static final java.lang.String XWQL

Indicator for XWiki Query Language.

See Also:

Constant Field Values

Method Detail

getStatement

java.lang.String getStatement()

Returns:

Query statement or query name depends on isNamed()

getLanguage

java.lang.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(java.lang.String wiki)

Parameters:

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

Returns:

this query.

getWiki

java.lang.String getWiki()

Returns:

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

See Also:

setWiki(String)

bindValue

Query bindValue(java.lang.String var,
                java.lang.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,
                java.lang.Object val)

Bind positional parameter (?index in JPQL) with value val in query statement. It is recommended to use named parameters if it acceptable. see bindValue(String, Object)

Parameters:

index - index of positional parameter. Index starting number is depends on store system. According JPQL standard index should start from 1.

val - value of the variable.

Returns:

this query.

bindValues

Query bindValues(java.util.List<java.lang.Object> values)

Bind list of positional parameters values. values[i] became i+1 positional parameter according JPQL. So it works only for "?index" parameters.

Parameters:

values - list of positional parameters values.

Returns:

this query.

See Also:

bindValue(int, Object)

getNamedParameters

java.util.Map<java.lang.String,java.lang.Object> getNamedParameters()

Returns:

map from parameter name to value.

See Also:

bindValue(String, Object)

getPositionalParameters

java.util.Map<java.lang.Integer,java.lang.Object> getPositionalParameters()

Returns:

list of positional parameters values.

See Also:

bindValue(int, Object)

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> java.util.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.