com.day.cq.search.eval
Class JcrPropertyPredicateEvaluator

java.lang.Object
  com.day.cq.search.eval.AbstractPredicateEvaluator
      com.day.cq.search.eval.JcrPropertyPredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class JcrPropertyPredicateEvaluator
extends AbstractPredicateEvaluator

JcrPropertyPredicateEvaluator is a generic evaluator for matching a jcr property against a value.

Properties:

property

relative path to property

value

value to check property for

operation

"equals" for exact match (default) or "like" for using the jcr:like xpath function (optional)

Since:

5.2

Field Summary

static String	OP_EQUALS
static String	OP_LIKE
static String	OPERATION
static String	PROPERTY
static String	VALUE

Constructor Summary

JcrPropertyPredicateEvaluator()

Method Summary

FacetExtractor	getFacetExtractor(Predicate p, EvaluationContext context) Default implementation that always returns null, ie.
String[]	getOrderByProperties(Predicate p, EvaluationContext context) Default implementation that always returns null.
String	getXPathExpression(Predicate p, EvaluationContext context) Default implementation that always returns null, ie.
protected String	getXPathExpression(String property, String value, String operation)

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

getOrderByComparator, includes, isFiltering

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY

public static final String PROPERTY

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

OPERATION

public static final String OPERATION

See Also:

Constant Field Values

OP_EQUALS

public static final String OP_EQUALS

See Also:

Constant Field Values

OP_LIKE

public static final String OP_LIKE

See Also:

Constant Field Values

Constructor Detail

JcrPropertyPredicateEvaluator

public JcrPropertyPredicateEvaluator()

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

getXPathExpression

protected String getXPathExpression(String property,
                                    String value,
                                    String operation)

getOrderByProperties

public String[] getOrderByProperties(Predicate p,
                                     EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns null.

Specified by:

getOrderByProperties in interface PredicateEvaluator

Overrides:

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

one or multiple relative paths to JCR properties or null

getFacetExtractor

public FacetExtractor getFacetExtractor(Predicate p,
                                        EvaluationContext context)

Description copied from class: AbstractPredicateEvaluator

Default implementation that always returns null, ie. no facets will be extracted for the predicate.

Specified by:

getFacetExtractor in interface PredicateEvaluator

Overrides:

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

a FacetExtractor that is used to create a Facet or null if no extractor shall be provided