org.apache.jackrabbit.spi.commons.query.qom

Class QueryObjectModelFactoryImpl

java.lang.Object

org.apache.jackrabbit.spi.commons.query.qom.QueryObjectModelFactoryImpl

All Implemented Interfaces:

javax.jcr.query.qom.QueryObjectModelConstants, javax.jcr.query.qom.QueryObjectModelFactory

public abstract class QueryObjectModelFactoryImpl
extends Object
implements javax.jcr.query.qom.QueryObjectModelFactory

QueryObjectModelFactoryImpl implements the query object model factory from JSR 283.

Field Summary

Fields inherited from interface javax.jcr.query.qom.QueryObjectModelConstants

JCR_JOIN_TYPE_INNER, JCR_JOIN_TYPE_LEFT_OUTER, JCR_JOIN_TYPE_RIGHT_OUTER, JCR_OPERATOR_EQUAL_TO, JCR_OPERATOR_GREATER_THAN, JCR_OPERATOR_GREATER_THAN_OR_EQUAL_TO, JCR_OPERATOR_LESS_THAN, JCR_OPERATOR_LESS_THAN_OR_EQUAL_TO, JCR_OPERATOR_LIKE, JCR_OPERATOR_NOT_EQUAL_TO, JCR_ORDER_ASCENDING, JCR_ORDER_DESCENDING

Constructor Summary

Constructors

Constructor and Description
QueryObjectModelFactoryImpl(NamePathResolver resolver)

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.query.qom.And	and(javax.jcr.query.qom.Constraint constraint1, javax.jcr.query.qom.Constraint constraint2) Performs a logical conjunction of two other constraints.
javax.jcr.query.qom.Ordering	ascending(javax.jcr.query.qom.DynamicOperand operand) Orders by the value of the specified operand, in ascending order.
javax.jcr.query.qom.BindVariableValue	bindVariable(String bindVariableName) Evaluates to the value of a bind variable.
javax.jcr.query.qom.ChildNode	childNode(String path) Tests whether a node in the default selector is a child of a node reachable by a specified absolute path.
javax.jcr.query.qom.ChildNode	childNode(String selectorName, String path) Tests whether a node in the specified selector is a child of a node reachable by a specified absolute path.
javax.jcr.query.qom.ChildNodeJoinCondition	childNodeJoinCondition(String childSelectorName, String parentSelectorName) Tests whether a first selector's node is a child of a second selector's node.
javax.jcr.query.qom.Column	column(String propertyName) Identifies a property in the default selector to include in the tabular view of query results.
javax.jcr.query.qom.Column	column(String propertyName, String columnName) Identifies a property in the default selector to include in the tabular view of query results.
javax.jcr.query.qom.Column	column(String selectorName, String propertyName, String columnName) Identifies a property in the specified selector to include in the tabular view of query results.
javax.jcr.query.qom.Comparison	comparison(javax.jcr.query.qom.DynamicOperand left, String operatorName, javax.jcr.query.qom.StaticOperand right) Filters node-tuples based on the outcome of a binary operation.
protected abstract javax.jcr.query.qom.QueryObjectModel	createQuery(QueryObjectModelTree qomTree) Creates a query object model from the internal tree representation.
javax.jcr.query.qom.QueryObjectModel	createQuery(javax.jcr.query.qom.Selector selector, javax.jcr.query.qom.Constraint constraint, javax.jcr.query.qom.Ordering[] orderings, javax.jcr.query.qom.Column[] columns) Creates a query with one selector.
javax.jcr.query.qom.QueryObjectModel	createQuery(javax.jcr.query.qom.Source source, javax.jcr.query.qom.Constraint constraint, javax.jcr.query.qom.Ordering[] orderings, javax.jcr.query.qom.Column[] columns) Creates a query with one or more selectors.
javax.jcr.query.qom.DescendantNode	descendantNode(String path) Tests whether a node in the default selector is a descendant of a node reachable by a specified absolute path.
javax.jcr.query.qom.DescendantNode	descendantNode(String selectorName, String path) Tests whether a node in the specified selector is a descendant of a node reachable by a specified absolute path.
javax.jcr.query.qom.DescendantNodeJoinCondition	descendantNodeJoinCondition(String descendantSelectorName, String ancestorSelectorName) Tests whether a first selector's node is a descendant of a second selector's node.
javax.jcr.query.qom.Ordering	descending(javax.jcr.query.qom.DynamicOperand operand) Orders by the value of the specified operand, in descending order.
javax.jcr.query.qom.EquiJoinCondition	equiJoinCondition(String selector1Name, String property1Name, String selector2Name, String property2Name) Tests whether the value of a property in a first selector is equal to the value of a property in a second selector.
javax.jcr.query.qom.FullTextSearch	fullTextSearch(String propertyName, javax.jcr.query.qom.StaticOperand fullTextSearchExpression) Performs a full-text search against the default selector.
javax.jcr.query.qom.FullTextSearch	fullTextSearch(String selectorName, String propertyName, javax.jcr.query.qom.StaticOperand fullTextSearchExpression) Performs a full-text search against the specified selector.
javax.jcr.query.qom.FullTextSearchScore	fullTextSearchScore() Evaluates to a DOUBLE value equal to the full-text search score of a node in the default selector.
javax.jcr.query.qom.FullTextSearchScore	fullTextSearchScore(String selectorName) Evaluates to a DOUBLE value equal to the full-text search score of a node in the specified selector.
javax.jcr.query.qom.Join	join(javax.jcr.query.qom.Source left, javax.jcr.query.qom.Source right, String joinTypeName, javax.jcr.query.qom.JoinCondition joinCondition) Performs a join between two node-tuple sources.
javax.jcr.query.qom.Length	length(javax.jcr.query.qom.PropertyValue propertyValue) Evaluates to the length (or lengths, if multi-valued) of a property.
javax.jcr.query.qom.Literal	literal(javax.jcr.Value value) Evaluates to a literal value.
javax.jcr.query.qom.LowerCase	lowerCase(javax.jcr.query.qom.DynamicOperand operand) Evaluates to the lower-case string value (or values, if multi-valued) of an operand.
javax.jcr.query.qom.NodeLocalName	nodeLocalName() Evaluates to a NAME value equal to the local (unprefixed) name of a node in the default selector.
javax.jcr.query.qom.NodeLocalName	nodeLocalName(String selectorName) Evaluates to a NAME value equal to the local (unprefixed) name of a node in the specified selector.
javax.jcr.query.qom.NodeName	nodeName() Evaluates to a NAME value equal to the prefix-qualified name of a node in the default selector.
javax.jcr.query.qom.NodeName	nodeName(String selectorName) Evaluates to a NAME value equal to the prefix-qualified name of a node in the specified selector.
javax.jcr.query.qom.Not	not(javax.jcr.query.qom.Constraint constraint) Performs a logical negation of another constraint.
javax.jcr.query.qom.Or	or(javax.jcr.query.qom.Constraint constraint1, javax.jcr.query.qom.Constraint constraint2) Performs a logical disjunction of two other constraints.
javax.jcr.query.qom.PropertyExistence	propertyExistence(String propertyName) Tests the existence of a property in the default selector.
javax.jcr.query.qom.PropertyExistence	propertyExistence(String selectorName, String propertyName) Tests the existence of a property in the specified selector.
javax.jcr.query.qom.PropertyValue	propertyValue(String propertyName) Evaluates to the value (or values, if multi-valued) of a property of the default selector.
javax.jcr.query.qom.PropertyValue	propertyValue(String selectorName, String propertyName) Evaluates to the value (or values, if multi-valued) of a property in the specified selector.
javax.jcr.query.qom.SameNode	sameNode(String path) Tests whether a node in the default selector is reachable by a specified absolute path.
javax.jcr.query.qom.SameNode	sameNode(String selectorName, String path) Tests whether a node in the specified selector is reachable by a specified absolute path.
javax.jcr.query.qom.SameNodeJoinCondition	sameNodeJoinCondition(String selector1Name, String selector2Name) Tests whether a first selector's node is the same as a second selector's node.
javax.jcr.query.qom.SameNodeJoinCondition	sameNodeJoinCondition(String selector1Name, String selector2Name, String selector2Path) Tests whether a first selector's node is the same as a node identified by relative path from a second selector's node.
javax.jcr.query.qom.Selector	selector(String nodeTypeName) Selects a subset of the nodes in the repository based on node type.
javax.jcr.query.qom.Selector	selector(String nodeTypeName, String selectorName) Selects a subset of the nodes in the repository based on node type.
javax.jcr.query.qom.UpperCase	upperCase(javax.jcr.query.qom.DynamicOperand operand) Evaluates to the upper-case string value (or values, if multi-valued) of an operand.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryObjectModelFactoryImpl

public QueryObjectModelFactoryImpl(NamePathResolver resolver)

Method Detail

createQuery

protected abstract javax.jcr.query.qom.QueryObjectModel createQuery(QueryObjectModelTree qomTree)
                                                             throws javax.jcr.query.InvalidQueryException,
                                                                    javax.jcr.RepositoryException

Creates a query object model from the internal tree representation.

Parameters:

qomTree - the qom tree.

Returns:

a query object model that can be executed.

Throws:

javax.jcr.query.InvalidQueryException - the the query object model tree is considered invalid by the query handler implementation.

javax.jcr.RepositoryException - if any other error occurs.

createQuery

public javax.jcr.query.qom.QueryObjectModel createQuery(javax.jcr.query.qom.Selector selector,
                                               javax.jcr.query.qom.Constraint constraint,
                                               javax.jcr.query.qom.Ordering[] orderings,
                                               javax.jcr.query.qom.Column[] columns)
                                                 throws javax.jcr.query.InvalidQueryException,
                                                        javax.jcr.RepositoryException

Creates a query with one selector.

The specified selector will be the default selector of the query.

Parameters:

selector - the selector; non-null

constraint - the constraint, or null if none

orderings - zero or more orderings; null is equivalent to a zero-length array

columns - the columns; null is equivalent to a zero-length array

Returns:

the query; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

createQuery

public javax.jcr.query.qom.QueryObjectModel createQuery(javax.jcr.query.qom.Source source,
                                               javax.jcr.query.qom.Constraint constraint,
                                               javax.jcr.query.qom.Ordering[] orderings,
                                               javax.jcr.query.qom.Column[] columns)
                                                 throws javax.jcr.query.InvalidQueryException,
                                                        javax.jcr.RepositoryException

Creates a query with one or more selectors.

If source is a selector, that selector is the default selector of the query. Otherwise the query does not have a default selector.

Specified by:

createQuery in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

source - the node-tuple source; non-null

constraint - the constraint, or null if none

orderings - zero or more orderings; null is equivalent to a zero-length array

columns - the columns; null is equivalent to a zero-length array

Returns:

the query; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

selector

public javax.jcr.query.qom.Selector selector(String nodeTypeName)
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Selects a subset of the nodes in the repository based on node type.

The selector name is the node type name.

Parameters:

nodeTypeName - the name of the required node type; non-null

Returns:

the selector; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

selector

public javax.jcr.query.qom.Selector selector(String nodeTypeName,
                                    String selectorName)
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Selects a subset of the nodes in the repository based on node type.

Specified by:

selector in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

nodeTypeName - the name of the required node type; non-null

selectorName - the selector name; non-null

Returns:

the selector; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

join

public javax.jcr.query.qom.Join join(javax.jcr.query.qom.Source left,
                            javax.jcr.query.qom.Source right,
                            String joinTypeName,
                            javax.jcr.query.qom.JoinCondition joinCondition)
                              throws javax.jcr.query.InvalidQueryException,
                                     javax.jcr.RepositoryException

