API Query Builder

La fonctionnalité du Query Builder Asset Share est exposée via une API Java et une API REST. Cette section décrit ces API.

Le générateur de requêtes côté serveur (QueryBuilder) accepte une description de requête, crée et exécute une requête XPath, filtre éventuellement le jeu de résultats et, si vous le souhaitez, extrait également des facettes.

La description de requête correspond simplement à un ensemble de prédicats (Predicate). Par exemple, un prédicat de texte intégral correspond à la fonction jcr:contains() dans XPath.

Pour chaque type de prédicat, il existe un composant Évaluateur (PredicateEvaluator) qui sait comment en effectuer la gestion pour XPath, pour le filtrage et pour l’extraction de facettes. Il est très facile de créer des évaluateurs personnalisés, qui sont activés via l’exécutable du composant OSGi.

L’API REST permet d’accéder exactement aux mêmes fonctionnalités via HTTP, les réponses étant envoyées au format JSON.

Session Gem

AEM Gems est une série de sessions techniques approfondies sur Adobe Experience Manager dispensées par des experts Adobe. Cette session consacrée à Query Builder s’avère très utile pour se familiariser avec l’outil.

Exemples de requêtes

Ces exemples sont fournis dans la notation de style des propriétés Java. Pour les utiliser avec l’API Java, utilisez un HashMap Java comme dans l’exemple d’API suivant.

Pour le servlet JSON QueryBuilder, chaque exemple comprend un lien vers votre installation CQ locale (à l’emplacement par défaut, http://localhost:4502). Notez que vous devez vous connecter à votre instance CQ avant d’utiliser ces liens.

Renvoi de tous les résultats

La requête suivante renvoie dix résultats (ou, pour être précis, un maximum de dix), mais vous informe du Nombre d’accès réellement disponibles :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
orderby=path

La même requête (avec le paramètre p.limit=-1) renvoie tous les résultats (il peut s’agir d’un nombre élevé en fonction de votre instance) :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.limit=-1&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.limit=-1
orderby=path

Utilisation de p.guessTotal pour renvoyer les résultats

L’objectif du paramètre p.guessTotal est de renvoyer le nombre approprié de résultats pouvant être affichés en combinant les plus petites valeurs p.offset et p.limit possibles. Utilisé avec des jeux de résultats de grande taille, ce paramètre offre des performances accrues. Cela vous évite de calculer le total (en appelant result.getSize(), par exemple) et de lire tout le jeu de résultats, optimisé jusqu’à l’index et au moteur OAK. Cela peut constituer une différence importante lorsqu’il y a des centaines de milliers de résultats, tant sur le plan de la durée d’exécution que de l’utilisation de la mémoire.

L’inconvénient de ce paramètre est que les utilisateurs ne voient pas le total exact. Vous pouvez toutefois définir une valeur minimale, telle que p.guessTotal=1000, de sorte que la lecture soit toujours effectuée jusqu’à 1 000. Vous obtiendrez ainsi des totaux exacts pour des jeux de résultats plus petits. En revanche, pour des résultats supérieurs, vous pouvez simplement afficher « et plus ».

Ajoutez p.guessTotal=true à la requête ci-dessous pour voir comment cela fonctionne :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.guessTotal=true
orderby=path

La requête renvoie la valeur p.limit par défaut de 10 résultats avec un décalage 0 :

"success": true,
"results": 10,
"total": 10,
"more": true,
"offset": 0,

Depuis AEM 6.0 SP2, vous pouvez également utiliser une valeur numérique pour compter jusqu’à un nombre personnalisé de résultats maximums. Utilisez la même requête que ci-dessus, mais définissez la valeur de p.guessTotal sur 50 :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=50&orderby=path

Elle renvoie un nombre dont la limite par défaut est de 10 résultats avec un décalage de 0, mais n’affiche qu’un maximum de 50 résultats :

"success": true,
"results": 10,
"total": 50,
"more": true,
"offset": 0,

Mise en œuvre de la pagination

Par défaut, Query Builder fournit également le nombre d’accès. Suivant la taille du résultat, cette opération peut prendre un certain temps, étant donné qu’il est nécessaire de vérifier le contrôle d’accès pour chaque résultat afin de déterminer le nombre exact. Le total est essentiellement utilisé pour implémenter la pagination pour l’IU de l’utilisateur final. Déterminer le nombre exact peut s’avérer particulièrement lent. Aussi, est-il conseillé d’utiliser la fonctionnalité guessTotal pour implémenter la pagination.

L’interface utilisateur peut, par exemple, adapter la méthode suivante :

• Obtenez et affichez le nombre exact du nombre total d'accès (SearchResult.getTotalMatches() ou total dans la réponse querybuilder.json) est inférieur ou égal à 100 ;

• Définissez guessTotal sur 100 tout en effectuant l’appel vers Query Builder.

• La réponse peut générer le résultat suivant :

  • total=43, more=false - Indique que le nombre total d’accès est de 43. L’interface utilisateur peut afficher jusqu’à dix résultats dans le cadre de la première page et fournir la pagination pour les trois pages suivantes. Vous pouvez également utiliser cette implémentation pour afficher un texte descriptif tel que « 43 résultats trouvés ».
  • total=100, more=true - Indique que le nombre total d’accès est supérieur à 100 et que le nombre exact n’est pas connu. L’interface utilisateur peut afficher jusqu’à dix résultats dans le cadre de la première page et fournir la pagination pour les dix pages suivantes. Vous pouvez également utiliser cette implémentation pour afficher un texte tel que « plus de 100 résultats trouvés ». Lorsque l’utilisateur accède aux pages suivantes, les appels effectués vers Query Builder augmentent la limite de guessTotal, ainsi que celle des paramètres offset et limit.

Il est également conseillé d’utiliser guessTotal lorsque l’IU doit appliquer un défilement infini, afin d’empêcher Query Builder de déterminer le nombre exact d’accès.

Recherche et classement des fichiers JAR, en commençant par le plus récent

http://localhost:4502/bin/querybuilder.json?type=nt:file&nodename=*.jar&orderby=@jcr:content/jcr:lastModified&orderby.sort=desc

type=nt:file
nodename=*.jar
orderby=@jcr:content/jcr:lastModified
orderby.sort=desc

Recherche de toutes les pages et classement par date de la dernière modification

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

type=cq:Page
orderby=@jcr:content/cq:lastModified

Recherche de toutes les pages et classement par date de la dernière modification, mais par ordre décroissant

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified&orderby.sort=desc]

