为查询生成器实施自定义谓词计算器 implementing-a-custom-predicate-evaluator-for-the-query-builder
本节介绍如何通过实现自定义谓词求值器来扩展查询生成器。
概述 overview
查询生成器提供了一种查询内容存储库的简单方法。 CQ附带一组谓词评估器，可帮助您处理数据。
但是，您可能希望通过实施自定义谓词计算器来简化查询，该计算器可以隐藏一些复杂性并确保更好的语义。
自定义谓词还可以执行其他不能直接使用XPath执行的操作，例如：
- 从某个服务中查找一些数据
- 基于计算的自定义筛选
GITHUB上的代码
您可以在GitHub上找到此页面的代码。
- 在GitHub上打开aem-search-custom-predicate-evaluator项目
- 将项目下载为ZIP文件
谓词计算器详细信息 predicate-evaluator-in-detail
谓词计算器处理某些谓词的计算，这些谓词是查询的定义约束。
它将更高级别的搜索限制（例如“宽度> 200”）映射到适合实际内容模型的特定JCR查询(例如，元数据/@width > 200)。 或者，它可以手动筛选节点并检查其约束。
为复制元数据实施自定义谓词计算器 implementing-a-custom-predicate-evaluator-for-replication-metadata
作为示例，本节将介绍如何创建自定义谓词计算器，以帮助基于复制元数据的数据：
-
存储上次复制操作日期的
cq:lastReplicated -
cq:lastReplicatedBy存储触发上次复制操作的用户的ID -
存储上次复制操作（例如，激活、停用）的
cq:lastReplicationAction
使用默认谓词求值器查询复制元数据 querying-replication-metadata-with-default-predicate-evaluators
以下查询获取/content分支中自年初以来由admin激活的节点列表。
path=/content
1_property=cq:lastReplicatedBy
1_property.value=admin
2_property=cq:lastReplicationAction
2_property.value=Activate
daterange.property=cq:lastReplicated
daterange.lowerBound=2013-01-01T00:00:00.000+01:00
daterange.lowerOperation=>=
此查询有效但难以读取，并且不会突出显示三个复制属性之间的关系。 实施自定义谓词计算器可降低复杂性并改善此查询的语义。
目标 objectives
ReplicationPredicateEvaluator的目标是使用以下语法支持上述查询。
path=/content
replic.by=admin
replic.since=2013-01-01T00:00:00.000+01:00
replic.action=Activate
使用自定义谓词计算器将复制元数据谓词分组有助于创建有意义的查询。
更新Maven依赖项 updating-maven-dependencies
首先，更新项目的Maven依赖项。 PredicateEvaluator是cq-search工件的一部分，因此必须将其添加到Maven pom.xml文件中。
cq-search依赖项的范围设置为provided，因为cq-search由OSGi容器提供。pom.xml
以下代码片段显示了统一差异格式中的差异
@@ -120,6 +120,12 @@
<scope>provided</scope>
<dependency>
+ <groupid>com.day.cq</groupid>
+ <artifactid>cq-search</artifactid>
+ <version>5.6.4</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
<groupid>junit</groupid>
<artifactid>junit</artifactid>
<version>3.8.1</version></dependency>
aem-search-custom-predicate-evaluator - pom.xml
编写ReplicationPredicateEvaluator writing-the-replicationpredicateevaluator
cq-search项目包含AbstractPredicateEvaluator抽象类。 这可以通过几个步骤进行扩展，以实施您自己的自定义谓词计算器(PredicateEvaluator)。
-
创建扩展
com.day.cq.search.eval.AbstractPredicateEvaluator的Java™类 -
使用
@Component批注您的类，如下所示src/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java
以下代码片段显示了统一差异格式中的差异
@@ -19,8 +19,11 @@
*/
package com.adobe.aem.docs.search;
+import org.apache.felix.scr.annotations.Component;
+
import com.day.cq.search.eval.AbstractPredicateEvaluator;
+@Component(metatype = false, factory = "com.day.cq.search.eval.PredicateEvaluator/repli")
public class ReplicationPredicateEvaluator extends AbstractPredicateEvaluator {
}
aem-search-custom-predicate-evaluator - src/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java
factory必须为以com.day.cq.search.eval.PredicateEvaluator/开头并以自定义PredicateEvaluator的名称结尾的唯一字符串。PredicateEvaluator的名称是构建查询时使用的谓词名称。-
覆盖：
code language-java public String getXPathExpression(Predicate predicate, EvaluationContext context)在覆盖方法中，您基于参数中给定的
Predicate构建一个Xpath表达式。
复制元数据的自定义谓词计算器示例 example-of-a-custom-predicate-evalutor-for-replication-metadata
此PredicateEvaluator的完整实现可能类似于以下类。
src/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java
/*
* #%L
* aem-docs-custom-predicate-evaluator
* %%
* Copyright (C) 2013 Adobe Research
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package com.adobe.aem.docs.search;
import org.apache.felix.scr.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.day.cq.search.Predicate;
import com.day.cq.search.eval.AbstractPredicateEvaluator;
import com.day.cq.search.eval.EvaluationContext;
@Component(metatype = false, factory = "com.day.cq.search.eval.PredicateEvaluator/repli")
public class ReplicationPredicateEvaluator extends AbstractPredicateEvaluator {
static final String PE_NAME = "replic";
static final String PN_LAST_REPLICATED_BY = "cq:lastReplicatedBy";
static final String PN_LAST_REPLICATED = "cq:lastReplicated";
static final String PN_LAST_REPLICATED_ACTION = "cq:lastReplicationAction";
static final String PREDICATE_BY = "by";
static final String PREDICATE_SINCE = "since";
static final String PREDICATE_SINCE_OP = " >= ";
static final String PREDICATE_ACTION = "action";
Logger log = LoggerFactory.getLogger(getClass());
/**
* Returns a XPath expression filtering by replication metadata.
*
* @see com.day.cq.search.eval.AbstractPredicateEvaluator#getXPathExpression(com.day.cq.search.Predicate,
* com.day.cq.search.eval.EvaluationContext)
*/
@Override
public String getXPathExpression(Predicate predicate,
EvaluationContext context) {
log.debug("predicate {}", predicate);
String date = predicate.get(PREDICATE_SINCE);
String user = predicate.get(PREDICATE_BY);
String action = predicate.get(PREDICATE_ACTION);
StringBuilder sb = new StringBuilder();
if (date != null) {
sb.append(PN_LAST_REPLICATED).append(PREDICATE_SINCE_OP);
sb.append("xs:dateTime('").append(date).append("')");
}
if (user != null) {
addAndOperator(sb);
sb.append(PN_LAST_REPLICATED_BY);
sb.append("='").append(user).append("'");
}
if (action != null) {
addAndOperator(sb);
sb.append(PN_LAST_REPLICATED_ACTION);
sb.append("='").append(action).append("'");
}
String xpath = sb.toString();
log.debug("xpath **{}**", xpath);
return xpath;
}
/**
* Add an and operator if the builder is not empty.
*
* @param sb a {@link StringBuilder} containing the query under construction
*/
private void addAndOperator(StringBuilder sb) {
if (sb.length() != 0) {
sb.append(" and ");
}
}
}
aem-search-custom-predicate-evaluator - src/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java