Performs a join between two node-tuple sources.

Specified by:

join in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

left - the left node-tuple source; non-null

right - the right node-tuple source; non-null

joinTypeName - either

• QueryObjectModelConstants.JCR_JOIN_TYPE_INNER,
• QueryObjectModelConstants.JCR_JOIN_TYPE_LEFT_OUTER,
• QueryObjectModelConstants.JCR_JOIN_TYPE_RIGHT_OUTER

joinCondition - the join condition; non-null

Returns:

the join; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

equiJoinCondition

public javax.jcr.query.qom.EquiJoinCondition equiJoinCondition(String selector1Name,
                                                      String property1Name,
                                                      String selector2Name,
                                                      String property2Name)
                                                        throws javax.jcr.query.InvalidQueryException,
                                                               javax.jcr.RepositoryException

Tests whether the value of a property in a first selector is equal to the value of a property in a second selector.

Specified by:

equiJoinCondition in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selector1Name - the name of the first selector; non-null

property1Name - the property name in the first selector; non-null

selector2Name - the name of the second selector; non-null

property2Name - the property name in the second selector; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

sameNodeJoinCondition

public javax.jcr.query.qom.SameNodeJoinCondition sameNodeJoinCondition(String selector1Name,
                                                              String selector2Name)
                                                                throws javax.jcr.query.InvalidQueryException,
                                                                       javax.jcr.RepositoryException

Tests whether a first selector's node is the same as a second selector's node.

Parameters:

selector1Name - the name of the first selector; non-null

selector2Name - the name of the second selector; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

sameNodeJoinCondition

public javax.jcr.query.qom.SameNodeJoinCondition sameNodeJoinCondition(String selector1Name,
                                                              String selector2Name,
                                                              String selector2Path)
                                                                throws javax.jcr.query.InvalidQueryException,
                                                                       javax.jcr.RepositoryException

Tests whether a first selector's node is the same as a node identified by relative path from a second selector's node.

Specified by:

sameNodeJoinCondition in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selector1Name - the name of the first selector; non-null

selector2Name - the name of the second selector; non-null

selector2Path - the path relative to the second selector; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

childNodeJoinCondition

public javax.jcr.query.qom.ChildNodeJoinCondition childNodeJoinCondition(String childSelectorName,
                                                                String parentSelectorName)
                                                                  throws javax.jcr.query.InvalidQueryException,
                                                                         javax.jcr.RepositoryException

Tests whether a first selector's node is a child of a second selector's node.

Specified by:

childNodeJoinCondition in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

childSelectorName - the name of the child selector; non-null

parentSelectorName - the name of the parent selector; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

descendantNodeJoinCondition

public javax.jcr.query.qom.DescendantNodeJoinCondition descendantNodeJoinCondition(String descendantSelectorName,
                                                                          String ancestorSelectorName)
                                                                            throws javax.jcr.query.InvalidQueryException,
                                                                                   javax.jcr.RepositoryException

Tests whether a first selector's node is a descendant of a second selector's node.

Specified by:

descendantNodeJoinCondition in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

descendantSelectorName - the name of the descendant selector; non-null

ancestorSelectorName - the name of the ancestor selector; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

and

public javax.jcr.query.qom.And and(javax.jcr.query.qom.Constraint constraint1,
                          javax.jcr.query.qom.Constraint constraint2)
                            throws javax.jcr.query.InvalidQueryException,
                                   javax.jcr.RepositoryException

Performs a logical conjunction of two other constraints.

Specified by:

and in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

constraint1 - the first constraint; non-null

constraint2 - the second constraint; non-null

Returns:

the And constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

or

public javax.jcr.query.qom.Or or(javax.jcr.query.qom.Constraint constraint1,
                        javax.jcr.query.qom.Constraint constraint2)
                          throws javax.jcr.query.InvalidQueryException,
                                 javax.jcr.RepositoryException

