DocumentaçãoAEM 6.4Guia de desenvolvimento

Referência de predicado do construtor de consultas query-builder-predicate-reference

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor
CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

Geral general

Predicados predicates

boolproperty boolproperty

Corresponde às propriedades BOOLEAN do JCR. Aceita apenas os valores " true" e " false". No caso de " false", corresponderá se a propriedade tiver o valor " false" ou se não existir. Isso pode ser útil para verificar sinalizadores booleanos que são definidos somente quando ativados.

O " herdado operation" não tem significado.

Oferece suporte à extração de facetas. Fornecerá buckets para cada true ou false , mas somente para propriedades existentes.

Propriedades properties

  • boolproperty
    caminho relativo para a propriedade, por exemplo
    myFeatureEnabled ou jcr:content/myFeatureEnabled

  • value
    valor para verificar a propriedade, "
    true" ou " false"

contentfragment contentfragment

Restringe o resultado a fragmentos de conteúdo.

Não suporta filtragem.

Não suporta extração de facetas.

Propriedades properties-1

  • contentfragment
    Ele pode ser usado com qualquer valor para verificar fragmentos de conteúdo.

dateComparison datecomparison

Compara duas propriedades JCR DATE entre si. Pode testar se são iguais, desiguais, maiores ou maiores que ou iguais.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa.

Propriedades properties-2

  • property1

    propriedade path to first date

  • property2

    propriedade path to Second date

  • operação

    " =" para correspondência exata, " !=" para comparação de desigualdade, " >" para propriedade1 maior que propriedade2, " >=" para propriedade1 maior ou igual a propriedade2. O valor padrão é " =".

daterange daterange

Corresponde às propriedades JCR DATE em relação a um intervalo de data/hora. Isso usa a ISO8601
formato para datas e horas ( YYYY-MM-DDTHH:mm:ss.SSSZ) e também permite representações parciais, como YYYY-MM-DD. Como alternativa, o carimbo de data e hora pode ser fornecido como o número de milissegundos desde 1970 no fuso horário UTC, o formato de hora unix.

Você pode procurar qualquer valor entre dois carimbos de data e hora, qualquer valor mais recente ou mais antigo que uma determinada data e também escolher entre intervalos inclusivos e abertos.

Oferece suporte à extração de facetas. Fornecerá baldes "hoje", "esta semana", "este mês", "últimos 3 meses", "este ano", "último ano" e "anterior ao ano passado".

Não suporta filtragem.

Propriedades properties-3

  • propriedade

    caminho relativo para um DATE propriedade , por exemplo jcr:lastModified

  • lowerBound

    limite de data inferior vinculado para verificar a propriedade, por exemplo 2014-10-01

  • lowerOperation

    " >" (mais recente) ou " >=" (em ou mais recente), aplica-se à variável lowerBound. O padrão é " >".

  • upperBound

    limite superior para verificar a propriedade, por exemplo 2014-10-01T12:15:00

  • upperOperation

    " <" (mais antigo) ou " <=" (em ou mais), aplica-se à variável upperBound. O padrão é " <".

  • timeZone

    ID do fuso horário a ser usado quando não for fornecido como uma string de data ISO-8601. O padrão é o fuso horário padrão do sistema.

excludepaths excludepaths

Exclui nós do resultado, onde seu caminho corresponde a uma expressão regular.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa.

Não suporta extração de facetas.

Propriedades properties-4

  • excludepaths

    a expressão regular corresponde aos caminhos de resultado, excluindo os correspondentes do resultado.

texto completo fulltext

Pesquisa termos no índice de texto completo.

Não suporta filtragem.

Não suporta extração de facetas.

Propriedades properties-5

  • texto completo

    os termos de pesquisa de texto completo

  • relPath

    o caminho relativo a ser pesquisado na propriedade ou no subnó . Essa propriedade é opcional.

grupo group

Permite criar condições aninhadas. Os grupos podem conter grupos aninhados. Tudo em um query do querybuilder está implicitamente em um grupo raiz, que pode ter p.or e p.not também.

Exemplo para corresponder uma de duas propriedades a um valor:

group.p.or=true
group.1_property=jcr:title
group.1_property.value=My Page
group.2_property=navTitle
group.2_property.value=My Page

Conceitualmente (1_property OU 2_property).

Exemplo para grupos aninhados:

fulltext=Management
group.p.or=true
group.1_group.path=/content/geometrixx/en
group.1_group.type=cq:Page
group.2_group.path=/content/dam/geometrixx
group.2_group.type=dam:Asset

Isso pesquisa o termo "Gerenciamento" nas páginas em /content/geometrixx/en ou em ativos em /content/dam/geometrixx.

Conceitualmente fulltext AND ( (path AND type) OR (path AND type) ). Esteja ciente de que essas associações OR precisam de bons índices para o desempenho.

