為查詢產生器實作自訂述詞求值器 implementing-a-custom-predicate-evaluator-for-the-query-builder
本節說明如何實作自訂述詞求值器來擴充查詢產生器。
概觀 overview
查詢產生器提供查詢內容存放庫的簡單方式。 CQ隨附一組述詞評估器，可協助您處理資料。
不過，您可能想要實作自訂述詞評估器來簡化查詢，該評估器會隱藏一些複雜度並確保更好的語意。
自訂述詞也可以執行其他不直接與XPath一起執行的動作，例如：
- 從某些服務查詢某些資料
- 根據計算的自訂篩選
GITHUB上的程式碼
您可以在GitHub上找到此頁面的程式碼。
- 在GitHub上開啟aem-search-custom-predicate-evaluator專案
- 將專案下載為ZIP檔
述詞求值器詳細資料 predicate-evaluator-in-detail
述詞評估器處理特定述詞的評估，這些述詞是查詢的定義限制。
這會將較高層級的搜尋限制（例如「寬度> 200」）對應至符合實際內容模型的特定JCR查詢(例如，中繼資料/@width度> 200)。 或者，它可以手動篩選節點並檢查其限制。
實施復寫中繼資料的自訂述詞求值器 implementing-a-custom-predicate-evaluator-for-replication-metadata
本節以範例說明如何建立自訂述詞評估器，協助根據復寫中繼資料的資料：
-
儲存上次復寫動作日期的
cq:lastReplicated -
cq:lastReplicatedBy儲存觸發上次復寫動作之使用者的識別碼 -
儲存上次復寫動作（例如啟用、停用）的
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
首先，更新專案的Maven相依性。 PredicateEvaluator是cq-search成品的一部分，因此必須將其新增到您的Maven pom.xml檔案。
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 writing-the-replicationpredicateevaluator
cq-search專案包含AbstractPredicateEvaluator抽象類別。 這可以透過幾個步驟來延伸以實作您自己的自訂述詞求值器(PredicateEvaluator)。
-
建立擴充
com.day.cq.search.eval.AbstractPredicateEvaluator的Java™類別 -
使用
@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的名稱是建立查詢時使用的述詞名稱。-
覆寫：
code language-java public String getXPathExpression(Predicate predicate, EvaluationContext context)在覆寫方法中，您會根據引數中指定的
Predicate建置Xpath運算式。
復寫中繼資料的自訂述詞求值器範例 example-of-a-custom-predicate-evalutor-for-replication-metadata
此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