Implementing a Custom Predicate Evaluator for the Query Builder

本節說明如何透過實作自訂謂詞評估器來擴充查詢產生器。

概覽

查詢產生器提供了查詢內容儲存庫的簡單方法。 AEM隨一組謂詞評估程式出貨，可協助您處理資料。

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

自定義謂語也可以執行XPath無法直接執行的其他操作，例如：

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

注意

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

注意

您可以在Query Builder區段中找到查詢範例。

GITHUB代碼

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

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

Predicate Evaluator in Detail

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

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

注意

有關PredicateEvaluator和com.day.cq.search軟體包的詳細資訊，請參閱 Java文檔。

Implementing a Custom Predicate Evaluator for Replication Metadata

作為示例，本節介紹如何建立自定義謂詞評估器，該評估器幫助基於複製元資料的資料：

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依賴項

注意

如何使用Apache Maven建立AEM專案，說明如何使用maven來設定新的AEM專案。

首先，您需要更新專案的Maven相依性。 PredicateEvaluator是cq-search對象的一部分，因此需要將其添加到Maven pom檔案中。

注意

由於OSGi容器將提供cq-search，因此cq-search相依性的範圍被設定為provided。

pom.xml

以下程式碼片段顯示unified diff format的差異

@@ -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抽象類。 This can be extended with a few steps to implement your own custom predicate evaluator (PredicateEvaluator)。

注意

下列程式說明如何建立Xpath運算式來篩選資料。另一個選項是實施includes方法，該方法以行為基礎選擇資料。如需詳細資訊，請參閱Java檔案。

建立擴展com.day.cq.search.eval.AbstractPredicateEvaluator的新Java類
使用@Component類似下列的

src/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java

以下程式碼片段顯示unified diff format的差異

@@ -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)
```
在override方法中，您根據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