Performs a logical disjunction of two other constraints.

Specified by:

or in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

constraint1 - the first constraint; non-null

constraint2 - the second constraint; non-null

Returns:

the Or constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

not

public javax.jcr.query.qom.Not not(javax.jcr.query.qom.Constraint constraint)
                            throws javax.jcr.query.InvalidQueryException,
                                   javax.jcr.RepositoryException

Performs a logical negation of another constraint.

Specified by:

not in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

constraint - the constraint to be negated; non-null

Returns:

the Not constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

comparison

public javax.jcr.query.qom.Comparison comparison(javax.jcr.query.qom.DynamicOperand left,
                                        String operatorName,
                                        javax.jcr.query.qom.StaticOperand right)
                                          throws javax.jcr.query.InvalidQueryException,
                                                 javax.jcr.RepositoryException

Filters node-tuples based on the outcome of a binary operation.

Specified by:

comparison in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

left - the first operand; non-null

operatorName - the operator; either

• QueryObjectModelConstants.JCR_OPERATOR_EQUAL_TO,
• QueryObjectModelConstants.JCR_OPERATOR_NOT_EQUAL_TO,
• QueryObjectModelConstants.JCR_OPERATOR_LESS_THAN,
• QueryObjectModelConstants.JCR_OPERATOR_LESS_THAN_OR_EQUAL_TO,
• QueryObjectModelConstants.JCR_OPERATOR_GREATER_THAN,
• QueryObjectModelConstants.JCR_OPERATOR_GREATER_THAN_OR_EQUAL_TO, or
• QueryObjectModelConstants.JCR_OPERATOR_LIKE

right - the second operand; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

propertyExistence

public javax.jcr.query.qom.PropertyExistence propertyExistence(String propertyName)
                                                        throws javax.jcr.query.InvalidQueryException,
                                                               javax.jcr.RepositoryException

Tests the existence of a property in the default selector.

Parameters:

propertyName - the property name; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

propertyExistence

public javax.jcr.query.qom.PropertyExistence propertyExistence(String selectorName,
                                                      String propertyName)
                                                        throws javax.jcr.query.InvalidQueryException,
                                                               javax.jcr.RepositoryException

Tests the existence of a property in the specified selector.

Specified by:

propertyExistence in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

propertyName - the property name; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

fullTextSearch

public javax.jcr.query.qom.FullTextSearch fullTextSearch(String propertyName,
                                                javax.jcr.query.qom.StaticOperand fullTextSearchExpression)
                                                  throws javax.jcr.query.InvalidQueryException,
                                                         javax.jcr.RepositoryException

Performs a full-text search against the default selector.

Parameters:

propertyName - the property name, or null to search all full-text indexed properties of the node (or node subtree, in some implementations)

fullTextSearchExpression - the full-text search expression; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

fullTextSearch

public javax.jcr.query.qom.FullTextSearch fullTextSearch(String selectorName,
                                                String propertyName,
                                                javax.jcr.query.qom.StaticOperand fullTextSearchExpression)
                                                  throws javax.jcr.query.InvalidQueryException,
                                                         javax.jcr.RepositoryException

Performs a full-text search against the specified selector.

Specified by:

fullTextSearch in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

propertyName - the property name, or null to search all full-text indexed properties of the node (or node subtree, in some implementations)

fullTextSearchExpression - the full-text search expression; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

sameNode

public javax.jcr.query.qom.SameNode sameNode(String path)
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Tests whether a node in the default selector is reachable by a specified absolute path.

Parameters:

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

sameNode

public javax.jcr.query.qom.SameNode sameNode(String selectorName,
                                    String path)
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Tests whether a node in the specified selector is reachable by a specified absolute path.

Specified by:

sameNode in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

childNode

public javax.jcr.query.qom.ChildNode childNode(String path)
                                        throws javax.jcr.query.InvalidQueryException,
                                               javax.jcr.RepositoryException