type=cq:Page
orderby=@jcr:content/cq:lastModified
orderby.sort=desc

Recherche en texte intégral, avec classement par score

http://localhost:4502/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

fulltext=Management
orderby=@jcr:score
orderby.sort=desc

Recherche des pages présentant une balise donnée

http://localhost:4502/bin/querybuilder.json?type=cq:Page&tagid=marketing:interest/product&tagid.property=jcr:content/cq:tags `

type=cq:Page
tagid=marketing:interest/product
tagid.property=jcr:content/cq:tags

Utilisez le prédicat tagid comme dans l'exemple si vous connaissez l'ID de balise explicite.

Utilisez le prédicat tag pour le chemin d’accès au titre de la balise (sans espaces).

Dans l'exemple précédent, vous recherchez des pages ( cq:Page noeuds), vous devez utiliser le chemin relatif de ce noeud pour le prédicat tagid.property, qui est jcr:content/cq:tags. Par défaut, tagid.property serait simplement cq:tags.

Recherche dans plusieurs chemins d’accès (à l’aide de groupes)

http://localhost:4502/bin/querybuilder.json?fulltext=Management&group.1_path=/content/geometrixx/en/company/management&group.2_path=/content/geometrixx/en/company/bod&group.p.or=true

fulltext=Management
group.p.or=true
group.1_path=/content/geometrixx/en/company/management
group.2_path=/content/geometrixx/en/company/bod

