为查询生成器实施自定义谓词计算器 implementing-a-custom-predicate-evaluator-for-the-query-builder

本文档介绍如何扩展 查询生成器 通过实施自定义谓词计算器。

概述 overview

查询生成器 提供了一种查询内容存储库的简单方法。 AEM附带 一组谓词评估器 可以帮助您查询数据。

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

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

  • 正在从其他服务查询数据
  • 基于计算的自定义筛选
NOTE
实施自定义谓词时必须考虑性能问题。
TIP
您可以在以下位置找到查询示例: 查询生成器 文档。
TIP
您可以在GitHub上找到此页面的代码
NOTE
GitHub上的此链接代码以及本文档中的代码片段仅供演示之用。

谓词计算器详细信息 predicate-evaluator-in-detail

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

它映射更高级别的搜索约束(例如 width>200)到适合实际内容模型的特定JCR查询(例如, metadata/@width > 200)。 或者,它可以手动筛选节点并检查其约束。

TIP
欲知关于 PredicateEvaluatorcom.day.cq.search 包请参阅 Java文档.

为复制元数据实施自定义谓词计算器 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

TIP
对新AEM项目的设置(包括使用maven)进行了详细解释,请参见 WKND教程。

首先,您需要更新项目的Maven依赖项。 此 PredicateEvaluatorcq-search 构件,因此必须将其添加到Maven pom文件中。

NOTE
范围 cq-search 依赖关系设置为 provided 因为 cq-searchOSGi 容器。

以下代码片段显示了两者在 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>

编写ReplicationPredicateEvaluator writing-the-replicationpredicateevaluator

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

NOTE
以下过程说明如何构建 Xpath 用于筛选数据的表达式。 另一种选择是实施 includes 逐行选择数据的方法。 请参阅 Java文档 以了解更多信息。
  1. 创建一个新的Java类,该类将扩展 com.day.cq.search.eval.AbstractPredicateEvaluator

  2. 使用为类添加批注 @Component 如中的代码片段所示 统一差异格式

    code language-text
    @@ -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 {
    
     }
    
    note note
    NOTE
    factory必须为以开头的唯一字符串 com.day.cq.search.eval.PredicateEvaluator/并以您的自定义名称结尾 PredicateEvaluator.
    note note
    NOTE
    的名称 PredicateEvaluator 是构建查询时使用的谓词名称。
  3. 覆盖:

    code language-java
    public String getXPathExpression(Predicate predicate, EvaluationContext context)
    

    在覆盖方法中,您构建 Xpath 表达式基于 Predicate 在论证中给出。

复制元数据的自定义谓词计算器示例 example-of-a-custom-predicate-evaluator-for-replication-metadata

此的完整实施 PredicateEvaluator 可能与以下类类似。

/*
 * #%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 ");

        }

    }

}
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab