Para a finalidade de trabalhar programaticamente com tags ou estender tags em um aplicativo AEM personalizado, este documento descreve o uso da variável
que interage com o
Para obter informações relacionadas à marcação:
A implementação da estrutura de marcação no AEM permite o gerenciamento de tags e conteúdo de tags usando a API JCR. TagManager
garante que as tags digitadas como valores na propriedade da matriz de cq:tags
string não sejam duplicadas, ela remove TagID
as tags apontadas para tags e atualizações não existentes TagID
para tags movidas ou unidas. TagManager
usa um ouvinte de observação JCR que reverte quaisquer alterações incorretas. As classes principais estão no pacote com.day.cq.tagging:
JcrTagManagerFactory
- retorna uma implementação de uma TagManager
. É a implementação de referência da API de marcação.TagManager
- permite resolver e criar tags por caminhos e nomes.Tag
- define o objeto de tag.Para recuperar uma instância TagManager
, é necessário ter um JCR Session
e chamar getTagManager(Session)
:
@Reference
JcrTagManagerFactory jcrTagManagerFactory;
TagManager tagManager = jcrTagManagerFactory.getTagManager(session);
No contexto Sling típico, você também pode se adaptar a TagManager
a partir de ResourceResolver
:
TagManager tagManager = resourceResolver.adaptTo(TagManager.class);
Um Tag
pode ser recuperado por meio de TagManager
, resolvendo uma tag existente ou criando uma nova:
Tag tag = tagManager.resolve("my/tag"); // for existing tags
Tag tag = tagManager.createTag("my/tag"); // for new tags
Para a implementação baseada em JCR, que mapeia Tags
para o JCR Nodes
, você pode usar diretamente o mecanismo adaptTo
do Sling se tiver o recurso (por exemplo, /content/cq:tags/default/my/tag
):
Tag tag = resource.adaptTo(Tag.class);
Embora uma tag só possa ser convertida de um recurso (não um nó), uma tag pode ser convertida para tanto em um nó como em um recurso:
Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
Não é possível adaptar diretamente de Node
para Tag
, porque Node
não implementa o método Sling Adaptable.adaptTo(Class)
.
// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);
// Setting tags to a Resource:
tagManager.setTags(resource, tags);
// Searching for the Resource objects that are tagged with the tag object:
Iterator<Resource> it = tag.find();
// Retrieving the usage count of the tag object:
long count = tag.getCount();
// Searching for the Resource objects that are tagged with the tagID String:
RangeIterator<Resource> it = tagManager.find(tagID);
O RangeIterator
válido a ser usado é:
com.day.cq.commons.RangeIterator
tagManager.deleteTag(tag);
É possível usar o serviço de replicação (Replicator
) com tags, pois elas são do tipo nt:hierarchyNode
:
replicator.replicate(session, replicationActionType, tagPath);
O coletor de lixo de tags é um serviço em segundo plano que limpa as tags que estão ocultas e não são usadas. As tags ocultas e não usadas são tags abaixo de /content/cq:tags
que têm uma propriedade cq:movedTo
e não são usadas em um nó de conteúdo. Eles têm uma contagem zero. Ao usar esse processo de exclusão lento, o nó de conteúdo (ou seja, a propriedade cq:tags
) não precisa ser atualizado como parte da operação de movimentação ou mesclagem. As referências na propriedade cq:tags
são atualizadas automaticamente quando a propriedade cq:tags
é atualizada, por exemplo, por meio da caixa de diálogo de propriedades da página.
O coletor de lixo da tag é executado por padrão uma vez por dia. Isso pode ser configurado em:
http://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector
A pesquisa por tags e a listagem de tags funcionam da seguinte maneira:
TagID
pesquisa as tags que têm a propriedade cq:movedTo
definida como TagID
e segue por cq:movedTo
TagID
s.cq:movedTo
.Uma tag title
pode ser definida em idiomas diferentes. Uma propriedade sensível ao idioma é então adicionada ao nó da tag. Essa propriedade tem o formato jcr:title.<locale>
, por exemplo, jcr:title.fr
para a tradução em francês. <locale>
deve ser uma sequência de caracteres de localidade ISO em minúsculas e usar sublinhado (_
) em vez de hífen/traço (-
), por exemplo: de_ch
.
Por exemplo, quando a tag Animais é adicionada à página Produtos, o valor stockphotography:animals
é adicionado à propriedade cq:tags
do nó /content/wknd/en/products/jcr:content
. A tradução é referenciada a partir do nó da tag.
A API do lado do servidor localizou title
métodos relacionados:
com.day.cq.tagging.Tag
getLocalizedTitle(Locale locale)
getLocalizedTitlePaths()
getLocalizedTitles()
getTitle(Locale locale)
getTitlePath(Locale locale)
com.day.cq.tagging.TagManager
canCreateTagByTitle(String tagTitlePath, Locale locale)
createTagByTitle(String tagTitlePath, Locale locale)
resolveByTitle(String tagTitlePath, Locale locale)
Em AEM, o idioma pode ser obtido do idioma da página ou do idioma do usuário.
Para marcação, a localização depende do contexto, já que a tag titles
pode ser exibida no idioma da página, no idioma do usuário ou em qualquer outro idioma.
O procedimento a seguir descreve como adicionar um novo idioma (por exemplo, finlandês) à caixa de diálogo Editar tag:
languages
do nó /content/cq:tags
.fi_fi
, que representa a localidade finlandesa, e salve as alterações.O finlandês agora está disponível na caixa de diálogo de tags das propriedades da página e na caixa de diálogo Editar tag ao editar uma tag no console Marcação.
O novo idioma precisa ser um dos idiomas reconhecidos AEM, ou seja, precisa estar disponível como um nó abaixo de /libs/wcm/core/resources/languages
.