Propriedades properties-6

  • p.or

    se definido como " true", apenas um predicado no grupo deve corresponder. O padrão é " false", o que significa que tudo deve corresponder

  • p.not

    se definido como " true", nega o grupo (o padrão é " false")

  • <predicate>

    adiciona predicados aninhados

  • N_<predicate>

    adiciona vários predicados aninhados ao mesmo tempo, como 1_property, 2_property, ...

hasPermission haspermission

Restringe o resultado a itens em que a sessão atual tem o Privilégios JCR.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa. Ele não oferece suporte à extração de facetas.

Propriedades properties-7

  • hasPermission

    privilégios JCR separados por vírgulas que a sessão do usuário atual TODOS devem ter para o nó em questão; por exemplo jcr:write, jcr:modifyAccessControl

idioma language

Encontra páginas CQ em um idioma específico. Isso observa a propriedade de idioma da página e o caminho da página que geralmente inclui o idioma ou o local em uma estrutura de site de nível superior.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa.

Oferece suporte à extração de facetas. Fornecerá compartimentos para cada código de idioma exclusivo.

Propriedades properties-8

  • idioma

    Código de idioma ISO, por exemplo " de"

ativo principal mainasset

Verifica se um nó é um ativo principal do DAM e não um subativo. Basicamente, cada nó não está dentro de um nó "subassets". Observe que isso não verifica a variável dam:Asset tipo de nó. Para usar esse predicado, basta definir " mainasset=true" ou " mainasset=false", não há mais propriedades.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa.

Oferece suporte à extração de facetas. Fornecerá dois buckets para os ativos principais e secundários.

Propriedades properties-9

  • ativo principal

    booleano, " true" para os principais ativos, " false" para subativos

memberOf memberof

Encontra itens que são membros de um coleção de recursos sling.

Este é um predicado somente filtragem e não pode utilizar um índice de pesquisa. Não suporta extração de facetas.

Propriedades properties-10

  • memberOf

    caminho da coleção de recursos do Sling

nodename nodename

Corresponde aos nomes do nó JCR.

Oferece suporte à extração de facetas. Fornecerá buckets para cada nome de nó exclusivo (nome do arquivo).

Propriedades properties-11

  • nodename

    padrão de nome de nó que permite curingas: * = qualquer ou nenhum caractere, ? = qualquer caractere, [abc] = somente caracteres entre colchetes

não textuoso notexpired

Corresponde itens verificando se uma propriedade JCR DATE é maior ou igual ao tempo atual do servidor. Isso pode ser usado para verificar um " expiresAt" curtir a propriedade date e limitar somente àqueles que ainda não expiraram ( notexpired=true) ou que já expiraram ( notexpired=false).

Não suporta filtragem.

Oferece suporte à extração de facetas da mesma forma que o predicado de intervalo de datas.

Propriedades properties-12

  • não textuoso

    booleano, " true" ainda não tiver expirado (data no futuro ou igual), " false" expirado (data anterior) (obrigatório)

  • propriedade

    caminho relativo para DATE propriedade a ser verificada (obrigatório)

orderby orderby

Permite classificar o resultado. Se for necessário solicitar por várias propriedades, esse predicado precisará ser adicionado várias vezes usando o prefixo número, como 1_orderby=first, 2_oderby=second.

Propriedades properties-13

  • orderby

    o nome da propriedade JCR indicado por um @ à esquerda, por exemplo @jcr:lastModified ou @jcr:content/jcr:title, ou outro predicado na consulta, por exemplo 2_property, sobre o qual classificar

  • classificar

    classificar direção, ou " desc" para decrescente ou " asc" para ascendente (padrão)

  • caso

    se definido como " ignore" tornará a classificação não sensível a maiúsculas e minúsculas, o que significa que "a" vem antes de "B"; se estiver vazio ou não, a classificação diferencia maiúsculas de minúsculas, o que significa "B" vem antes de "a"

caminho path

Pesquisa em um determinado caminho.

Não suporta extração de facetas.

Propriedades properties-14

  • caminho

    padrão do caminho; dependendo do exato, a subárvore inteira corresponderá (como anexar) //* no xpath, mas observe que isso não inclui o caminho base) (exato=falso, padrão) ou apenas uma correspondência exata de caminho, que pode incluir curingas ( *); se auto for definido, a subárvore inteira, incluindo o nó base, será pesquisada

  • exato

    if exact é true/on, o caminho exato deve corresponder, mas pode conter curingas simples ( *), que correspondem aos nomes, mas não " /"; se for falso (padrão) todos os descendentes serão incluídos (opcional)

  • plano

    pesquisa apenas os filhos diretos (como anexar " /*" in xpath) (usado somente se ' exact' não é verdadeiro, opcional)

  • self

    pesquisa a subárvore, mas inclui o nó base fornecido como caminho (sem curingas)

