Package javax.jcr.query.qom

Interface QueryObjectModelFactory

All Superinterfaces:

QueryObjectModelConstants

All Known Implementing Classes:

QueryObjectModelFactoryImpl

public interface QueryObjectModelFactory
extends QueryObjectModelConstants

A QueryObjectModelFactory creates instances of the JCR query object model.

Refer to QueryObjectModel for a description of the query object model.

Since:

JCR 2.0

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

Method Summary

Modifier and Type	Method	Description
And	and(Constraint constraint1, Constraint constraint2)	Performs a logical conjunction of two other constraints.
Ordering	ascending(DynamicOperand operand)	Orders by the value of the specified operand, in ascending order.
BindVariableValue	bindVariable(String bindVariableName)	Evaluates to the value of a bind variable.
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.
ChildNodeJoinCondition	childNodeJoinCondition(String childSelectorName, String parentSelectorName)	Tests whether a first selector's node is a child of a second selector's node.
Column	column(String selectorName, String propertyName, String columnName)	Identifies a property in the specified selector to include in the tabular view of query results.
Comparison	comparison(DynamicOperand operand1, String operator, StaticOperand operand2)	Filters node-tuples based on the outcome of a binary operation.
QueryObjectModel	createQuery(Source source, Constraint constraint, Ordering[] orderings, Column[] columns)	Creates a query with one or more selectors.
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.
DescendantNodeJoinCondition	descendantNodeJoinCondition(String descendantSelectorName, String ancestorSelectorName)	Tests whether a first selector's node is a descendant of a second selector's node.
Ordering	descending(DynamicOperand operand)	Orders by the value of the specified operand, in descending order.
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.
FullTextSearch	fullTextSearch(String selectorName, String propertyName, StaticOperand fullTextSearchExpression)	Performs a full-text search against the specified selector.
FullTextSearchScore	fullTextSearchScore(String selectorName)	Evaluates to a DOUBLE value equal to the full-text search score of a node in the specified selector.
Join	join(Source left, Source right, String joinType, JoinCondition joinCondition)	Performs a join between two node-tuple sources.
Length	length(PropertyValue propertyValue)	Evaluates to the length (or lengths, if multi-valued) of a property.
Literal	literal(Value literalValue)	Evaluates to a literal value.
LowerCase	lowerCase(DynamicOperand operand)	Evaluates to the lower-case string value (or values, if multi-valued) of an operand.
NodeLocalName	nodeLocalName(String selectorName)	Evaluates to a NAME value equal to the local (unprefixed) name of a node in the specified selector.
NodeName	nodeName(String selectorName)	Evaluates to a NAME value equal to the prefix-qualified name of a node in the specified selector.
Not	not(Constraint constraint)	Performs a logical negation of another constraint.
Or	or(Constraint constraint1, Constraint constraint2)	Performs a logical disjunction of two other constraints.
PropertyExistence	propertyExistence(String selectorName, String propertyName)	Tests the existence of a property in the specified selector.
PropertyValue	propertyValue(String selectorName, String propertyName)	Evaluates to the value (or values, if multi-valued) of a property in the specified selector.
SameNode	sameNode(String selectorName, String path)	Tests whether a node in the specified selector is reachable by a specified absolute path.
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.
Selector	selector(String nodeTypeName, String selectorName)	Selects a subset of the nodes in the repository based on node type.
UpperCase	upperCase(DynamicOperand operand)	Evaluates to the upper-case string value (or values, if multi-valued) of an operand.

Method Details

createQuery

QueryObjectModel createQuery(Source source,
 Constraint constraint,
 Ordering[] orderings,
 Column[] columns)
                      throws InvalidQueryException,
RepositoryException

Creates a query with one or more selectors.

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:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test and the parameters given fail that test. See the individual QOM factory methods for the validity criteria of each query element.

RepositoryException - if another error occurs.

selector

Selector selector(String nodeTypeName,
 String selectorName)
           throws InvalidQueryException,
RepositoryException

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

The query is invalid if nodeTypeName or selectorName is not a syntactically valid JCR name.

The query is invalid if selectorName} is identical to the name of another selector in the query.

The query is also invalid if nodeType is not a valid JCR name or is a valid JCR name but not the name of a node type available in the repository.

Parameters:

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

selectorName - the selector name; non-null

Returns:

the selector; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

join

Join join(Source left,
 Source right,
 String joinType,
 JoinCondition joinCondition)
   throws InvalidQueryException,
RepositoryException

Performs a join between two node-tuple sources.

The query is invalid if left is the same source as right.