Cette requête utilise un groupe (appelé « group »), qui sert à délimiter les sous-expressions dans une requête, à l’instar des parenthèses dans des notations plus standard. Par exemple, la requête précédente peut être exprimée dans un style plus familier comme suit :

"Management" and ("/content/geometrixx/en/company/management?lang=fr" or "/content/geometrixx/en/company/bod?lang=fr")

Le prédicat path est utilisé à plusieurs reprises dans le groupe de l’exemple précédent. Pour différencier et classer les deux instances du prédicat (l'ordre est requis pour certains prédicats), vous devez préfixer les prédicats avec N _ whereN comme index d'ordonnancement. Dans l'exemple précédent, les prédicats résultants sont 1_path et 2_path.

p dans p.or est un délimiteur spécial qui indique que ce qui suit (dans ce cas un or) est un paramètre du groupe, par opposition à un sous-prédicat du groupe, tel que 1_path.

Si aucun p.or n'est donné, tous les prédicats sont ETés ensemble, c'est-à-dire que chaque résultat doit satisfaire tous les prédicats.

Recherche de propriétés

Dans ce cas, vous recherchez toutes les pages d’un modèle donné, à l’aide de la propriété cq:template :

http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/apps/geometrixx/templates/homepage

L’inconvénient est que les nœuds jcr:content des pages sont renvoyés, et non les pages proprement dites. Pour remédier à ce problème, vous pouvez effectuer une recherche par chemin d’accès relatif :

http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/apps/geometrixx/templates/homepage

Recherche de plusieurs propriétés

Lorsque vous utilisez plusieurs fois le prédicat property, vous devez ajouter à nouveau les préfixes numériques :

http://localhost:4502/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=English&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/apps/geometrixx/templates/homepage
2_property=jcr:content/jcr:title
2_property.value=English

Recherche de plusieurs valeurs de propriété

Pour éviter les grands groupes lorsque vous souhaitez rechercher plusieurs valeurs d’une propriété ( "A" or "B" or "C"), vous pouvez fournir plusieurs valeurs au prédicat property :

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events

property=jcr:title
property.1_value=Products
property.2_value=Square
property.3_value=Events

Pour les propriétés à plusieurs valeurs, vous pouvez également exiger que plusieurs valeurs correspondent ( "A" and "B" and "C") :

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=test&property.2_value=foo&property.3_value=bar

property=jcr:title
property.and=true
property.1_value=test
property.2_value=foo
property.3_value=bar

Amélioration des propriétés renvoyées

Par défaut, le servlet JSON QueryBuilder renvoie un jeu de propriétés par défaut pour chaque nœud dans les résultats de recherche (par exemple : chemin d’accès, nom, titre, etc.). Pour contrôler les propriétés renvoyées, vous pouvez effectuer l’une des opérations suivantes :

Spécifier

p.hits=full

dans quel cas toutes les propriétés seront incluses pour chaque noeud :

http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full

Utilisation

p.hits=selective

et spécifiez les propriétés à intégrer

p.properties

séparé par un espace :

http://localhost:4502/bin/querybuilder.json?p.hits=selective&property=jcr%3atitle&property.value=Triangle

http://localhost:4502/bin/querybuilder.json? p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=selective
p.properties=sling:resourceType jcr:primaryType

Vous pouvez également inclure des nœuds enfants dans la réponse de QueryBuilder. Pour ce faire, vous devez spécifier

p.nodedepth=n

où n correspond au nombre de niveaux que la requête doit renvoyer. Pour qu’un nœud enfant soit renvoyé, notez qu’il doit être spécifié par le sélecteur de propriétés

p.hits=full

Exemple :

http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full
p.nodedepth=5

Plus de prédicats

Pour plus de prédicats, consultez la page de référence des prédicats de Query Builder.

Vous pouvez également vérifier le code Javadoc pour les classes PredicateEvaluator. Ce JavaDoc contient la liste des propriétés que vous pouvez utiliser.

Le préfixe du nom de classe (par exemple, " similar" dans SimilarityPredicateEvaluator) est la propriété principale de la classe. Cette propriété est également le nom du prédicat à utiliser dans la requête (en minuscules).

Pour ces propriétés principales, vous pouvez raccourcir la requête et utiliser " similar=/content/en" au lieu de la variante complète " similar.similar=/content/en". La forme complète doit être utilisée pour toutes les propriétés non principales d’une classe.

Exemple d’utilisation de l’API Query Builder

   String fulltextSearchTerm = "Geometrixx";

    // create query description as hash map (simplest way, same as form post)
    Map<String, String> map = new HashMap<String, String>();
  
// create query description as hash map (simplest way, same as form post)
    map.put("path", "/content");
    map.put("type", "cq:Page");
    map.put("group.p.or", "true"); // combine this group with OR
    map.put("group.1_fulltext", fulltextSearchTerm);
    map.put("group.1_fulltext.relPath", "jcr:content");
    map.put("group.2_fulltext", fulltextSearchTerm);
    map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");
 
    // can be done in map or with Query methods
    map.put("p.offset", "0"); // same as query.setStart(0) below
    map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below

    Query query = builder.createQuery(PredicateGroup.create(map), session);
    query.setStart(0);
    query.setHitsPerPage(20);

    SearchResult result = query.getResult();
 
    // paging metadata
    int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
    long totalMatches = result.getTotalMatches();
    long offset = result.getStartIndex();
    long numberOfPages = totalMatches / 20;

    //Place the results in XML to return to client
    DocumentBuilderFactory factory =     DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument();

    //Start building the XML to pass back to the AEM client
    Element root = doc.createElement( "results" );
    doc.appendChild( root );

    // iterating over the results
    for (Hit hit : result.getHits()) {
       String path = hit.getPath();
 
      //Create a result element
      Element resultel = doc.createElement( "result" );
      root.appendChild( resultel );

      Element pathel = doc.createElement( "path" );
      pathel.appendChild( doc.createTextNode(path ) );
      resultel.appendChild( pathel );
    }

La même requête exécutée sur HTTP à l’aide du servlet Query Builder (JSON) :

http://localhost:4502/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=Geometrixx&group.1_fulltext.relPath=jcr:content&group.2_fulltext=Geometrixx&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

Stockage et chargement de requêtes

Les requêtes peuvent être stockées dans le référentiel de manière à pouvoir les utiliser ultérieurement. La méthode QueryBuilder fournit la méthode "storeQuery avec la signature suivante :

void storeQuery(Query query, String path, boolean createFile, Session session) throws RepositoryException, IOException;

Lors de l'utilisation de la méthode QueryBuilder#storeQuery, le Query donné est stocké dans le référentiel sous la forme d'un fichier ou d'une propriété conformément à la valeur de l'argument createFile. L'exemple suivant montre comment enregistrer un Query dans le chemin d'accès /mypath/getfiles en tant que fichier :

builder.storeQuery(query, "/mypath/getfiles", true, session);

Toutes les requêtes stockées précédemment peuvent être chargées à partir du référentiel en utilisant la méthode QueryBuilder#loadQuery :

Query loadQuery(String path, Session session) throws RepositoryException, IOException

Par exemple, un Query stocké dans le chemin /mypath/getfiles peut être chargé par le fragment de code suivant :

Query loadedQuery = builder.loadQuery("/mypath/getfiles", session);

Tests et débogage

Pour exécuter et déboguer des requêtes Query Builder, vous pouvez utiliser la console de débogage Query Builder à l’adresse suivante :

http://localhost:4502/libs/cq/search/content/querydebug.html

Une autre solution consiste à utiliser le servlet JSON Query Builder à l’adresse suivante :

http://localhost:4502/bin/querybuilder.json?path=/tmp

( path=/tmp n'est qu'un exemple).

Recommandations générales en matière de débogage

Obtention d’une requête XPath explicable par le biais de la journalisation

Expliquez toutes les requêtes pendant le cycle de développement par rapport au jeu d’index cible.

• Autorisation des journaux DEBUG pour Query Builder afin d’obtenir la requête XPath explicable sous-jacente

  • Accédez à https://<serveraddress>:<serverport>/system/console/slinglog. Créez un nouveau journal pour com.day.cq.search.impl.builder.QueryImpl à DEBUG.

• Une fois que DEBUG a été activé pour la classe ci-dessus, les journaux affichent la requête XPath générée par Query Builder.

• Copiez la requête XPath à partir de l’entrée de journal pour la requête Query Builder associée. Par exemple :

  • com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]

