Implementación de un evaluador de predicados personalizado para el generador de consultas

Este documento describe cómo ampliar el Generador de consultas implementando un evaluador de predicado personalizado.

Información general

La variable Generador de consultas ofrece una forma sencilla de consultar el repositorio de contenido. AEM viene con un conjunto de evaluadores predicados que le ayudan a consultar sus datos.

Sin embargo, es posible que desee simplificar las consultas mediante la implementación de un evaluador de predicados personalizado que oculte cierta complejidad y garantice una mejor semántica.

Un predicado personalizado también podría realizar otras cosas no directamente posibles con XPath, por ejemplo:

• Consulta de datos de otro servicio
• Filtro personalizado basado en un cálculo

Predicar evaluador en detalle

Un evaluador predicado gestiona la evaluación de ciertos predicados, que son las restricciones de definición de una consulta.

Asigna una restricción de búsqueda de nivel superior (por ejemplo, width>200) a una consulta JCR específica que se ajuste al modelo de contenido real (p. ej. metadata/@width > 200). O puede filtrar manualmente los nodos y comprobar sus restricciones.

Implementación de un evaluador de predicados personalizado para metadatos de replicación

Como ejemplo, en esta sección se describe cómo crear un evaluador de predicado personalizado que ayude a crear datos basados en los metadatos de replicación:

• cq:lastReplicated que almacena la fecha de la última acción de replicación
• cq:lastReplicatedBy que almacena el id del usuario que activó la última acción de replicación
• cq:lastReplicationAction que almacena la última acción de replicación (por ejemplo, Activación, Desactivación)

Consulta de metadatos de replicación con evaluadores de predicados predeterminados

La siguiente consulta obtiene la lista de nodos de /content rama activada por admin desde principios de año.

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

Esta consulta es válida pero difícil de leer y no resalta la relación entre las tres propiedades de replicación. La implementación de un evaluador de predicado personalizado reducirá la complejidad y mejorará la semántica de esta consulta.

Objetivos

El objetivo de ReplicationPredicateEvaluator es para admitir la consulta anterior utilizando la siguiente sintaxis.

path=/content

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

Agrupar predicados de metadatos de replicación con un evaluador de predicado personalizado ayuda a crear una consulta significativa.

Actualización de dependencias de Maven

Primero debe actualizar las dependencias Maven del proyecto. La variable PredicateEvaluator forma parte del cq-search artefacto para que sea necesario agregarlo al archivo pom de Maven.

El siguiente fragmento muestra las diferencias en la variable pom.xml en formato de comparación de diferencias unificado

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

Escritura del ReplicationPredicateEvaluator

La variable cq-search el proyecto contiene el AbstractPredicateEvaluator clase abstracta. Esto se puede ampliar con algunos pasos para implementar su propio evaluador de predicados personalizado (PredicateEvaluator).

1. Cree una nueva clase Java que se extienda com.day.cq.search.eval.AbstractPredicateEvaluator

2. Ponga notas en la clase con un @Component como muestra un fragmento formato de comparación de diferencias unificado

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

   NOTA

   La variable factorydebe ser una cadena única que comience por com.day.cq.search.eval.PredicateEvaluator/y finalizando con el nombre de su PredicateEvaluator.

   NOTA

   El nombre del PredicateEvaluator es el nombre del predicado, que se utiliza al crear consultas.

3. Omitir:

   public String getXPathExpression(Predicate predicate, EvaluationContext context)
   

   En el método override se crea un Xpath expresión basada en la variable Predicate dado en el argumento .

Ejemplo de un evaluador de predicados personalizado para metadatos de replicación

La aplicación completa de esta PredicateEvaluator puede ser similar a la siguiente clase.

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

        }

    }

}