org.jahia.services.query

Class QOMBuilder

java.lang.Object

org.jahia.services.query.QOMBuilder

public class QOMBuilder
extends Object

Utility class to help building a query object mode in several steps. It is mainly used by the query tag library to build the QOM with our tags.

Author:

Benjamin Papez

Constructor Summary

Constructors

Constructor and Description
QOMBuilder(javax.jcr.query.qom.QueryObjectModelFactory qomFactory, javax.jcr.ValueFactory valueFactory)

Method Summary

Modifier and Type	Method and Description
void	andConstraint(javax.jcr.query.qom.Constraint c) Add a constraint.
javax.jcr.query.qom.QueryObjectModel	createQOM() Creates the QueryObjectModel object from for currently provided data.
List<javax.jcr.query.qom.Column>	getColumns() Gets the columns for this query.
javax.jcr.query.qom.Constraint	getConstraint() Gets the constraint for this query.
List<javax.jcr.query.qom.Ordering>	getOrderings() Gets the orderings for this query.
javax.jcr.query.qom.QueryObjectModelFactory	getQOMFactory() Returns a QueryObjectModelFactory with which a JCR-JQOM query can be built programmatically.
javax.jcr.query.qom.Source	getSource() Returns the node-tuple source for this query.
javax.jcr.ValueFactory	getValueFactory() This method returns a ValueFactory that is used to create Value objects for use when setting repository properties.
void	orConstraint(javax.jcr.query.qom.Constraint c) Adds a constraint.
void	setSource(javax.jcr.query.qom.Source s) Sets the node-tuple source for this query.

Methods inherited from class java.lang.Object

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

Constructor Detail

QOMBuilder

public QOMBuilder(javax.jcr.query.qom.QueryObjectModelFactory qomFactory,
                  javax.jcr.ValueFactory valueFactory)

Method Detail

andConstraint

public void andConstraint(javax.jcr.query.qom.Constraint c)
                   throws javax.jcr.query.InvalidQueryException,
                          javax.jcr.RepositoryException

Add a constraint. If it is the first constraint it becomes the root constraint, otherwise it is added with a logical conjunction (AND).

Parameters:

c - a constraint to add

Throws:

javax.jcr.query.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, and the parameters given fail that test

javax.jcr.RepositoryException - if the operation otherwise fails

createQOM

public javax.jcr.query.qom.QueryObjectModel createQOM()
                                               throws javax.jcr.query.InvalidQueryException,
                                                      javax.jcr.RepositoryException

Creates the QueryObjectModel object from for currently provided data.

Returns:

the created query object model (including modifications and optimizations)

Throws:

javax.jcr.query.InvalidQueryException - if a particular validity test is possible on this method, the implementation chooses to perform that test and the parameters given fail that test.

javax.jcr.RepositoryException - if the operation otherwise fails

getColumns

public List<javax.jcr.query.qom.Column> getColumns()

Gets the columns for this query.

Returns:

a list of defined Column objects array of zero or more columns; non-null

getConstraint

public javax.jcr.query.qom.Constraint getConstraint()

Gets the constraint for this query.

Returns:

the constraint, or null if none

getOrderings

public List<javax.jcr.query.qom.Ordering> getOrderings()

Gets the orderings for this query.

Returns:

a list of defined Ordering objects or an empty list if non were defined yet

getQOMFactory

public javax.jcr.query.qom.QueryObjectModelFactory getQOMFactory()

Returns a QueryObjectModelFactory with which a JCR-JQOM query can be built programmatically.

Returns:

a QueryObjectModelFactory object

getSource

public javax.jcr.query.qom.Source getSource()

Returns the node-tuple source for this query.

Returns:

the node-tuple source for this query

getValueFactory

public javax.jcr.ValueFactory getValueFactory()

This method returns a ValueFactory that is used to create Value objects for use when setting repository properties.

Returns:

a ValueFactory

Throws:

javax.jcr.RepositoryException - if an error occurs

orConstraint

public void orConstraint(javax.jcr.query.qom.Constraint c)
                  throws javax.jcr.query.InvalidQueryException,
                         javax.jcr.RepositoryException

Adds a constraint. If it is the first constraint it becomes the root constraint, otherwise it is added with a logical disjunction (OR).

Parameters:

c - a constraint to add

Throws:

javax.jcr.query.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, and the parameters given fail that test

javax.jcr.RepositoryException - if the operation otherwise fails

setSource

public void setSource(javax.jcr.query.qom.Source s)

Sets the node-tuple source for this query.

Parameters:

s - the node-tuple source for this query