Implementieren eines benutzerdefinierten Prädikat-Auswerters für den Query Builder implementing-a-custom-predicate-evaluator-for-the-query-builder
In diesem Abschnitt wird beschrieben, wie Sie die Query Builder durch Implementierung eines benutzerdefinierten Prädikat-Auswerters.
Übersicht overview
Die Query Builder bietet eine einfache Möglichkeit, das Inhalts-Repository abzufragen. CQ bietet eine Reihe von Prädikat-Auswertern, die Ihnen beim Umgang mit Ihren Daten helfen.
Möglicherweise möchten Sie Ihre Abfragen jedoch vereinfachen, indem Sie einen benutzerdefinierten Prädikat-Auswerter implementieren, der etwas Komplexität verbirgt und eine bessere Semantik gewährleistet.
Ein benutzerdefiniertes Prädikat ist auch für andere Aufgaben nützlich, die nicht direkt mit XPath ausgeführt werden können, z. B.:
- Suchen nach Daten aus einem Dienst
- Benutzerdefiniertes Filtern basierend auf Berechnungen
CODE AUF GITHUB
Den Code dieser Seite finden Sie auf GitHub…
- Öffnen Sie das Projekt „aem-search-custom-predicate-evaluator“ auf GitHub.
- Laden Sie das Projekt als ZIP-Datei herunter.
Prädikat-Auswerter im Detail predicate-evaluator-in-detail
Ein Prädikat-Auswerter ist für die Auswertung bestimmter Prädikate zuständig, die eine Abfrage einschränken.
Er ordnet eine Suchbegrenzung auf höherer Ebene (z. B. "Breite > 200") einer bestimmten JCR-Abfrage zu, die dem tatsächlichen Inhaltsmodell entspricht (z. B. metadata/@width > 200). Es können auch Knoten manuell gefiltert und deren Einschränkungen überprüft werden.
PredicateEvaluator
und com.day.cq.search
-Paket finden Sie unter Java™-Dokumentation.Implementieren eines benutzerdefinierten Prädikat-Auswerters für Replikationsmetadaten implementing-a-custom-predicate-evaluator-for-replication-metadata
In diesem Abschnitt wird anhand eines Beispiels beschrieben, wie Sie einen benutzerdefinierten Prädikat-Auswerter erstellen, der die Verarbeitung von Daten basierend auf Replikationsmetadaten erleichtert:
-
cq:lastReplicated
speichert die Daten der letzten Replikationsaktion. -
cq:lastReplicatedBy
speichert die ID des Benutzers, der die letzte Replikationsaktion ausgelöst hat. -
cq:lastReplicationAction
speichert die letzte Replikationsaktion (z. B. Aktivierung, Deaktivierung)
Abfragen von Replikationsmetadaten mit Standard-Prädikat-Auswertern querying-replication-metadata-with-default-predicate-evaluators
Mit folgender Abfrage wird die Liste der Knoten im Zweig /content
abgerufen, die vom Benutzer admin
seit Jahresanfang aktiviert wurden.
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=>=
Diese Abfrage ist zwar gültig, jedoch schwer zu lesen. Außerdem wird die Beziehung zwischen den drei Replikationseigenschaften nicht hervorgehoben. Die Implementierung eines benutzerdefinierten Prädikat-Auswerters reduziert die Komplexität und verbessert die Semantik dieser Abfrage.
Ziele objectives
Ziel des ReplicationPredicateEvaluator
ist die Unterstützung der obigen Abfrage durch folgende Syntax:
path=/content
replic.by=admin
replic.since=2013-01-01T00:00:00.000+01:00
replic.action=Activate
Das Gruppieren von Metadatenprädikaten einer Replikation mit einem benutzerdefinierten Prädikat-Auswerter erleichtert das Erstellen einer aussagekräftigen Abfrage.
Aktualisieren von Maven-Abhängigkeiten updating-maven-dependencies
Aktualisieren Sie zunächst die Maven-Abhängigkeiten Ihres Projekts. Die PredicateEvaluator
ist Teil der cq-search
-Artefakt, sodass es zu Ihrer Maven-Datei pom.xml hinzugefügt werden muss.
cq-search
dependency ist auf provided
because cq-search
von OSGi
Container.pom.xml
Das folgende Snippet zeigt die Unterschiede bei einheitliches Vergleichsformat
@@ -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
Schreiben des ReplicationPredicateEvaluator writing-the-replicationpredicateevaluator
Das cq-search
-Projekt beinhaltet die abstrakte Klasse AbstractPredicateEvaluator
. Diese kann in wenigen Schritten mit einem benutzerdefinierten Prädikat-Auswerter (PredicateEvaluator
) erweitert werden.
Xpath
-Ausdruck zum Filtern von Daten erstellen. Eine andere Option ist das Implementieren einer includes
-Methode, bei der Daten auf Zeilenbasis ausgewählt werden. Siehe Java™-Dokumentation für weitere Informationen.-
Erstellen einer Java™-Klasse, die
com.day.cq.search.eval.AbstractPredicateEvaluator
-
Kommentieren Sie die Klasse mit einer
@Component
wiesrc/main/java/com/adobe/aem/docs/search/ReplicationPredicateEvaluator.java
Das folgende Snippet zeigt die Unterschiede bei einheitliches Vergleichsformat
@@ -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
muss eine eindeutige Zeichenfolge sein, die mit com.day.cq.search.eval.PredicateEvaluator/
beginnt und mit dem Namen des benutzerdefinierten PredicateEvaluator
endet.PredicateEvaluator
ist der Name des Prädikats, das zum Erstellen von Abfragen verwendet wird.-
Überschreiben:
code language-java public String getXPathExpression(Predicate predicate, EvaluationContext context)
In der Überschreibungsmethode erstellen Sie eine
Xpath
Ausdruck basierend auf demPredicate
im -Argument angegeben.
Beispiel für einen benutzerdefinierten Prädikat-Auswerter für Replikationsmetadaten example-of-a-custom-predicate-evalutor-for-replication-metadata
Die vollständige Implementierung dieses PredicateEvaluator
kann der folgenden Klasse ähnlich sein.
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