Implementando um Avaliador de Predicados Personalizados para o Construtor de Consultas

Este documento descreve como estender o Construtor de consultas implementando um avaliador de predicado personalizado.

Visão geral

O Construtor de consultas oferece uma maneira fácil de consultar o repositório de conteúdo. AEM vem com um conjunto de avaliadores de predicado que ajudam a consultar seus dados.

No entanto, você pode querer simplificar suas consultas implementando um avaliador de predicado personalizado que oculta alguma complexidade e garante uma melhor semântica.

Um predicado personalizado também pode executar outras coisas que não são diretamente possíveis com o XPath, por exemplo:

  • Consultando dados de outro serviço
  • Filtragem personalizada com base em um cálculo
OBSERVAÇÃO

Problemas de desempenho devem ser considerados ao implementar um predicado personalizado.

DICA

Você pode encontrar exemplos de consultas no documento Construtor de consultas.

DICA

Você pode encontrar o código desta página no GitHub

OBSERVAÇÃO

Este código vinculado no GitHub e os trechos de código neste documento são fornecidos apenas para fins de demonstração.

Avaliador de Predicados em Detalhes

Um avaliador de predicado lida com a avaliação de determinados predicados, que são as restrições de definição de um query.

Ele mapeia uma restrição de pesquisa de nível superior (como width>200) para uma consulta JCR específica que se encaixa no modelo de conteúdo real (por exemplo, metadata/@width > 200). Ou pode filtrar nós manualmente e verificar suas restrições.

DICA

Para obter mais informações sobre o PredicateEvaluator e o pacote com.day.cq.search, consulte a documentação do Java.

Implementando um avaliador de predicado personalizado para metadados de replicação

Como exemplo, esta seção descreve como criar um avaliador de predicado personalizado que ajuda os dados com base nos metadados de replicação:

  • cq:lastReplicated que armazena a data da última ação de replicação
  • cq:lastReplicatedBy que armazena o id do usuário que acionou a última ação de replicação
  • cq:lastReplicationAction que armazena a última ação de replicação (por exemplo, Ativação, Desativação)

Consulta de metadados de replicação com avaliadores de predicado padrão

A consulta a seguir busca a lista de nós na ramificação /content que foram ativados por admin desde o início do ano.

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 é válida, mas difícil de ler, e não realça a relação entre as três propriedades de replicação. A implementação de um avaliador de predicado personalizado reduzirá a complexidade e melhorará a semântica deste query.

Objetivos

O objetivo do ReplicationPredicateEvaluator é oferecer suporte à consulta acima usando a sintaxe a seguir.

path=/content

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

O agrupamento de metadados de replicação prevê com um avaliador de predicado personalizado ajuda a criar um query significativa.

Atualização de dependências do Maven

DICA

A configuração de novos projetos de AEM, incluindo o uso de maven, é explicada detalhadamente por o tutorial WKND.

Primeiro, você precisa atualizar as dependências Maven do seu projeto. O PredicateEvaluator faz parte do artefato cq-search, portanto, ele precisa ser adicionado ao arquivo pom Maven.

OBSERVAÇÃO

O escopo da dependência cq-search é definido como provided porque cq-search será fornecido pelo contêiner OSGi.

O trecho a seguir mostra as diferenças no arquivo pom.xml, em formato diff 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>

Escrever O ReplicationPredicateEvaluator

O projeto cq-search contém a classe abstrata AbstractPredicateEvaluator. Isso pode ser estendido com algumas etapas para implementar seu próprio avaliador de predicado personalizado (PredicateEvaluator).

OBSERVAÇÃO

O procedimento a seguir explica como criar uma expressão Xpath para filtrar dados. Outra opção seria implementar o método includes que seleciona dados em uma base de linha. Consulte a documentação do Java para obter mais informações.

  1. Crie uma nova classe Java que estende com.day.cq.search.eval.AbstractPredicateEvaluator

  2. Anote sua classe com um trecho @Component como exibido em formato diff 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 {
    
     }
    
    OBSERVAÇÃO

    O factorydeve ser uma cadeia de caracteres exclusiva que começa com com.day.cq.search.eval.PredicateEvaluator/e termina com o nome do PredicateEvaluator personalizado.

    OBSERVAÇÃO

    O nome do PredicateEvaluator é o nome do predicado, que é usado ao criar consultas.

  3. Substituir:

    public String getXPathExpression(Predicate predicate, EvaluationContext context)
    

    No método de substituição, você cria uma expressão Xpath com base no argumento Predicate .

Exemplo de um Avaliador de Predicado Personalizado para Metadados de Replicação

A implementação completa deste PredicateEvaluator pode ser semelhante à seguinte classe.

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

        }

    }

}

Nesta página