為查詢產生器實作自訂述詞求值器

本節說明如何擴充查詢產生器實施自訂述詞求值器。

總覽

此查詢產生器提供了查詢內容儲存庫的簡單方法。 CQ隨附一組可協助您處理資料的謂語評估器。

不過，您可能想要實作自訂述詞求值器來簡化查詢，該求值器會隱藏一些複雜性，並確保提供更好的語義。

自訂述詞也可以執行XPath不直接可能的其他操作，例如：

從某些服務中查找一些資料
根據計算自訂篩選

注意

實作自訂述詞時，必須考量效能問題。

注意

您可以在查詢產生器區段。

GITHUB上的程式碼

您可以在GitHub上找到此頁面的程式碼

在GitHub上開啟aem-search-custom-predicate-evaluator專案
將專案下載為 ZIP檔案

詳細資訊中的謂語求值器

謂語求值器處理某些謂語的求值，這些謂語是查詢的定義約束。

它會將較高層級的搜尋限制（例如「寬度> 200」）對應至符合實際內容模型(例如中繼資料/@width > 200)的特定JCR查詢。或者，它可以手動篩選節點並檢查其限制。

注意

如需 PredicateEvaluator 和 com.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相依性

注意

使用maven的新AEM專案的設定由如何使用Apache Maven建立AEM專案.

首先，您需要更新專案的Maven相依性。此 PredicateEvaluator 是 cq-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>

aem-search-custom-predicate-evaluator- pom.xml

編寫ReplicationPredicateEvaluator

此 cq-search 專案包含 AbstractPredicateEvaluator 抽象類。可透過幾個步驟來擴充，以實作您自己的自訂述詞求值器 (PredicateEvaluator)。

注意

下列程式說明如何建立 Xpath 運算式來篩選資料。另一種選擇是實施 includes 以列為基礎選取資料的方法。請參閱 Java檔案以取得更多資訊。

建立擴展的新Java類 com.day.cq.search.eval.AbstractPredicateEvaluator
使用 @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 是述詞名稱，用於建立查詢。

覆寫:

public String getXPathExpression(Predicate predicate, EvaluationContext context)

在覆寫方法中，您建立 Xpath 基於的運算式 Predicate 給定。

復寫中繼資料的自訂謂語求值器範例

完整實作 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

Business.Adobe.com 資源

Multichannel Communication Ecommerce Integrations Personalized Experiences Theme Editor Dynamic Media Digital Asset Management

全新的改善搜尋

為查詢產生器實作自訂述詞求值器

總覽

詳細資訊中的謂語求值器

為復寫中繼資料實作自訂述詞求值器

使用預設謂詞求值器查詢複製元資料

目標

更新Maven相依性

編寫ReplicationPredicateEvaluator

復寫中繼資料的自訂謂語求值器範例

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe