為查詢生成器實現自定義謂詞計算器

本文檔介紹如何擴展 查詢生成器 實現自定義謂詞計算器。

概覽

查詢生成器 提供了查詢內容儲存庫的簡單方法。 AEM 一組謂語計算器 幫助你查詢資料。

但是,您可能希望通過實施自定義謂詞計算器來簡化查詢,該計算器隱藏了一些複雜性,並確保了更好的語義。

自定義謂語還可以執行XPath不直接可能執行的其他操作,例如:

  • 從其他服務查詢資料
  • 基於計算的自定義過濾
注意

實施自定義謂詞時必須考慮效能問題。

秘訣

您可以在 查詢生成器 的子菜單。

秘訣

可以在GitHub上找到此頁的代碼

注意

GitHub上的此連結代碼和本文檔中的代碼片段僅供演示之用。

詳細謂語計算器

謂詞計算器處理某些謂詞的計算,這些謂詞是查詢的定義約束。

它映射更高級別的搜索約束(例如 width>200)到符合實際內容模型的特定JCR查詢(例如 metadata/@width > 200)。 或者可以手動過濾節點並檢查其約束。

秘訣

有關 PredicateEvaluatorcom.day.cq.search 包請參閱 Java文檔

實現複製元資料的自定義謂詞計算器

作為示例,本節介紹如何建立自定義謂詞計算器,以基於複製元資料幫助資料:

  • cq:lastReplicated 儲存上次複製操作的日期
  • cq:lastReplicatedBy 儲存觸發上次複製操作的用戶的ID
  • cq:lastReplicationAction 儲存上次複製操作(如激活、停用)

使用預設謂詞計算器查詢複製元資料

以下查詢將讀取中的節點清單 /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=>=

此查詢有效,但難於讀取,不會突出顯示三個複製屬性之間的關係。 實現自定義謂詞計算器將降低查詢的複雜度,提高查詢的語義。

目標

目標 ReplicationPredicateEvaluator 是使用以下語法支援上述查詢。

path=/content

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

將複製元資料謂詞與自定義謂詞計算器分組有助於建立有意義的查詢。

更新Maven依賴項

秘訣

本文詳AEM細解釋了新項目(包括使用maven) WKND教程。

首先,您需要更新項目的Maven依賴項。 的 PredicateEvaluatorcq-search 藏物,所以需要把它添加到你的Maven pom檔案。

注意

範圍 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>

編寫ReplicationPredicateEvaluator

cq-search 項目包含 AbstractPredicateEvaluator 抽象類。 可以通過幾個步驟來擴展此功能,以實現您自己的自定義謂詞計算器 (PredicateEvaluator)。

注意

以下過程說明如何生成 Xpath 用於篩選資料的表達式。 另一個選擇是實施 includes 按行選擇資料的方法。 查看 Java文檔 的子菜單。

  1. 建立新的Java類,該類擴展 com.day.cq.search.eval.AbstractPredicateEvaluator

  2. 使用 @Component 如同skinpet在 統一差異格式

    @@ -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 {
    
     }
    
    注意

    factory必須是唯一字串,開頭為 com.day.cq.search.eval.PredicateEvaluator/以自定義名稱結尾 PredicateEvaluator

    注意

    名稱 PredicateEvaluator 是謂詞名稱,在生成查詢時使用。

  3. 覆寫:

    public String getXPathExpression(Predicate predicate, EvaluationContext context)
    

    在覆蓋方法中,生成 Xpath 基於 Predicate 在論證中給出。

複製元資料的自定義謂詞計算器示例

全面實施 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 ");

        }

    }

}

本頁內容