Referência de predicado do construtor de consultas

Última atualização em 2023-12-05

Geral

raiz

O grupo de predicados raiz. Suporta todos os recursos de um grupo e permite a definição de parâmetros de consulta globais.

O nome "raiz" nunca é usado em uma consulta; ele está implícito.

Propriedades

  • p.offset - número que indica o início da página de resultados, ou seja, quantos itens devem ser ignorados.
  • p.limit - número que indica o tamanho da página.
  • p.guessTotal - recomendado: evite calcular o total do resultado completo, que pode ser caro. Um número que indica o total máximo para contar até (por exemplo, 1000, um número que fornece aos usuários feedback suficiente sobre o tamanho bruto e números exatos para resultados menores). Ou, true para contar somente até o mínimo necessário p.offset + p.limit.
  • p.excerpt - se definido como true, incluir trecho de texto completo no resultado.
  • p.indexTag - se definido, incluirá uma opção de tag de índice na consulta (consulte Tag de Índice de Opção de Consulta).
  • p.facetStrategy - se definido como oak, o Query Builder delegará a extração de facetas ao Oak (consulte Facetas).
  • p.hits - (somente para o servlet JSON) selecione a forma como as ocorrências são gravadas como JSON, com essas padrão (extensível por meio do serviço ResultHitWriter).
    • simple - mínimo de itens como path, title, lastmodified, excerpt (se definido).
    • full - renderização Sling JSON do nó, com jcr:path indicando o caminho da ocorrência. Por padrão, o apenas lista as propriedades diretas do nó, 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).
    • selective - somente as propriedades especificadas em p.properties, que é um espaço separado (use + em URLs) de caminhos relativos. Se o caminho relativo tiver uma profundidade >1, essas propriedades são representadas como objetos filho. O programa jcr:path propriedade inclui o caminho da ocorrência.

grupo

Esse predicado permite criar condições aninhadas. Os grupos podem conter grupos aninhados. Tudo em uma consulta do Construtor de consultas está implicitamente em um grupo raiz, que pode ter p.or e p.not também.

Este é um exemplo para corresponder uma das 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).

Veja a seguir um exemplo de grupos aninhados:

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

Pesquisa o termo Gerenciamento nas páginas em /content/wknd/ch/de ou em ativos no /content/dam/wknd.

Conceitualmente, é fulltext AND ( (path AND type) OR (path AND type) ). Essas associações OR precisam de bons índices por motivos de desempenho.

Propriedades

  • p.or - se definido como true, somente um predicado no grupo deve corresponder a. O padrão é false, o que significa que todos devem corresponder
  • p.not - se definido como true, ele 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, ...

orderby

Este predicado permite classificar os resultados. Se a ordenação por várias propriedades for necessária, esse predicado deverá ser adicionado várias vezes usando o prefixo numérico, como 1_orderby=first, 2_oderby=second.

Propriedades

  • 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, no qual classificar
  • sort - direção da classificação, ou desc para decrescente ou asc para crescente (padrão)
  • case - se definido como ignore, faz com que a classificação não diferencie maiúsculas de minúsculas, ou seja, a vem antes B; se estiver vazia ou for omitida, a classificação diferencia maiúsculas de minúsculas, o que significa B vem antes a

Predicados

boolproperty

Este predicado corresponde às propriedades booleanas do JCR. Aceita apenas os valores true e false. Se o valor for false, corresponde se a propriedade tiver o valor falseou se não existir. Esse predicado é útil para verificar se há sinalizadores booleanos que só são definidos quando ativados.

O herdado operation parâmetro não tem significado.

Este predicado suporta a extração de facetas e fornece intervalos para cada true ou false mas somente para propriedades existentes.

Propriedades

  • boolproperty - caminho relativo para a propriedade, por exemplo, myFeatureEnabled ou jcr:content/myFeatureEnabled
  • value - valor para verificar a propriedade, true ou false

contentfragment

