Mise en œuvre d’un évaluateur de prédicat personnalisé pour Query Builder

Ce document décrit comment étendre Query Builder en mettant en œuvre un évaluateur de prédicat personnalisé.

Vue d’ensemble

Query Builder met à votre disposition un moyen efficace d’appliquer des requêtes au référentiel de contenu. AEM est fourni avec un ensemble d’évaluateurs de prédicats qui vous aident à appliquer des requêtes à vos données.

Cependant, vous pouvez simplifier vos requêtes en implémentant un évaluateur de prédicat personnalisé qui masque une certaine complexité et garantit une meilleure sémantique.

Un prédicat personnalisé peut également effectuer d’autres tâches qui ne sont pas directement possibles avec XPath, par exemple :

• Requêtes sur des données à l’aide d’un autre service
• Filtrage personnalisé basé sur le calcul

L’évaluateur de prédicat en détail

Un évaluateur gère l’évaluation de certains prédicats qui constituent les contraintes définissant une requête.

Il mappe une contrainte de recherche de plus haut niveau (par exemple width>200) sur une requête JCR spécifique adaptée au modèle de contenu actuel (par exemple metadata/@width > 200). Il peut également filtrer manuellement les nœuds et vérifier leurs contraintes.

Mise en œuvre d’un évaluateur de prédicat personnalisé pour les métadonnées de réplication

En guise d’illustration, cette section décrit comment créer un évaluateur de prédicat personnalisé qui aide à évaluer les données en fonction des métadonnées de réplication :

• cq:lastReplicated qui stocke la date de la dernière action de réplication.
• cq:lastReplicatedBy qui stocke l’ID de l’utilisateur qui a déclenché la dernière action de réplication.
• cq:lastReplicationAction qui stocke la dernière action de réplication (par exemple, activation ou désactivation).

Requête sur les métadonnées de réplication avec les évaluateurs de prédicats par défaut

La requête suivante récupère la liste des nœuds dans la branche /content qui a été activée par admin depuis le début de l’année.

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=>=

Cette requête est valide, mais peu lisible et ne met pas en évidence la relation entre les trois propriétés de réplication. La mise en œuvre d’un évaluateur de prédicat personnalisé réduit la complexité et améliore la sémantique de cette requête.

Objectifs

L’objectif de ReplicationPredicateEvaluator consiste à prendre en charge la requête ci-dessus à l’aide de la syntaxe ci-après.

path=/content

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

Le regroupement des prédicats de métadonnées de réplication avec un évaluateur de prédicat personnalisé permet de créer une requête pertinente.

Mise à jour des dépendances Maven

Tout d’abord, vous devez mettre à jour les dépendances Maven de votre projet. La variable PredicateEvaluator fait partie de la cq-search artefact afin qu’il soit ajouté à votre fichier pom Maven.

Le fragment suivant présente les différences dans le fichier pom.xml au format diff unifié

@@ -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>

Écriture de ReplicationPredicateEvaluator

Le projet cq-search contient la classe abstraite AbstractPredicateEvaluator. Il est possible d’améliorer cela moyennant quelques étapes pour mettre en œuvre votre évaluateur de prédicat personnalisé (PredicateEvaluator).

1. Créez une classe Java qui étend com.day.cq.search.eval.AbstractPredicateEvaluator.

2. Annotez votre classe avec un @Component, par exemple des affichages de fragment de code au format diff unifié.

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

   REMARQUE

   La factory doit être une chaîne unique commençant par com.day.cq.search.eval.PredicateEvaluator/ et se terminant par le nom de votre PredicateEvaluator personnalisé.

   REMARQUE

   Le nom de PredicateEvaluator est le nom du prédicat, qui est utilisé pour créer des requêtes.

3. Remplacement :

   public String getXPathExpression(Predicate predicate, EvaluationContext context)
   

   Avec la méthode de remplacement, vous créez une expression Xpath basée sur le Predicate fourni comme argument.

Exemple d’évaluateur de prédicat personnalisé pour les métadonnées de réplication

La mise en œuvre complète de ce PredicateEvaluator peut être semblable à la classe suivante.

/*
 * #%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 ");

        }

    }

}