org.xwiki.query
Interface QueryManager

All Known Implementing Classes:

AbstractQueryManager, DefaultQueryManager, SecureQueryManager

@ComponentRole
public interface QueryManager

This interface encapsulates methods for the management of search queries.

Since:

1.6M1

Version:

$Id$

See Also:

javax.jcr.query.QueryManager

Method Summary

Query	createQuery(java.lang.String statement, java.lang.String language) Create query for given statement and language.
java.util.Set<java.lang.String>	getLanguages()
Query	getNamedQuery(java.lang.String queryName)
boolean	hasLanguage(java.lang.String language)

Method Detail

createQuery

Query createQuery(java.lang.String statement,
                  java.lang.String language)
                  throws QueryException

Create query for given statement and language. Use createQuery("statement", Query.LANGUAGE). For example: createQuery("select doc.name from XWikiDocument doc", Query.HQL).

Parameters:

statement - query statement.

language - language of the query. Must be one of getLanguages(). Use Query.LANGUAGE for indication.

Returns:

a Query object.

Throws:

QueryException - if language is not supported

getNamedQuery

Query getNamedQuery(java.lang.String queryName)
                    throws QueryException

Parameters:

queryName - name of named query.

Returns:

Query object.

Throws:

QueryException - if there is no query with that name

getLanguages

java.util.Set<java.lang.String> getLanguages()

Returns:

supported languages.

hasLanguage

boolean hasLanguage(java.lang.String language)

Parameters:

language - language to check.

Returns:

is language supported.