public interface Query
Query
object.Modifier and Type | Field and Description |
---|---|
static String |
SQL
A String constant representing the SQL query language applied to the database view
of the workspace.
|
static String |
XPATH
A String constant representing the XPath query language applied to the document view
XML mapping of the workspace.
|
Modifier and Type | Method and Description |
---|---|
QueryResult |
execute()
Executes this query and returns a
. |
String |
getLanguage()
Returns the language set for this query.
|
String |
getStatement()
Returns the statement set for this query.
|
String |
getStoredQueryPath()
If this is a
Query object that has been stored using
storeAsNode(java.lang.String) (regardless of whether it has been save d yet)
or retrieved using QueryManager.getQuery(javax.jcr.Node) ), then this method
returns the path of the nt:query node that stores the query. |
Node |
storeAsNode(String absPath)
Creates a node representing this
Query in content. |
static final String XPATH
QueryManager.createQuery(java.lang.String, java.lang.String)
.
Also among the strings returned by QueryManager.getSupportedQueryLanguages()
.static final String SQL
QueryManager.createQuery(java.lang.String, java.lang.String)
.
Also among the strings returned by QueryManager.getSupportedQueryLanguages()
.QueryResult execute() throws RepositoryException
QueryResult
.QueryResult
RepositoryException
- if an error occursString getStatement()
String getLanguage()
QueryManager.getSupportedQueryLanguages()
.String getStoredQueryPath() throws ItemNotFoundException, RepositoryException
Query
object that has been stored using
storeAsNode(java.lang.String)
(regardless of whether it has been save
d yet)
or retrieved using QueryManager.getQuery(javax.jcr.Node)
), then this method
returns the path of the nt:query
node that stores the query.
If this is a transient query (that is, a Query
object created with
QueryManager.createQuery(java.lang.String, java.lang.String)
but not yet stored) then this method throws an
ItemNotFoundException
.ItemNotFoundException
- if this query is not a stored query.RepositoryException
- if another error occurs.Node storeAsNode(String absPath) throws ItemExistsException, PathNotFoundException, VersionException, ConstraintViolationException, LockException, UnsupportedRepositoryOperationException, RepositoryException
Query
in content.
In a level 1 repository this method throws an UnsupportedRepositoryOperationException
.
In a level 2 repository it creates a node of type nt:query
at absPath
and returns that node.
In order to persist the newly created node, a save
must be performed that includes the
parent of this new node within its scope. In other words, either a Session.save
or
an Item.save
on the parent or higher-degree ancestor of absPath
must be performed.
An ItemExistsException
will be thrown either immediately (by
this method), or on save
, if an item at the specified path already exists
and same-name siblings are not allowed. Implementations may differ on
when this validation is performed.
A PathNotFoundException
will be thrown either immediately
, or on save
, if the specified path implies intermediary
nodes that do not exist. Implementations may differ on when this validation is performed.
A ConstraintViolationException
will be thrown either immediately
or on save
, if adding the node would violate a node type or implementation-specific
constraintor if an attempt is made to add a node as the child of a property.
Implementations may differ on when this validation is performed.
A VersionException
will be thrown either immediately (by
this method), or on save
, if the node to which the new child is being
added is versionable and checked-in or is non-versionable but its nearest
versionable ancestor is checked-in. Implementations may differ on when
this validation is performed.
A LockException
will be thrown either immediately (by
this method), or on save
, if a lock prevents the addition of the node.
Implementations may differ on when this validation is performed.ItemExistsException
- if an item at the specified path already exists,
same-name siblings are not allowed and this implementation performs this
validation immediately instead of waiting until save
.PathNotFoundException
- if the specified path implies intermediary
Node
s that do not exist or the last element of
relPath
has an index, and this implementation performs this
validation immediately instead of waiting until save
.ConstraintViolationException
- if a node type or implementation-specific constraint
is violated or if an attempt is made to add a node as the child of a property and this
implementation performs this validation immediately instead of waiting until save
.VersionException
- if the node to which the new child is being added is versionable and
checked-in or is non-versionable but its nearest versionable ancestor is checked-in and this
implementation performs this validation immediately instead of waiting until save
.LockException
- if a lock prevents the addition of the node and this
implementation performs this validation immediately instead of waiting until save
.UnsupportedRepositoryOperationException
- in a level 1 implementation.RepositoryException
- if another error occurs or if the relPath
provided has
an index on its final element.Copyright © 2004–2013 Day Management AG. All rights reserved.