com.day.cq.search.eval

Class TypePredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.TypePredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class TypePredicateEvaluator
extends AbstractPredicateEvaluator

TypePredicateEvaluator looks for the node type, ie. either primary node type or mixin type. If there is only one type predicate in the query (in a root group which requires all predicates), the XPath element(*, type) function will be used (optimization of the query builder evaluator implementation). Otherwise this will - just as the element() function - search for that node type and all its descendant types to find all nodes for which Node#isNodeType(String) would return true for the given node type name.

Name:

type

Properties:

type

node type or mixin name to check for

Since:

5.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
TypePredicateEvaluator()

Method Summary

Methods

Modifier and Type	Method and 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.
FacetExtractor	getFacetExtractor(Predicate predicate, EvaluationContext context) Default implementation that always returns null, ie.
String[]	getOrderByProperties(Predicate p, EvaluationContext context) Default implementation that always returns null.
static String	getType(Predicate p, EvaluationContext context) Returns and validates the type from the predicate.
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

getOrderByComparator, isFiltering

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

TypePredicateEvaluator

public TypePredicateEvaluator()

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

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

getType

public static String getType(Predicate p,
             EvaluationContext context)

Returns and validates the type from the predicate. If it is not an existing node type, it will return null.

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)

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

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