• Collez la requête XPath dans Explication de la Requête en tant que XPath pour obtenir le plan de requête

Obtention de la requête XPath explicable via le débogueur Query Builder

• Utilisez le débogueur AEM Query Builder pour générer une requête XPath explicable :

Expliquez toutes les requêtes pendant le cycle de développement par rapport au jeu d’index cible.

Obtention d’une requête XPath explicable par le biais de la journalisation

• Autorisation des journaux DEBUG pour Query Builder afin d’obtenir la requête XPath explicable sous-jacente

  • Accédez à https://<serveraddress>:<serverport>/system/console/slinglog. Créez un nouveau journal pour com.day.cq.search.impl.builder.QueryImpl à DEBUG.

• Une fois que DEBUG a été activé pour la classe ci-dessus, les journaux affichent la requête XPath générée par Query Builder.

• Copiez la requête XPath à partir de l’entrée de journal pour la requête Query Builder associée. Par exemple :

  • com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]

• Collez la requête XPath dans Explication de la Requête en tant que XPath pour obtenir le plan de requête

Obtention de la requête XPath explicable via le débogueur Query Builder

• Utilisez le débogueur AEM Query Builder pour générer une requête XPath explicable :

1. Indiquez la requête Query Buidler dans le débogueur Query Buidler.
2. Exécutez la recherche.
3. Récupérez la requête XPath générée.
4. Collez la requête XPath dans la Requête d'explication en tant que XPath pour obtenir le plan de requête.

