Package com.day.cq.search.eval

Class SavedQueryPredicate

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.PredicateGroupEvaluator

com.day.cq.search.eval.SavedQueryPredicate

All Implemented Interfaces:

PredicateEvaluator

public class SavedQueryPredicate
extends PredicateGroupEvaluator

Includes all predicates of a persisted querybuilder query into the current query as a sub PredicateGroupEvaluator. Note that this will not execute an extra query but extend the current query.

Queries can be persisted programmatically using QueryBuilder#storeQuery(). The format can be either a multi-line String property or a nt:file node that contains the query as a text file in Java properties format.

Does not support facet extraction for the predicates of the saved query.

Name:

savedquery

Parameters:

savedquery

path to the saved query (String property or nt:file node)

Since:

5.3

Field Summary

Fields

Modifier and Type	Field	Description
QueryBuilder	queryBuilder
static String	SAVED_QUERY

Constructor Summary

Constructors

Constructor	Description
SavedQueryPredicate()

Method Summary

Modifier and Type	Method	Description
boolean	canFilter(Predicate p, EvaluationContext context)	Returns the same as the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
boolean	canXpath(Predicate p, EvaluationContext context)	Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
String	getXPathExpression(Predicate p, EvaluationContext context)	Default implementation that always returns null, ie.
boolean	includes(Predicate p, Row row, EvaluationContext context)	Default implementation that always returns true, ie.

Methods inherited from class com.day.cq.search.eval.PredicateGroupEvaluator

getFacetExtractor, listFilteringPredicates

Methods inherited from class com.day.cq.search.eval.AbstractPredicateEvaluator

getOrderByComparator, getOrderByProperties, isFiltering

Methods inherited from class java.lang.Object

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

Field Detail

SAVED_QUERY

public static final String SAVED_QUERY

See Also:

Constant Field Values

queryBuilder

@Reference
public QueryBuilder queryBuilder

Constructor Detail

SavedQueryPredicate

public SavedQueryPredicate()

Method Detail

getXPathExpression

public String getXPathExpression(Predicate p,
                                 EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns null, ie. adds nothing to the XPath query. Subclasses can choose whether they want to implement this method or use the AbstractPredicateEvaluator.includes(Predicate, Row, EvaluationContext) method for advanced filtering (or both).

Specified by:

getXPathExpression in interface PredicateEvaluator

Overrides:

getXPathExpression in class PredicateGroupEvaluator

Parameters:

p - predicate (for this evaluator type) which is evaluated

context - helper class which provides access to various elements of the query evaluation

Returns:

string containing an XPath predicateEvaluator expression

includes

public boolean includes(Predicate p,
                        Row row,
                        EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns true, ie. it does not "touch" the result set at all.

Specified by:

includes in interface PredicateEvaluator

Overrides:

includes in class PredicateGroupEvaluator

Parameters:

p - predicate (for this evaluator type) which is evaluated

row - current row of the result set returned through the xpath query

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this row should be part of the final result set, false if it should be dropped

canXpath

public boolean canXpath(Predicate p,
                        EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie. if not overridden, true).

Specified by:

canXpath in interface PredicateEvaluator

Overrides:

canXpath in class PredicateGroupEvaluator

Parameters:

p - predicate (for this evaluator type) which is evaluated

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this evaluator can express itself via xpath, ie. PredicateEvaluator.getXPathExpression(Predicate, EvaluationContext)

canFilter

public boolean canFilter(Predicate p,
                         EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Returns the same as the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie. if not overridden, false).

Specified by:

canFilter in interface PredicateEvaluator

Overrides:

canFilter in class PredicateGroupEvaluator

Parameters:

p - predicate (for this evaluator type) which is evaluated

context - helper class which provides access to various elements of the query evaluation

Returns:

true if this evaluator can be express itself via filtering, ie. PredicateEvaluator.includes(Predicate, Row, EvaluationContext)