com.day.cq.search.eval

Class PathPredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.PathPredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class PathPredicateEvaluator
extends AbstractPredicateEvaluator

PathPredicateEvaluator restricts the result to a node path.

Name:

path

Properties:

path

path pattern; depending on exact, either the entire subtree will match (like appending //* in xpath, but note that this does not include the base path) (exact=false, default) or only an exact path matches, which can include wildcards (*); if self is set, the entire subtree including the base node will be searched

exact

if exact is true/on, the exact path must match, but it can contain simple wildcards (*), that match names, but not "/"; if it is false (default) all descendents are included (optional)

flat

searches only the direct children (like appending "/*" in xpath) (only used if 'exact' is not true, optional)

self

searches the subtree but includes the base node given as path (no wildcards)

Since:

5.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXACT
static String	FLAT
static String	PATH
static String	SELF

Constructor Summary

Constructors

Constructor and Description
PathPredicateEvaluator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canFilter(Predicate predicate, EvaluationContext context) Returns the same as the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
boolean	canXpath(Predicate predicate, EvaluationContext context) Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
static String	encodePath(Predicate p) Encodes absolute paths, but keeps wildcards in case this is an "exact" query containing wildcards.
Comparator<Row>	getOrderByComparator(Predicate predicate, EvaluationContext context) Default implementation that always returns null.
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.AbstractPredicateEvaluator

getFacetExtractor, getOrderByProperties, isFiltering

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

EXACT

public static final String EXACT

See Also:

Constant Field Values

FLAT

public static final String FLAT

See Also:

Constant Field Values

SELF

public static final String SELF

See Also:

Constant Field Values

Constructor Detail

PathPredicateEvaluator

public PathPredicateEvaluator()

Method Detail

encodePath

public static String encodePath(Predicate p)

Encodes absolute paths, but keeps wildcards in case this is an "exact" query containing wildcards.

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 AbstractPredicateEvaluator

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 AbstractPredicateEvaluator

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

getOrderByComparator

public Comparator<Row> getOrderByComparator(Predicate predicate,
                                   EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns null.

Specified by:

getOrderByComparator in interface PredicateEvaluator

Overrides:

getOrderByComparator in class AbstractPredicateEvaluator

Parameters:

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

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

Returns:

a custom comparator for the given predicate or null

canXpath

public boolean canXpath(Predicate predicate,
               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 AbstractPredicateEvaluator

Parameters:

predicate - 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 predicate,
                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 AbstractPredicateEvaluator

Parameters:

predicate - 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)