propriedade property

Corresponde às propriedades do JCR e seus valores.

Oferece suporte à extração de facetas. Fornecerá buckets para cada valor de propriedade exclusivo nos resultados.

Propriedades properties-15

  • propriedade

    caminho relativo para a propriedade, por exemplo jcr:title

  • valor

    valor para verificar a propriedade; segue o tipo de propriedade JCR para conversões de string

  • N_value

    use 1_value, 2_value, … para verificar vários valores (combinados com OR por padrão, com AND if and=true) (desde 5.3)

  • e

    definido como verdadeiro para a combinação de vários valores ( N_value) com AND (desde 5.3)

  • operação

    " equals" para correspondência exata (padrão), " unequals" para comparação de desigualdade, " like" para usar o jcr:like função xpath (opcional), " not" sem correspondência (por exemplo, " not(@prop)" no xpath, o parâmetro do valor será ignorado) ou " exists" para verificação de existência (o valor pode ser verdadeiro - a propriedade deve existir, o padrão - ou falso - o mesmo que " not")

  • profundidade

    número de níveis de curinga abaixo dos quais a propriedade/caminho relativo pode existir (por exemplo, property=size depth=2 verificará nó/tamanho, nó/*/size e nó/*/*/size)

rangeproperty rangeproperty

Corresponde uma propriedade JCR a um intervalo. Isso se aplica a propriedades com tipos lineares como LONG, DOUBLE e DECIMAL. Para DATE consulte o predicado do intervalo de datas que otimizou a entrada do formato de data.

Você pode definir um limite inferior e um limite superior ou apenas um deles. A operação (por exemplo, "menor que" ou "menor ou igual") também pode ser especificado para limite inferior e superior individualmente.

Não suporta extração de facetas.

Propriedades properties-16

  • propriedade

    caminho relativo para a propriedade

  • lowerBound

    limite inferior para verificar a propriedade para

  • lowerOperation

    " >" (padrão) ou " >=", aplica-se ao lowerValue

  • upperBound

    limite superior para verificar a propriedade para

  • upperOperation

    " <" (padrão) ou " <=", aplica-se ao lowerValue

  • decimal

    " true" se a propriedade verificada for do tipo Decimal

relativedaterange relativedaterange

Corresponde JCR DATE propriedades em relação a um intervalo de data/hora usando deslocamentos de tempo relativos à hora atual do servidor. Você pode especificar lowerBound e upperBound usando um valor de milissegundo ou a sintaxe bugzilla 1s 2m 3h 4d 5w 6M 7y (um segundo, dois minutos, três horas, quatro dias, cinco semanas, seis meses, sete anos). Prefixo com " -" para indicar um deslocamento negativo antes do tempo atual. Se você especificar somente lowerBound ou upperBound, o outro assumirá 0 como padrão, o que significa a hora atual.

Por exemplo:

  • upperBound=1h e não lowerBound) selecionaria qualquer coisa na próxima hora
  • lowerBound=-1d e não upperBound) selecionaria qualquer coisa nas últimas 24 horas
  • lowerBound=-6M e upperBound=-3M selecionaria qualquer coisa entre 6 meses e 3 meses
  • lowerBound=-1500 e upperBound=5500 selecionaria algo entre 1500 milissegundos no passado e 5500 milissegundos no futuro
  • lowerBound=1d e upperBound=2d selecionaria qualquer coisa no dia depois de amanhã

Observe que não leva anos bissextos em consideração e todos os meses são 30 dias.

Não suporta filtragem.

Oferece suporte à extração de facetas da mesma forma que o predicado de intervalo de datas.

Propriedades properties-17

  • upperBound

    limite de data superior em milissegundos ou 1s 2m 3h 4d 5w 6M 7y (um segundo, dois minutos, três horas, quatro dias, cinco semanas, seis meses, sete anos) em relação ao tempo atual do servidor, use "-" para deslocamento negativo

  • lowerBound

    limite de data inferior em milissegundos ou 1s 2m 3h 4d 5w 6M 7y (um segundo, dois minutos, três horas, quatro dias, cinco semanas, seis meses, sete anos) em relação ao tempo atual do servidor, use "-" para deslocamento negativo

root root

Grupo de predicado raiz. Suporta todos os recursos de um grupo e permite definir parâmetros de consulta global.

O nome "raiz" nunca é usado em um query, está implícito.