Esse predicado restringe o resultado aos fragmentos de conteúdo.

  • Ela não oferece suporte à filtragem.
  • Não há suporte para extração de facetas.

Propriedades

  • contentfragment - Pode ser usado com qualquer valor para verificar fragmentos de conteúdo.

dateComparison

Esse predicado compara duas propriedades de data JCR entre si. É possível testar se eles são iguais, desiguais, maiores ou maiores ou iguais.

Um predicado somente de filtragem e não pode usar um índice de pesquisa.

Propriedades

  • property1 - caminho para a propriedade da primeira data
  • property2 - caminho para a propriedade da segunda data
  • operation
    • = para correspondência exata (padrão)
    • != para comparação de desigualdade
    • > para property1 maior que property2
    • >= para property1 maior que ou igual a property2

intervalo de datas

Esse predicado corresponde às propriedades de data do JCR em relação a um intervalo de data/hora. Usa o formato ISO8601 para datas e horas (YYYY-MM-DDTHH:mm:ss.SSSZ) e permite também representações parciais, como YYYY-MM-DD. Como alternativa, o carimbo de data e hora pode ser fornecido como hora POSIX.

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

Ela suporta extração de facetas e fornece compartimentos today, this week, this month, last 3 months, this year, last year, e earlier than last year.

Ela não oferece suporte à filtragem.

Propriedades

  • property - caminho relativo para um DATE propriedade, por exemplo, jcr:lastModified
  • lowerBound - data inferior vinculada para verificar a propriedade, por exemplo, 2014-10-01
  • lowerOperation - > (mais recente) ou >= (em ou mais recente), aplica-se à 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 antigo), aplica-se à upperBound. O padrão é <
  • timeZone - ID do fuso horário a ser usada quando não for fornecida como uma string de data ISO-8601. O padrão é o fuso horário padrão do sistema.

excludepaths

Esse predicado exclui nós do resultado em que seu caminho corresponde a uma expressão regular.

Um predicado somente de filtragem e não pode usar um índice de pesquisa.

Não há suporte para extração de facetas.

Propriedades

  • excludepaths - expressão regular correspondente aos caminhos de resultados, excluindo os correspondentes do resultado.

texto completo

Pesquisa por termos no índice de texto completo.

Ela não oferece suporte à filtragem.

Não há suporte para extração de facetas.

Propriedades

  • fulltext - os termos de pesquisa de texto completo
  • relPath - o caminho relativo para pesquisar na propriedade ou no subnó. Essa propriedade é opcional.

hasPermission

Este predicado restringe o resultado a itens nos quais a sessão atual tem o valor especificado Privilégios JCR.

Um predicado somente de filtragem e não pode usar um índice de pesquisa. Não há suporte para extração de facetas.

Propriedades

  • hasPermission - todos os privilégios JCR separados por vírgulas que a sessão do usuário atual deve ter para o nó em questão. Por exemplo, jcr:write, jcr:modifyAccessControl

idioma

Esse predicado encontra páginas AEM em um idioma específico. Ela verifica 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.

Um predicado somente de filtragem e não pode usar um índice de pesquisa.

Ela oferece suporte à extração de facetas e a intervalos para cada código de idioma exclusivo.

Propriedades

  • language - código ISO de idioma, por exemplo, de

principal ativo

Esse predicado verifica se um nó é um ativo principal do DAM e não um subativo. Basicamente, cada nó não está dentro de um nó sub assets. Ele não verifica a dam:Asset tipo de nó. Para usar este predicado, defina mainasset=true ou mainasset=false. Não há mais propriedades.

Um predicado somente de filtragem e não pode usar um índice de pesquisa.

Ela oferece suporte à extração de facetas e fornece dois buckets para ativos principais e secundários.

Propriedades

  • mainasset - booleano, true para os ativos principais, false para subativos

memberOf

Esse predicado encontra itens que são membros de um coleção de recursos do sling.

Um predicado somente de filtragem e não pode usar um índice de pesquisa.

Não há suporte para extração de facetas.

Propriedades

  • memberOf - caminho da coleção de recursos do Sling