Pour un aperçu du débogage des requêtes avec Query Builder, visionnez la vidéo ci-dessous.

Débogage de requêtes à l’aide de la journalisation

Sortie de journal (niveau INFO) de l’implémentation Query Builder lors de l’exécution de la requête décrite à la section Tests et débogage :

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: limit=20, offset=0[
    {group=group: or=true[
        {1_fulltext=fulltext: fulltext=Geometrixx, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=Geometrixx, relPath=jcr:content/@cq:tags}
    ]}
    {path=path: path=/content}
    {type=type: type=cq:Page}
]
com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]
com.day.cq.search.impl.builder.QueryImpl no filtering predicates
com.day.cq.search.impl.builder.QueryImpl query execution took 69 ms

Dans le cas d’une requête qui utilise des évaluateurs de prédicats qui filtrent ou appliquent un ordre personnalisé par comparateur, cela est également indiqué dans la requête :

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: [
    {nodename=nodename: nodename=*.jar}
    {orderby=orderby: orderby=@jcr:content/jcr:lastModified}
    {type=type: type=nt:file}
]
com.day.cq.search.impl.builder.QueryImpl custom order by comparator: jcr:content/jcr:lastModified
com.day.cq.search.impl.builder.QueryImpl XPath query: //element(*, nt:file)
com.day.cq.search.impl.builder.QueryImpl filtering predicates: {nodename=nodename: nodename=*.jar}
com.day.cq.search.impl.builder.QueryImpl query execution took 272 ms

Liens JavaDoc

Javadoc	Description
com.day.cq.search	API de base de QueryBuilder et de Requête
com.day.cq.search.result	API de résultat
com.day.cq.search.facets	Facettes
com.day.cq.search.facets.buckets	Intervalles (contenus dans les facettes)
com.day.cq.search.eval	Évaluateurs d’attributs
com.day.cq.search.facets.extracteurs	Extracteurs de facettes (pour les évaluateurs)
com.day.cq.search.writer	Auteur d’accès aux résultats JSON pour la servlet Querybuilder (/bin/querybuilder.json?lang=fr)