Tests whether a node in the default selector is a child of a node reachable by a specified absolute path.

Parameters:

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

childNode

public javax.jcr.query.qom.ChildNode childNode(String selectorName,
                                      String path)
                                        throws javax.jcr.query.InvalidQueryException,
                                               javax.jcr.RepositoryException

Tests whether a node in the specified selector is a child of a node reachable by a specified absolute path.

Specified by:

childNode in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

descendantNode

public javax.jcr.query.qom.DescendantNode descendantNode(String path)
                                                  throws javax.jcr.query.InvalidQueryException,
                                                         javax.jcr.RepositoryException

Tests whether a node in the default selector is a descendant of a node reachable by a specified absolute path.

Parameters:

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

descendantNode

public javax.jcr.query.qom.DescendantNode descendantNode(String selectorName,
                                                String path)
                                                  throws javax.jcr.query.InvalidQueryException,
                                                         javax.jcr.RepositoryException

Tests whether a node in the specified selector is a descendant of a node reachable by a specified absolute path.

Specified by:

descendantNode in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

path - an absolute path; non-null

Returns:

the constraint; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

propertyValue

public javax.jcr.query.qom.PropertyValue propertyValue(String propertyName)
                                                throws javax.jcr.query.InvalidQueryException,
                                                       javax.jcr.RepositoryException

Evaluates to the value (or values, if multi-valued) of a property of the default selector.

Parameters:

propertyName - the property name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

propertyValue

public javax.jcr.query.qom.PropertyValue propertyValue(String selectorName,
                                              String propertyName)
                                                throws javax.jcr.query.InvalidQueryException,
                                                       javax.jcr.RepositoryException

Evaluates to the value (or values, if multi-valued) of a property in the specified selector.

Specified by:

propertyValue in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

propertyName - the property name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

length

public javax.jcr.query.qom.Length length(javax.jcr.query.qom.PropertyValue propertyValue)
                                  throws javax.jcr.query.InvalidQueryException,
                                         javax.jcr.RepositoryException

Evaluates to the length (or lengths, if multi-valued) of a property.

Specified by:

length in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

propertyValue - the property value for which to compute the length; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

nodeName

public javax.jcr.query.qom.NodeName nodeName()
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Evaluates to a NAME value equal to the prefix-qualified name of a node in the default selector.

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

nodeName

public javax.jcr.query.qom.NodeName nodeName(String selectorName)
                                      throws javax.jcr.query.InvalidQueryException,
                                             javax.jcr.RepositoryException

Evaluates to a NAME value equal to the prefix-qualified name of a node in the specified selector.

Specified by:

nodeName in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

nodeLocalName

public javax.jcr.query.qom.NodeLocalName nodeLocalName()
                                                throws javax.jcr.query.InvalidQueryException,
                                                       javax.jcr.RepositoryException

Evaluates to a NAME value equal to the local (unprefixed) name of a node in the default selector.

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

nodeLocalName

public javax.jcr.query.qom.NodeLocalName nodeLocalName(String selectorName)
                                                throws javax.jcr.query.InvalidQueryException,
                                                       javax.jcr.RepositoryException

Evaluates to a NAME value equal to the local (unprefixed) name of a node in the specified selector.

Specified by:

nodeLocalName in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

fullTextSearchScore

public javax.jcr.query.qom.FullTextSearchScore fullTextSearchScore()
                                                            throws javax.jcr.query.InvalidQueryException,
                                                                   javax.jcr.RepositoryException

Evaluates to a DOUBLE value equal to the full-text search score of a node in the default selector.

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

fullTextSearchScore

public javax.jcr.query.qom.FullTextSearchScore fullTextSearchScore(String selectorName)
                                                            throws javax.jcr.query.InvalidQueryException,
                                                                   javax.jcr.RepositoryException

Evaluates to a DOUBLE value equal to the full-text search score of a node in the specified selector.

