Creazione di tag in un'applicazione AEM

Per lavorare in modo programmatico con i tag o estendere i tag all'interno di un'applicazione di AEM personalizzata, questa pagina descrive l'utilizzo del

• API di assegnazione tag

che interagisce con

• Framework di assegnazione tag

Per informazioni correlate sull’assegnazione tag, consulta :

• Amministrazione di tag per informazioni sulla creazione e la gestione dei tag e sui tag di contenuto applicati.
• Utilizzo dei tag per informazioni sull’assegnazione tag al contenuto.

Panoramica dell’API di assegnazione tag

L’implementazione del framework di assegnazione tag in AEM consente di gestire tag e contenuti di tag utilizzando l’ API JCR . TagManager assicura che i tag immessi come valori nella proprietà della matrice di stringhe cq:tags non siano duplicati, rimuove gli ID tag che puntano a tag non esistenti e aggiorna gli ID tag per i tag spostati o uniti. TagManager utilizza un listener di osservazione JCR che ripristina eventuali modifiche errate. Le classi principali sono nel pacchetto com.day.cq.tagging :

• JcrTagManagerFactory - restituisce un'implementazione basata su JCR di un TagManager. È l’implementazione di riferimento dell’API di assegnazione tag.
• TagManager - consente di risolvere e creare tag in base a percorsi e nomi.
• Tag - definisce l’oggetto tag .

Ottenere un TagManager basato su JCR

Per recuperare un'istanza TagManager, è necessario disporre di un JCR Session e chiamare getTagManager(Session):

@Reference
JcrTagManagerFactory jcrTagManagerFactory;

TagManager tagManager = jcrTagManagerFactory.getTagManager(session);

Nel contesto Sling tipico è anche possibile adattarsi a un TagManager dal ResourceResolver:

TagManager tagManager = resourceResolver.adaptTo(TagManager.class);

Recupero di un oggetto Tag

È possibile recuperare un tag Tag tramite TagManager, risolvendo un tag esistente o creandone uno nuovo:

Tag tag = tagManager.resolve("my/tag"); // for existing tags

Tag tag = tagManager.createTag("my/tag"); // for new tags

Per l’implementazione basata su JCR, che mappa Tags su JCR Nodes, puoi utilizzare direttamente il meccanismo Sling adaptTo se disponi della risorsa (ad esempio /content/cq:tags/default/my/tag):

Tag tag = resource.adaptTo(Tag.class);

Mentre un tag può essere convertito solo *da *una risorsa (non un nodo), un tag può essere convertito *sia in un nodo che in una risorsa :

Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);

Ottenere e impostare i tag

// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource); 

// Setting tags to a Resource:
tagManager.setTags(resource, tags);

Ricerca di tag

// 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);

Eliminazione dei tag

tagManager.deleteTag(tag);

Replicazione dei tag

È possibile utilizzare il servizio di replica ( Replicator) con i tag perché i tag sono di tipo nt:hierarchyNode:

replicator.replicate(session, replicationActionType, tagPath);

Assegnazione tag sul lato client

CQ.tagging.TagInputField è un widget modulo per l’immissione di tag. Dispone di un menu a comparsa per la selezione tra i tag esistenti, include il completamento automatico e molte altre funzioni. Il relativo xtype è tags.

Tag Garbage Collector

Il tag garbage Collector è un servizio di background che pulisce i tag nascosti e inutilizzati. I tag nascosti e non utilizzati sono tag inferiori a /content/cq:tags che hanno una proprietà cq:movedTo e non vengono utilizzati su un nodo di contenuto; il conteggio è pari a zero. Utilizzando questo processo di eliminazione lento, il nodo del contenuto (ovvero la proprietà cq:tags ) non deve essere aggiornato come parte dell'operazione di spostamento o unione. I riferimenti nella proprietà cq:tags vengono aggiornati automaticamente quando la proprietà cq:tags viene aggiornata, ad esempio tramite la finestra di dialogo delle proprietà della pagina.

Il Garbage Collector dei tag viene eseguito per impostazione predefinita una volta al giorno. Puoi configurarlo in:

http://localhost:4502/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

Ricerca tag ed elenco tag

La ricerca di tag e l’elenco dei tag funzionano come segue:

• La ricerca di TagID cerca i tag per i quali la proprietà cq:movedTo è impostata su TagID e segue i tag cq:movedTo TagIDs.

• La ricerca di Titolo tag cerca solo i tag che non hanno una proprietà cq:movedTo .

Tag in diverse lingue

Come descritto nella documentazione relativa all’amministrazione dei tag, nella sezione Gestione dei tag in diverse lingue è possibile definire un tag titlein diverse lingue. Al nodo del tag viene quindi aggiunta una proprietà sensibile alla lingua. Questa proprietà ha il formato jcr:title.<locale>, ad esempio jcr:title.fr per la traduzione in francese. <locale> deve essere una stringa internazionale ISO in minuscolo e utilizzare "_" invece di "-", ad esempio: de_ch.

Quando il tag Animals viene aggiunto alla pagina Products , il valore stockphotography:animals viene aggiunto alla proprietà cq:tags del nodo /content/geometrixx/en/products/jcr:content. La traduzione viene referenziata dal nodo del tag.

L'API lato server dispone di metodi localizzati relativi a title:

• com.day.cq.tagging.Tag

  • getLocalizedTitle(Impostazioni internazionali)
  • getLocalizedTitlePaths()
  • getLocalizedTitles()
  • getTitle(Impostazioni internazionali)
  • getTitlePath(Impostazioni internazionali)

• com.day.cq.tagging.TagManager

  • canCreateTagByTitle(String tagTitlePath, locale)
  • createTagByTitle(Stringa tagTitlePath, Impostazioni internazionali)
  • resolveByTitle(String tagTitlePath, locale)

In AEM, la lingua può essere ottenuta dalla lingua della pagina o dalla lingua dell’utente:

• per recuperare la lingua della pagina in un JSP:

  • currentPage.getLanguage(false)

• per recuperare la lingua utente in un JSP:

  • slingRequest.getLocale()

currentPage e slingRequest sono disponibili in un JSP attraverso il <cq:definedobjects> tag .

Per l’assegnazione tag, la localizzazione dipende dal contesto in cui il tag titlespuò essere visualizzato nella lingua della pagina, nella lingua dell’utente o in qualsiasi altra lingua.

Aggiunta di una nuova lingua alla finestra di dialogo Modifica tag

La procedura seguente descrive come aggiungere una nuova lingua (finlandese) alla finestra di dialogo Tag Edit :

1. In CRXDE, modifica la proprietà multivalore languages del nodo /content/cq:tags.

2. Aggiungi fi_fi , che rappresenta le impostazioni internazionali finlandesi, e salva le modifiche.

La nuova lingua (finlandese) è ora disponibile nella finestra di dialogo dei tag delle proprietà della pagina e nella finestra di dialogo Modifica tag durante la modifica di un tag nella console Tagging .