nodename

Esse predicado corresponde aos nomes de nó do JCR.

Ela oferece suporte à extração de facetas e buckets para cada nome de nó único (nome de arquivo).

Propriedades

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

não expirado

Esse predicado corresponde a itens, verificando se uma propriedade de data JCR é maior ou igual à hora atual do servidor. Ele pode ser usado para verificar um expiresAt e limita os resultados apenas aos valores que ainda não expiraram (notexpired=true) ou que já expiraram (notexpired=false).

Ela não oferece suporte à filtragem.

Ela suporta a extração de facetas da mesma forma que a daterange predicado.

Propriedades

  • notexpired - booleano, true para ainda não expirado (data futura ou igual), false para expirados (data no passado) (obrigatório)
  • property - caminho relativo para o DATE propriedade a ser verificada (obrigatório)

caminho

Esse predicado pesquisa em um determinado caminho.

Não há suporte para extração de facetas.

Propriedades

  • path - Define o padrão do caminho.
    • Dependendo do exact propriedade, a subárvore inteira corresponde (como anexar //* no xpath, mas observe que não inclui o caminho base), ou apenas um caminho exato é correspondido, que pode incluir curingas (*).
      • O padrão é true.
        <!— * Se a variável selffor definida, toda a subárvore, incluindo o nó base, será pesquisada.—>
  • exact - se exact é true, o caminho exato deve corresponder, mas pode conter curingas simples (*), que correspondem a nomes, mas não /; se for false (padrão) todos os descendentes são incluídos (opcional).
  • flat - pesquisa somente os filhos diretos (como anexar /* em xpath) (usado somente se exact não é verdadeiro, opcional).
  • self - pesquisa a subárvore, mas inclui o nó base fornecido como caminho (sem curingas).
    • Observação importante: Um problema foi identificado com self a propriedade na implementação atual do construtor de consultas e usá-la em consultas pode não produzir resultados de pesquisa corretos. Alteração da implementação atual do self A propriedade também não é viável porque pode quebrar os aplicativos existentes que dependem dela. Devido a essa funcionalidade, self propriedade agora está obsoleta; recomenda-se evitar usá-la.

propriedade

Esse predicado corresponde às propriedades do JCR e seus valores.

Ela oferece suporte à extração de facetas e fornece compartimentos para cada valor de propriedade exclusivo nos resultados.

Propriedades

  • property - caminho relativo para a propriedade, por exemplo, jcr:title.
  • value - valor para verificar a propriedade; segue o tipo de propriedade JCR para conversões de sequência.
  • N_value - utilizar 1_value, 2_value, … para verificar se há vários valores (combinados com OR por padrão, com AND se and=true).
  • and - defina como true para combinar vários valores (N_value) com AND
  • operation
    • equals para correspondência exata (padrão).
    • unequals para comparação de desigualdade.
    • like para usar o jcr:like função xpath (opcional).
    • not para nenhuma correspondência (por exemplo, not(@prop) em xpath, o parâmetro value é ignorado).
    • exists para verificação de existência.
      • true a propriedade deve existir.
      • false é o mesmo que not e é o padrão.
  • depth - número de níveis curingas abaixo dos quais a propriedade/caminho relativo pode existir (por exemplo, property=size depth=2 cheques node/size, node/*/size, e node/*/*/size).

rangeproperty

Este predicado corresponde a uma propriedade JCR em relação a um intervalo. Ela se aplica a propriedades com tipos lineares, como LONG, DOUBLE, e DECIMAL. Para DATE, consulte o daterange predicado que otimizou a entrada de formato de data.

Você pode definir um limite inferior, um limite superior ou ambos. A operação (por exemplo, menor que ou menor que ou igual a) também pode ser especificada para limites inferior e superior individualmente.

Não há suporte para extração de facetas.

Propriedades

  • property - caminho relativo para a propriedade
  • lowerBound - limite inferior para verificar propriedade
  • lowerOperation - > (padrão) ou >=, aplica-se à lowerValue
  • upperBound - limite superior para verificar a propriedade
  • upperOperation - < (padrão) ou <=, aplica-se à lowerValue
  • decimal - true se a propriedade marcada for do tipo Decimal

relativedaterange

Este predicado corresponde a JCR DATE propriedades em 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). Prefixar com - para indicar um deslocamento negativo antes da hora atual. Se você especificar apenas lowerBound ou upperBound, o outro toma como padrão 0, representando a hora atual.

