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

SimilarityPredicateEvaluator does a similarity search using rep: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

static String	LOCAL
static String	SIMILAR

Constructor Summary

SimilarityPredicateEvaluator()

Method Summary

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

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

Field Detail

SIMILAR

public static final String SIMILAR

See Also:

Constant Field Values

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

Constructor Detail

SimilarityPredicateEvaluator

public SimilarityPredicateEvaluator()

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