Package com.day.cq.search.eval

Class FulltextPredicateEvaluator

java.lang.Object

com.day.cq.search.eval.AbstractPredicateEvaluator

com.day.cq.search.eval.FulltextPredicateEvaluator

All Implemented Interfaces:

PredicateEvaluator

public class FulltextPredicateEvaluator
extends AbstractPredicateEvaluator

Searches for terms in the fulltext index.

Does not support filtering. Does not support facet extraction.

Name:

fulltext

Properties:

fulltext

the fulltext search term(s)

relPath

the relative path to search in (property or subnode) (optional)

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULLTEXT
static final String	REL_PATH

Constructor Summary

Constructors

Constructor	Description
FulltextPredicateEvaluator()

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 predicate, EvaluationContext context)	Returns the inverted boolean value of the deprecated AbstractPredicateEvaluator.isFiltering(Predicate, EvaluationContext) method (ie.
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 Details

FULLTEXT

public static final String FULLTEXT

See Also:

• Constant Field Values

REL_PATH

public static final String REL_PATH

See Also:

• Constant Field Values

Constructor Details

FulltextPredicateEvaluator

public FulltextPredicateEvaluator()

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

canXpath

public boolean canXpath(Predicate predicate,
 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:

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