javax.jcr.query.QueryManager Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Copyright 2009 Day Management AG, Switzerland. All rights reserved.
*/
package javax.jcr.query;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.query.qom.QueryObjectModelFactory;
/**
* This interface encapsulates methods for the management of search queries.
* Provides methods for the creation and retrieval of search queries.
*/
public interface QueryManager {
/**
* Creates a new query by specifying the query statement itself
* and the language in which the query is stated. The
* language must be a string from among those returned by
* QueryManager.getSupportedQueryLanguages().
*
* @param statement a String
* @param language a String
* @return a Query object
* @throws InvalidQueryException if the query statement is syntactically
* invalid or the specified language is not supported.
* @throws RepositoryException if another error occurs.
*/
public Query createQuery(String statement, String language) throws InvalidQueryException, RepositoryException;
/**
* Returns a QueryObjectModelFactory with which a JCR-JQOM
* query can be built programmatically.
*
* @return a QueryObjectModelFactory object
* @since JCR 2.0
*/
public QueryObjectModelFactory getQOMFactory();
/**
* Retrieves an existing persistent query.
*
* Persistent queries are created by first using {@link
* QueryManager#createQuery} to create a Query object and then
* calling Query.save to persist the query to a location in the
* workspace.
*
* @param node a persisted query (that is, a node of type
* nt:query).
* @return a Query object.
* @throws InvalidQueryException If node is not a valid
* persisted query (that is, a node of type nt:query).
* @throws RepositoryException if another error occurs
*/
public Query getQuery(Node node) throws InvalidQueryException, RepositoryException;
/**
* Returns an array of strings representing all query languages supported by
* this repository. This set must include at least the strings represented
* by the constants {@link Query#JCR_SQL2} and {@link Query#JCR_JQOM}}. An
* implementation may also support other languages, including the deprecated
* languages of JCR 1.0: {@link Query#XPATH} and {@link Query#SQL}.
*
* @return A string array.
* @throws RepositoryException if an error occurs.
*/
public String[] getSupportedQueryLanguages() throws RepositoryException;
}