Package com.day.cq.search.eval

Class NodenamePredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.NodenamePredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class NodenamePredicateEvaluator
extends AbstractPredicateEvaluator

Matches on JCR node names.

Supports facet extraction. Will provide buckets for each unique node name (filename).

Name:

nodename

Properties:

nodename

node name pattern that allows wildcards: * = any or no char, ? = any char, [abc] = only chars in brackets

case

option to enable case insensitivityignore = case will be ignored

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CASE
static final String	CASE_IGNORE
static final String	NODENAME

Constructor Summary

Constructors

Constructor	Description
NodenamePredicateEvaluator()

Method Summary

Modifier and Type	Method	Description
boolean	canFilter(Predicate predicate, 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 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

getOrderByComparator, isFiltering

Methods inherited from class java.lang.Object

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

Field Details

NODENAME

public static final String NODENAME

See Also:

• Constant Field Values

CASE

public static final String CASE

See Also:

• Constant Field Values

CASE_IGNORE

public static final String CASE_IGNORE

See Also:

• Constant Field Values

Constructor Details

NodenamePredicateEvaluator

public NodenamePredicateEvaluator()

Method Details

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

getOrderByProperties

public String[] getOrderByProperties(Predicate predicate,
 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:

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

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

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

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