Propriedades properties-18

  • p.offset

    número que indica o início da página de resultados, ou seja, quantos itens ignorar

  • p.limit

    número que indica o tamanho da página

  • p.guessTotal

    recomendado: evitar calcular o total dos resultados que podem ser onerosos; um número que indica o total máximo para contar até (por exemplo, 1000, um número que dá aos usuários feedback suficiente sobre o tamanho bruto e números exatos para resultados menores) ou " true" para contar apenas até o mínimo necessário p.offset + p.limit

  • p.excerto

    se definido como " true", incluir trecho de texto completo no resultado

  • p.hits

    (somente para o servlet JSON) selecione a maneira como as ocorrências são gravadas como JSON, com essas ocorrências padrão (extensíveis por meio do serviço ResultHitWriter):

    • simples:

      itens mínimos como path, title, lastmodified, excerpt (se definido)

    • completo:

      renderização Sling JSON do nó, com jcr:path indicando o caminho da ocorrência: por padrão, apenas lista as propriedades diretas do nó, e inclui uma árvore mais profunda com p.nodedepth=N, com 0 significando a subárvore inteira e infinita; adicionar p.acls=true para incluir as permissões JCR da sessão atual no item de resultado fornecido (mapeamentos: create = add_node, modify = set_property, delete = remove)

    • seletivo:

      somente as propriedades especificadas em p.properties, que é uma lista separada por espaços (use "+" em URLs) de caminhos relativos; se o caminho relativo tiver uma profundidade > 1, eles serão representados como objetos filhos; a propriedade especial jcr:path inclui o caminho da ocorrência

savedquery savedquery

Inclui todos os predicados de uma consulta persistente do querybuilder na consulta atual como um predicado de subgrupo.

Observe que isso não executará uma query extra, mas estenderá a query atual.

As consultas podem ser mantidas programaticamente usando QueryBuilder#storeQuery(). O formato pode ser uma propriedade de sequência de caracteres de várias linhas ou uma nt:file nó que contém a consulta como um arquivo de texto no formato de propriedades Java.

Não suporta extração de facetas para os predicados da consulta salva.

Propriedades properties-19

  • savedquery

    caminho para a consulta salva (propriedade String ou nt:file node)

semelhante similar

Pesquisa de similaridade usando o JCR XPath rep:similar().

Não suporta filtragem. Não suporta extração de facetas.

Propriedades properties-20

  • semelhante
    caminho absoluto para o nó para o qual encontrar nós semelhantes

  • local
    um caminho relativo para um nó descendente ou
    . para o nó atual (opcional, o padrão é " .")

tag tag

Pesquisa por conteúdo marcado com uma ou mais tags, especificando caminhos de título de tag.

Oferece suporte à extração de facetas. Fornecerá buckets para cada tag única, usando seu caminho de título de tag atual.

Propriedades properties-21

  • tag

    caminho do título da tag a ser procurado, por exemplo "Propriedades do ativo : Orientação / Paisagem"

  • N_value

    use 1_value, 2_value, … para verificar várias tags (combinadas com OR por padrão, com AND if and=true) (desde 5.6)

  • propriedade

    propriedade (ou caminho relativo para a propriedade) a ser analisada (padrão) cq:tags")

tagid tagid

Pesquisa por conteúdo marcado com uma ou mais tags, especificando IDs de tags.

Oferece suporte à extração de facetas. Fornecerá buckets para cada tag exclusiva, usando sua ID de tag atual.

Propriedades properties-22

  • tagid

    id da tag a ser procurada, por exemplo " properties:orientation/landscape"

  • N_value

    use 1_value, 2_value, … para verificar vários tagids (combinados com OR por padrão, com AND if and=true) (desde 5.6)

  • propriedade

    propriedade (ou caminho relativo para a propriedade) a ser analisada (padrão) cq:tags")

tagsearch tagsearch

Pesquisa por conteúdo marcado com uma ou mais tags, especificando palavras-chave. Isso primeiro pesquisará tags que contenham essas palavras-chave em seus títulos e, em seguida, restringirá o resultado somente a itens marcados com elas.

Não suporta extração de facetas.

Propriedades Properties-1

  • tagsearch

    palavra-chave a ser pesquisada em títulos de tag

  • propriedade

    propriedade (ou caminho relativo para a propriedade) a ser analisada (padrão) cq:tags")

  • lang

    para pesquisar somente um determinado título de tag localizado (por exemplo, " de")

  • todas

    (bool) pesquisar todo o texto completo da tag, ou seja, todos os títulos, descrição etc. (tem precedência sobre "l ang")

tipo type

Restringe os resultados a um tipo de nó JCR específico, tanto o tipo de nó primário como o tipo mixin. Isso também encontrará subtipos desse tipo de nó. Observe que os índices de pesquisa do repositório precisam abranger os tipos de nó para uma execução eficiente.

Oferece suporte à extração de facetas. Fornecerá compartimentos para cada tipo exclusivo nos resultados.

Propriedades Properties-2

  • tipo

    tipo de nó ou nome mixin a ser procurado, por exemplo cq:Page

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e