Parameters:

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

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

joinType - 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:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

equiJoinCondition

EquiJoinCondition equiJoinCondition(String selector1Name,
 String property1Name,
 String selector2Name,
 String property2Name)
                             throws InvalidQueryException,
RepositoryException

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

The query is invalid if:

• selector1 is not the name of a selector in the query, or
• selector2 is not the name of a selector in the query, or
• selector1 is the same as selector2, or
• property1 is not a syntactically valid JCR name, or
• property2 is not a syntactically valid JCR name, or
• the value of property1 is not the same property type as the value of property2, or
• property1 is a multi-valued property, or
• property2 is a multi-valued property, or
• property1 is a BINARY property, or
• property2 is a BINARY property.

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:

InvalidQueryException - if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

sameNodeJoinCondition

SameNodeJoinCondition sameNodeJoinCondition(String selector1Name,
 String selector2Name,
 String selector2Path)
                                     throws InvalidQueryException,
RepositoryException

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

The query is invalid if:

• selector1 is not the name of a selector in the query, or
• selector2 is not the name of a selector in the query, or
• selector1 is the same as selector2, or
• selector2Path is not a syntactically valid relative path. Note, however, that if the path is syntactically valid but does not identify a node visible to the current session, the query is valid but the constraint is not satisfied.

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:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

childNodeJoinCondition

ChildNodeJoinCondition childNodeJoinCondition(String childSelectorName,
 String parentSelectorName)
                                       throws InvalidQueryException,
RepositoryException

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

The query is invalid if:

• childSelector is not the name of a selector in the query, or
• parentSelector is not the name of a selector in the query, or
• childSelector is the same as parentSelector.

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:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

descendantNodeJoinCondition

DescendantNodeJoinCondition descendantNodeJoinCondition(String descendantSelectorName,
 String ancestorSelectorName)
                                                 throws InvalidQueryException,
RepositoryException

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

The query is invalid if:

• descendantSelector is not the name of a selector in the query, or
• ancestorSelector is not the name of a selector in the query, or
• descendantSelector is the same as ancestorSelector.

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:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

and

And and(Constraint constraint1,
 Constraint constraint2)
 throws InvalidQueryException,
RepositoryException

Performs a logical conjunction of two other constraints.

Parameters:

constraint1 - the first constraint; non-null

constraint2 - the second constraint; non-null

Returns:

the And constraint; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

or

Or or(Constraint constraint1,
 Constraint constraint2)
throws InvalidQueryException,
RepositoryException

Performs a logical disjunction of two other constraints.

Parameters:

constraint1 - the first constraint; non-null

constraint2 - the second constraint; non-null

Returns:

the Or constraint; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

not

Not not(Constraint constraint)
 throws InvalidQueryException,
RepositoryException

Performs a logical negation of another constraint.

Parameters:

constraint - the constraint to be negated; non-null

Returns:

the Not constraint; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

comparison

Comparison comparison(DynamicOperand operand1,
 String operator,
 StaticOperand operand2)
               throws InvalidQueryException,
RepositoryException

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

Parameters:

operand1 - the first operand; non-null

operator - 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

operand2 - the second operand; non-null

Returns:

the constraint; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

propertyExistence

PropertyExistence propertyExistence(String selectorName,
 String propertyName)
                             throws InvalidQueryException,
RepositoryException

Tests the existence of a property in the specified selector.

The query is invalid if:

• selector is not the name of a selector in the query, or
• property is not a syntactically valid JCR name.

Parameters:

selectorName - the selector name; non-null

propertyName - the property name; non-null

Returns:

the constraint; non-null

Throws:

InvalidQueryException - if a particular validity test is possible on this method, the implemention chooses to perform that test (and not leave it until later, on createQuery(javax.jcr.query.qom.Source, javax.jcr.query.qom.Constraint, javax.jcr.query.qom.Ordering[], javax.jcr.query.qom.Column[])), and the parameters given fail that test

RepositoryException - if the operation otherwise fails

fullTextSearch

FullTextSearch fullTextSearch(String selectorName,
 String propertyName,
 StaticOperand fullTextSearchExpression)
                       throws InvalidQueryException,
RepositoryException

Performs a full-text search against the specified selector.

The query is invalid if:

• selector is not the name of a selector in the query, or
• property is specified but is not a syntactically valid JCR name, or
• fullTextSearchExpression does not evaluate to a JCR STRING Value (or convertible to STRING) that conforms to the full text search grammar.

If property is specified but, for a node-tuple, the selector node does not have a property named property, the query is valid but the constraint is not satisfied.