org.exoplatform.services.jcr.impl.core.query

Class QueryImpl

java.lang.Object

org.exoplatform.services.jcr.impl.core.query.AbstractQueryImpl

org.exoplatform.services.jcr.impl.core.query.QueryImpl

All Implemented Interfaces:

javax.jcr.query.Query

public class QueryImpl
extends org.exoplatform.services.jcr.impl.core.query.AbstractQueryImpl

Provides the default implementation for a JCR query.

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryHandler	handler The query handler for this query.
static String	JCR_JQOM A string constant representing the JCR-JQOM query language.
static String	JCR_SQL2 A string constant representing the JCR-SQL2 query language.
protected String	language The syntax of the query statement
protected javax.jcr.Node	node The node where this query is persisted.
protected org.exoplatform.services.jcr.impl.core.query.ExecutableQuery	query The actual query implementation that can be executed
protected org.exoplatform.services.jcr.impl.core.SessionImpl	session The session of the user executing this query
protected String	statement The query statement

Fields inherited from interface javax.jcr.query.Query

SQL, XPATH

Constructor Summary

Constructors

Constructor and Description
QueryImpl()

Method Summary

Modifier and Type	Method and Description
void	bindValue(String varName, javax.jcr.Value value) Binds the given value to the variable named varName.
protected void	checkInitialized() Checks if this query is initialized and throws an IllegalStateException if it is not yet initialized.
protected void	checkNotInitialized() Checks if this query is not yet initialized and throws an IllegalStateException if it is already initialized.
javax.jcr.query.QueryResult	execute() This method simply forwards the execute call to the ExecutableQuery object returned by QueryHandler.createExecutableQuery(org.exoplatform.services.jcr.impl.core.SessionImpl, org.exoplatform.services.jcr.impl.core.SessionDataManager, java.lang.String, java.lang.String).
String	getLanguage()
String	getStatement()
String	getStoredQueryPath()
void	init(org.exoplatform.services.jcr.impl.core.SessionImpl session, org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr, QueryHandler handler, javax.jcr.Node node) Initializes a query instance from a nt:query node.
void	init(org.exoplatform.services.jcr.impl.core.SessionImpl session, org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr, QueryHandler handler, String statement, String language) Initializes a query instance from a query string.
void	setCaseInsensitiveOrder(boolean caseInsensitiveOrder) Setter for caseInsensitiveOrder field.
protected void	setInitialized() Sets the initialized flag.
void	setLimit(long limit) Sets the maximum size of the result set.
void	setOffset(long offset) Sets the start offset of the result set.
javax.jcr.Node	storeAsNode(String absPath)

Methods inherited from class java.lang.Object

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

Field Detail

JCR_SQL2

public static final String JCR_SQL2

A string constant representing the JCR-SQL2 query language.

Since:

JCR 2.0

See Also:

Constant Field Values

JCR_JQOM

public static final String JCR_JQOM

A string constant representing the JCR-JQOM query language.

Since:

JCR 2.0

See Also:

Constant Field Values

session

protected org.exoplatform.services.jcr.impl.core.SessionImpl session

The session of the user executing this query

statement

protected String statement

The query statement

language

protected String language

The syntax of the query statement

query

protected org.exoplatform.services.jcr.impl.core.query.ExecutableQuery query

The actual query implementation that can be executed

node

protected javax.jcr.Node node

The node where this query is persisted. Only set when this is a persisted query.

handler

protected QueryHandler handler

The query handler for this query.

Constructor Detail

QueryImpl

public QueryImpl()

Method Detail

init

public void init(org.exoplatform.services.jcr.impl.core.SessionImpl session,
                 org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr,
                 QueryHandler handler,
                 String statement,
                 String language)
          throws javax.jcr.query.InvalidQueryException

Initializes a query instance from a query string.

Specified by:

init in class org.exoplatform.services.jcr.impl.core.query.AbstractQueryImpl

Parameters:

session - the session of the user executing this query.

itemMgr - the item manager of the session executing this query.

handler - the query handler of the search index.

statement - the query statement.

language - the syntax of the query statement.

Throws:

javax.jcr.query.InvalidQueryException - if the query statement is invalid according to the specified language.

init

public void init(org.exoplatform.services.jcr.impl.core.SessionImpl session,
                 org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr,
                 QueryHandler handler,
                 javax.jcr.Node node)
          throws javax.jcr.query.InvalidQueryException,
                 javax.jcr.RepositoryException

Initializes a query instance from a nt:query node.

Specified by:

init in class org.exoplatform.services.jcr.impl.core.query.AbstractQueryImpl

Parameters:

session - the session of the user executing this query.

itemMgr - the item manager of the session executing this query.

handler - the query handler of the search index.

node - a node of type nt:query.

Throws:

javax.jcr.query.InvalidQueryException - If node is not a valid persisted query (that is, a node of type nt:query).

javax.jcr.RepositoryException - if another error occurs

execute

public javax.jcr.query.QueryResult execute()
                                    throws javax.jcr.RepositoryException

This method simply forwards the execute call to the ExecutableQuery object returned by QueryHandler.createExecutableQuery(org.exoplatform.services.jcr.impl.core.SessionImpl, org.exoplatform.services.jcr.impl.core.SessionDataManager, java.lang.String, java.lang.String).

Throws:

javax.jcr.RepositoryException

getStatement

public String getStatement()

getLanguage

public String getLanguage()

getStoredQueryPath

public String getStoredQueryPath()
                          throws javax.jcr.ItemNotFoundException,
                                 javax.jcr.RepositoryException

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.RepositoryException

storeAsNode

public javax.jcr.Node storeAsNode(String absPath)
                           throws javax.jcr.ItemExistsException,
                                  javax.jcr.PathNotFoundException,
                                  javax.jcr.version.VersionException,
                                  javax.jcr.nodetype.ConstraintViolationException,
                                  javax.jcr.lock.LockException,
                                  javax.jcr.UnsupportedRepositoryOperationException,
                                  javax.jcr.RepositoryException

Throws:

javax.jcr.ItemExistsException

javax.jcr.PathNotFoundException

javax.jcr.version.VersionException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.lock.LockException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

bindValue

public void bindValue(String varName,
                      javax.jcr.Value value)
               throws IllegalArgumentException,
                      javax.jcr.RepositoryException

Binds the given value to the variable named varName.

Parameters:

varName - name of variable in query

value - value to bind

Throws:

IllegalArgumentException - if varName is not a valid variable in this query.

javax.jcr.RepositoryException - if an error occurs.

setLimit

public void setLimit(long limit)

Sets the maximum size of the result set.

Parameters:

limit - new maximum size of the result set

setOffset

public void setOffset(long offset)

Sets the start offset of the result set.

Parameters:

offset - new start offset of the result set

setCaseInsensitiveOrder

public void setCaseInsensitiveOrder(boolean caseInsensitiveOrder)

Setter for caseInsensitiveOrder field.

setInitialized

protected void setInitialized()

Sets the initialized flag.

checkNotInitialized

protected void checkNotInitialized()

Checks if this query is not yet initialized and throws an IllegalStateException if it is already initialized.

checkInitialized

protected void checkInitialized()

Checks if this query is initialized and throws an IllegalStateException if it is not yet initialized.