Specified by:

fullTextSearchScore in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

lowerCase

public javax.jcr.query.qom.LowerCase lowerCase(javax.jcr.query.qom.DynamicOperand operand)
                                        throws javax.jcr.query.InvalidQueryException,
                                               javax.jcr.RepositoryException

Evaluates to the lower-case string value (or values, if multi-valued) of an operand.

Specified by:

lowerCase in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

operand - the operand whose value is converted to a lower-case string; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

upperCase

public javax.jcr.query.qom.UpperCase upperCase(javax.jcr.query.qom.DynamicOperand operand)
                                        throws javax.jcr.query.InvalidQueryException,
                                               javax.jcr.RepositoryException

Evaluates to the upper-case string value (or values, if multi-valued) of an operand.

Specified by:

upperCase in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

operand - the operand whose value is converted to a upper-case string; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

bindVariable

public javax.jcr.query.qom.BindVariableValue bindVariable(String bindVariableName)
                                                   throws javax.jcr.query.InvalidQueryException,
                                                          javax.jcr.RepositoryException

Evaluates to the value of a bind variable.

Specified by:

bindVariable in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

bindVariableName - the bind variable name; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

literal

public javax.jcr.query.qom.Literal literal(javax.jcr.Value value)
                                    throws javax.jcr.query.InvalidQueryException,
                                           javax.jcr.RepositoryException

Evaluates to a literal value.

Specified by:

literal in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

value - a JCR value; non-null

Returns:

the operand; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

ascending

public javax.jcr.query.qom.Ordering ascending(javax.jcr.query.qom.DynamicOperand operand)
                                       throws javax.jcr.query.InvalidQueryException,
                                              javax.jcr.RepositoryException

Orders by the value of the specified operand, in ascending order.

Specified by:

ascending in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

operand - the operand by which to order; non-null

Returns:

the ordering

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

descending

public javax.jcr.query.qom.Ordering descending(javax.jcr.query.qom.DynamicOperand operand)
                                        throws javax.jcr.query.InvalidQueryException,
                                               javax.jcr.RepositoryException

Orders by the value of the specified operand, in descending order.

Specified by:

descending in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

operand - the operand by which to order; non-null

Returns:

the ordering

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails

column

public javax.jcr.query.qom.Column column(String propertyName)
                                  throws javax.jcr.query.InvalidQueryException,
                                         javax.jcr.RepositoryException

Identifies a property in the default selector to include in the tabular view of query results.

The column name is the property name.

Parameters:

propertyName - the property name, or null to include a column for each single-value non-residual property of the selector's node type

Returns:

the column; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

column

public javax.jcr.query.qom.Column column(String propertyName,
                                String columnName)
                                  throws javax.jcr.query.InvalidQueryException,
                                         javax.jcr.RepositoryException

Identifies a property in the default selector to include in the tabular view of query results.

Parameters:

propertyName - the property name, or null to include a column for each single-value non-residual property of the selector's node type

columnName - the column name; must be null if propertyName is null

Returns:

the column; non-null

Throws:

javax.jcr.query.InvalidQueryException - if the query has no default selector or is otherwise invalid

javax.jcr.RepositoryException - if the operation otherwise fails

column

public javax.jcr.query.qom.Column column(String selectorName,
                                String propertyName,
                                String columnName)
                                  throws javax.jcr.query.InvalidQueryException,
                                         javax.jcr.RepositoryException

Identifies a property in the specified selector to include in the tabular view of query results.

Specified by:

column in interface javax.jcr.query.qom.QueryObjectModelFactory

Parameters:

selectorName - the selector name; non-null

propertyName - the property name, or null to include a column for each single-value non-residual property of the selector's node type

columnName - the column name; if null, defaults to propertyName; must be null if propertyName is null

Throws:

javax.jcr.query.InvalidQueryException - if the query is invalid

javax.jcr.RepositoryException - if the operation otherwise fails