Package com.day.cq.search.eval

Class SimilarityPredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.SimilarityPredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class SimilarityPredicateEvaluator
extends AbstractPredicateEvaluator

Similarity search using JCR XPath's rep:similar().

Does not support filtering. Does not support facet extraction.

Name:

similar

Properties:

similar

absolute path to the node for which to find similar nodes

local

a relative path to a descendant node or . for the current node (optional, default is ".")

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LOCAL
static java.lang.String	SIMILAR

Constructor Summary

Constructors

Constructor	Description
SimilarityPredicateEvaluator()

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.
java.lang.String	getXPathExpression(Predicate p, EvaluationContext context)	Default implementation that always returns null, ie.

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

getFacetExtractor, getOrderByComparator, getOrderByProperties, includes, isFiltering

Methods inherited from class java.lang.Object

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

Field Detail

SIMILAR

public static final java.lang.String SIMILAR

See Also:

Constant Field Values

LOCAL

public static final java.lang.String LOCAL

See Also:

Constant Field Values

Constructor Detail

SimilarityPredicateEvaluator

public SimilarityPredicateEvaluator()

Method Detail

getXPathExpression

public java.lang.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

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

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

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