为查询生成器实施自定义谓词计算器

本节介绍如何通过实现自定义谓词计算器来扩展查询生成器

概述

查询生成器优惠了一种查询内容存储库的简单方法。 CQ附带一组谓词计算器,可帮助您处理数据。

但是,您可能希望通过实现隐藏某些复杂性并确保更好的语义的自定义谓词计算器来简化查询。

自定义谓词还可以执行XPath不能直接执行的其他操作,例如:

  • 从一些服务中查找一些数据
  • 基于计算的自定义过滤
注意

实施自定义谓词时必须考虑性能问题。

注意

您可以在查询生成器部分找到查询示例。

GITHUB上的代码

您可以在GitHub上找到此页面的代码

详细信息中的谓词计算器

谓词计算器处理特定谓词的计算,这些谓词是查询的定义约束。

它将更高级别的搜索约束(如“宽度> 200”)映射到符合实际内容模型的特定JCR查询(如元数据/@width > 200)。 或者,也可以手动过滤节点并检查其约束。

注意

有关PredicateEvaluatorcom.day.cq.search包的详细信息,请参阅Java文档

为复制元数据实施自定义谓词计算器

作为示例,本节介绍如何创建自定义谓词计算器,以帮助基于复制元数据的数据:

  • cq:lastReplicated 存储上次复制操作的日期

  • cq:lastReplicatedBy 存储触发上次复制操作的用户的id

  • cq:lastReplicationAction 存储上次复制操作(例如激活、取消激活)

使用默认谓词计算器查询复制元数据

以下查询获取自年初起由admin激活的/content分支中节点的列表。

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

此查询有效,但难以读取,并且不会突出显示三个复制属性之间的关系。 实现自定义谓词计算器将降低该查询的复杂性和语义。

目标

ReplicationPredicateEvaluator的目标是使用以下语法支持上述查询。

path=/content

replic.by=admin
replic.since=2013-01-01T00:00:00.000+01:00
replic.action=Activate

使用自定义谓词计算器将复制元数据谓词分组有助于创建有意义的查询。

更新Maven依赖项

注意

如何使用Apache Maven构建AEM项目,介绍使用maven的新AEM项目的设置。

首先,您需要更新项目的Maven依赖关系。 PredicateEvaluatorcq-search项目的一部分,因此需要将其添加到您的Maven pom文件。

注意

由于OSGi容器将提供cq-search,因此cq-search依赖关系的范围设置为provided

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

cq-search项目包含AbstractPredicateEvaluator抽象类。 只需几步即可扩展该功能,以实现您自己的自定义谓词计算器(PredicateEvaluator

注意

以下过程说明如何构建Xpath表达式来筛选数据。 另一个选项是实施includes方法,该方法以行为基础选择数据。 有关详细信息,请参阅Java文档

  1. 新建一个扩展com.day.cq.search.eval.AbstractPredicateEvaluator的Java类

  2. 使用@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的名称是谓词名称,在构建查询时使用它。

  1. 覆盖:

    public String getXPathExpression(Predicate predicate, EvaluationContext context)
    

    在覆盖方法中,您根据参数中给定的Predicate构建一个Xpath表达式。

复制元数据的自定义谓词计算器示例

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
 *
 *      http://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

On this page

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now