Por exemplo:

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

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

Ela não oferece suporte à filtragem.

Ela suporta a extração de facetas da mesma forma que a daterange predicado.

Propriedades

  • upperBound - limite superior de data 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 à hora atual do servidor, use - para compensação negativa
  • lowerBound - data inferior associada 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 à hora atual do servidor, use - para compensação negativa

savedquery

Esse predicado inclui todos os predicados de uma consulta persistente do Construtor de consultas na consulta atual como um predicado de subgrupo.

Ela não executa uma consulta extra, mas estende a consulta atual.

As consultas podem ser persistentes de forma programática usando QueryBuilder#storeQuery(). O formato pode ser multilinha String propriedade ou um nt:file nó que contém a consulta como um arquivo de texto no formato de propriedades Java™.

Não há suporte para extração de facetas para os predicados da consulta salva.

Propriedades

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

semelhante

Este predicado é uma pesquisa de semelhança usando JCR XPath's rep:similar().

Ela não oferece suporte à filtragem e à extração de facetas.

Propriedades

  • similar - caminho absoluto para o nó para o qual localizar nós semelhantes
  • local - um caminho relativo para um nó descendente ou . para o nó atual (opcional, o padrão é .)

tag

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

Ele oferece suporte à extração de facetas e fornece compartimentos para cada tag exclusiva, usando o caminho do título da tag atual.

Propriedades

  • tag - caminho do título da tag a ser procurado, por exemplo, properties:orientation/landscape
  • N_value - utilizar 1_value, 2_value, … para verificar se há várias tags (combinadas com OR por padrão, com AND se and=true)
  • property - propriedade (ou caminho relativo para a propriedade) a ser observada (padrão cq:tags)

tagid

Esse predicado pesquisa por conteúdo marcado com uma ou mais tags, especificando IDs de tag.

Ela é compatível com a extração de facetas e fornece compartimentos para cada tag exclusiva, usando a ID de tag atual.

Propriedades

  • tagid - ID da tag a ser procurada, por exemplo, properties:orientation/landscape
  • N_value - utilizar 1_value, 2_value, … para verificar se há várias IDs de tag (combinadas com OR por padrão, com AND se and=true)
  • property - propriedade (ou caminho relativo para a propriedade) a ser observada (padrão cq:tags)

tagsearch

Esse predicado pesquisa por conteúdo marcado com uma ou mais tags, especificando palavras-chave. Ela procura primeiro por tags contendo essas palavras-chave em seus títulos e, em seguida, restringe o resultado a apenas itens marcados com essas palavras-chave.

Não há suporte para extração de facetas.

Propriedades

  • tagsearch - palavra-chave para procurar em títulos de tags
  • property - propriedade (ou caminho relativo para a propriedade) a ser considerada (padrão cq:tags)
  • lang - para pesquisar apenas um determinado título de tag localizado (por exemplo, de)
  • all - valor booleano para pesquisar todo o texto completo da tag, ou seja, todos os títulos, descrições e assim por diante (tem precedência sobre lang)

tipo

Esse predicado restringe os resultados a um tipo de nó JCR específico, tanto tipos de nó primário quanto mixin tipos. Ele também encontra subtipos desse tipo de nó. Os índices de pesquisa do repositório devem abranger os tipos de nó para uma execução eficiente.

Ela suporta a extração de facetas e fornece intervalos para cada tipo único nos resultados.

Propriedades

  • type - tipo de nó ou mixin nome a ser pesquisado, por exemplo, cq:Page

Nesta página