|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryObjectModelFactory
A QueryObjectModelFactory
creates instances of the JCR query
object model.
QueryObjectModel
for a description of the query object
model.
Field Summary |
---|
Fields inherited from interface org.apache.jackrabbit.spi.commons.query.jsr283.qom.QueryObjectModelConstants |
---|
JOIN_TYPE_INNER, JOIN_TYPE_LEFT_OUTER, JOIN_TYPE_RIGHT_OUTER, OPERATOR_EQUAL_TO, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL_TO, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL_TO, OPERATOR_LIKE, OPERATOR_NOT_EQUAL_TO, ORDER_ASCENDING, ORDER_DESCENDING |
Method Summary | |
---|---|
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 path)
Tests whether a node in the default selector is a child of a node reachable by a specified absolute path. |
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 propertyName)
Identifies a property in the default selector to include in the tabular view of query results. |
Column |
column(String propertyName,
String columnName)
Identifies a property in the default selector to include in the tabular view of query results. |
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,
int operator,
StaticOperand operand2)
Filters node-tuples based on the outcome of a binary operation. |
QueryObjectModel |
createQuery(Selector selector,
Constraint constraint,
Ordering[] orderings,
Column[] columns)
Creates a query with one selector. |
QueryObjectModel |
createQuery(Source source,
Constraint constraint,
Ordering[] orderings,
Column[] columns)
Creates a query with one or more selectors. |
DescendantNode |
descendantNode(String path)
Tests whether a node in the default selector is a descendant of a node reachable by a specified absolute path. |
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 propertyName,
String fullTextSearchExpression)
Performs a full-text search against the default selector. |
FullTextSearch |
fullTextSearch(String selectorName,
String propertyName,
String fullTextSearchExpression)
Performs a full-text search against the specified selector. |
FullTextSearchScore |
fullTextSearchScore()
Evaluates to a DOUBLE value equal to the full-text search
score of a node in the default 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,
int 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 value)
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()
Evaluates to a NAME value equal to the local (unprefixed)
name of a node in the default selector. |
NodeLocalName |
nodeLocalName(String selectorName)
Evaluates to a NAME value equal to the local (unprefixed)
name of a node in the specified selector. |
NodeName |
nodeName()
Evaluates to a NAME value equal to the prefix-qualified name
of a node in the default 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 propertyName)
Tests the existence of a property in the default selector. |
PropertyExistence |
propertyExistence(String selectorName,
String propertyName)
Tests the existence of a property in the specified selector. |
PropertyValue |
propertyValue(String propertyName)
Evaluates to the value (or values, if multi-valued) of a property of the default 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 path)
Tests whether a node in the default selector is reachable by a specified absolute path. |
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)
Tests whether a first selector's node is the same as a second selector's node. |
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)
Selects a subset of the nodes in the repository based on node type. |
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 Detail |
---|
QueryObjectModel createQuery(Selector selector, Constraint constraint, Ordering[] orderings, Column[] columns) throws InvalidQueryException, RepositoryException
selector
- the selector; non-nullconstraint
- the constraint, or null if noneorderings
- zero or more orderings; null is equivalent to a
zero-length arraycolumns
- the columns; null is equivalent to a zero-length
array
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsQueryObjectModel createQuery(Source source, Constraint constraint, Ordering[] orderings, Column[] columns) throws InvalidQueryException, RepositoryException
source
is a selector, that selector is the default
selector of the query. Otherwise the query does not have a default
selector.
source
- the node-tuple source; non-nullconstraint
- the constraint, or null if noneorderings
- zero or more orderings; null is equivalent to a
zero-length arraycolumns
- the columns; null is equivalent to a zero-length
array
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsSelector selector(String nodeTypeName) throws InvalidQueryException, RepositoryException
nodeTypeName
- the name of the required node type; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsSelector selector(String nodeTypeName, String selectorName) throws InvalidQueryException, RepositoryException
nodeTypeName
- the name of the required node type; non-nullselectorName
- the selector name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsJoin join(Source left, Source right, int joinType, JoinCondition joinCondition) throws InvalidQueryException, RepositoryException
left
- the left node-tuple source; non-nullright
- the right node-tuple source; non-nulljoinType
- either
QueryObjectModelConstants.JOIN_TYPE_INNER
,QueryObjectModelConstants.JOIN_TYPE_LEFT_OUTER
,QueryObjectModelConstants.JOIN_TYPE_RIGHT_OUTER
joinCondition
- the join condition; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsEquiJoinCondition equiJoinCondition(String selector1Name, String property1Name, String selector2Name, String property2Name) throws InvalidQueryException, RepositoryException
selector1Name
- the name of the first selector; non-nullproperty1Name
- the property name in the first selector; non-nullselector2Name
- the name of the second selector; non-nullproperty2Name
- the property name in the second selector; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsSameNodeJoinCondition sameNodeJoinCondition(String selector1Name, String selector2Name) throws InvalidQueryException, RepositoryException
selector1Name
- the name of the first selector; non-nullselector2Name
- the name of the second selector; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsSameNodeJoinCondition sameNodeJoinCondition(String selector1Name, String selector2Name, String selector2Path) throws InvalidQueryException, RepositoryException
selector1Name
- the name of the first selector; non-nullselector2Name
- the name of the second selector; non-nullselector2Path
- the path relative to the second selector; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsChildNodeJoinCondition childNodeJoinCondition(String childSelectorName, String parentSelectorName) throws InvalidQueryException, RepositoryException
childSelectorName
- the name of the child selector; non-nullparentSelectorName
- the name of the parent selector; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsDescendantNodeJoinCondition descendantNodeJoinCondition(String descendantSelectorName, String ancestorSelectorName) throws InvalidQueryException, RepositoryException
descendantSelectorName
- the name of the descendant selector; non-nullancestorSelectorName
- the name of the ancestor selector; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsAnd and(Constraint constraint1, Constraint constraint2) throws InvalidQueryException, RepositoryException
constraint1
- the first constraint; non-nullconstraint2
- the second constraint; non-null
And
constraint; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsOr or(Constraint constraint1, Constraint constraint2) throws InvalidQueryException, RepositoryException
constraint1
- the first constraint; non-nullconstraint2
- the second constraint; non-null
Or
constraint; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsNot not(Constraint constraint) throws InvalidQueryException, RepositoryException
constraint
- the constraint to be negated; non-null
Not
constraint; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsComparison comparison(DynamicOperand operand1, int operator, StaticOperand operand2) throws InvalidQueryException, RepositoryException
operand1
- the first operand; non-nulloperator
- the operator; either
QueryObjectModelConstants.OPERATOR_EQUAL_TO
,QueryObjectModelConstants.OPERATOR_NOT_EQUAL_TO
,QueryObjectModelConstants.OPERATOR_LESS_THAN
,QueryObjectModelConstants.OPERATOR_LESS_THAN_OR_EQUAL_TO
,QueryObjectModelConstants.OPERATOR_GREATER_THAN
,QueryObjectModelConstants.OPERATOR_GREATER_THAN_OR_EQUAL_TO
, orQueryObjectModelConstants.OPERATOR_LIKE
operand2
- the second operand; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsPropertyExistence propertyExistence(String propertyName) throws InvalidQueryException, RepositoryException
propertyName
- the property name; non-null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsPropertyExistence propertyExistence(String selectorName, String propertyName) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpropertyName
- the property name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsFullTextSearch fullTextSearch(String propertyName, String fullTextSearchExpression) throws InvalidQueryException, RepositoryException
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
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsFullTextSearch fullTextSearch(String selectorName, String propertyName, String fullTextSearchExpression) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpropertyName
- 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
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsSameNode sameNode(String path) throws InvalidQueryException, RepositoryException
path
- an absolute path; non-null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsSameNode sameNode(String selectorName, String path) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpath
- an absolute path; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsChildNode childNode(String path) throws InvalidQueryException, RepositoryException
path
- an absolute path; non-null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsChildNode childNode(String selectorName, String path) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpath
- an absolute path; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsDescendantNode descendantNode(String path) throws InvalidQueryException, RepositoryException
path
- an absolute path; non-null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsDescendantNode descendantNode(String selectorName, String path) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpath
- an absolute path; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsPropertyValue propertyValue(String propertyName) throws InvalidQueryException, RepositoryException
propertyName
- the property name; non-null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsPropertyValue propertyValue(String selectorName, String propertyName) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpropertyName
- the property name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsLength length(PropertyValue propertyValue) throws InvalidQueryException, RepositoryException
propertyValue
- the property value for which to compute the length;
non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsNodeName nodeName() throws InvalidQueryException, RepositoryException
NAME
value equal to the prefix-qualified name
of a node in the default selector.
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsNodeName nodeName(String selectorName) throws InvalidQueryException, RepositoryException
NAME
value equal to the prefix-qualified name
of a node in the specified selector.
selectorName
- the selector name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsNodeLocalName nodeLocalName() throws InvalidQueryException, RepositoryException
NAME
value equal to the local (unprefixed)
name of a node in the default selector.
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsNodeLocalName nodeLocalName(String selectorName) throws InvalidQueryException, RepositoryException
NAME
value equal to the local (unprefixed)
name of a node in the specified selector.
selectorName
- the selector name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsFullTextSearchScore fullTextSearchScore() throws InvalidQueryException, RepositoryException
DOUBLE
value equal to the full-text search
score of a node in the default selector.
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsFullTextSearchScore fullTextSearchScore(String selectorName) throws InvalidQueryException, RepositoryException
DOUBLE
value equal to the full-text search
score of a node in the specified selector.
selectorName
- the selector name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsLowerCase lowerCase(DynamicOperand operand) throws InvalidQueryException, RepositoryException
operand
- the operand whose value is converted to a
lower-case string; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsUpperCase upperCase(DynamicOperand operand) throws InvalidQueryException, RepositoryException
operand
- the operand whose value is converted to a
upper-case string; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsBindVariableValue bindVariable(String bindVariableName) throws InvalidQueryException, RepositoryException
bindVariableName
- the bind variable name; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsLiteral literal(Value value) throws InvalidQueryException, RepositoryException
value
- a JCR value; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsOrdering ascending(DynamicOperand operand) throws InvalidQueryException, RepositoryException
operand
- the operand by which to order; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsOrdering descending(DynamicOperand operand) throws InvalidQueryException, RepositoryException
operand
- the operand by which to order; non-null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise failsColumn column(String propertyName) throws InvalidQueryException, RepositoryException
propertyName
- the property name, or null to include a column
for each single-value non-residual property of
the selector's node type
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsColumn column(String propertyName, String columnName) throws InvalidQueryException, RepositoryException
propertyName
- the property name, or null to include a column
for each single-value non-residual property of
the selector's node typecolumnName
- the column name; must be null if
propertyName
is null
InvalidQueryException
- if the query has no default selector
or is otherwise invalid
RepositoryException
- if the operation otherwise failsColumn column(String selectorName, String propertyName, String columnName) throws InvalidQueryException, RepositoryException
selectorName
- the selector name; non-nullpropertyName
- the property name, or null to include a column
for each single-value non-residual property of
the selector's node typecolumnName
- the column name; if null, defaults to
propertyName
; must be null if
propertyName
is null
InvalidQueryException
- if the query is invalid
RepositoryException
- if the operation otherwise fails
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |