Einbinden von Tagging in AEM-Programme

Zum Zwecke von programmatischem Arbeiten mit Tags oder zum Erweitern von Tags in einem benutzerdefinierten AEM-Programm wird in diesem Dokument die Verwendung der

• Tagging-API,

die mit dem

• Tagging-Framework interagiert, beschrieben.

Weitere Informationen zum Tagging finden Sie unter:

• Weitere Informationen zum Tagging von Inhalten als Inhaltsersteller finden Sie unter Verwenden von Tags.
• Informationen zur Erstellung und Verwaltung von Tags durch Admins sowie dazu, welchen Inhalten Tags zugewiesen werden, finden Sie unter „Verwalten von Tags“.

Übersicht über die Tagging-API

Die Implementierung des Tagging-Frameworks in AEM ermöglicht die Verwaltung von Tags und Tag-Inhalten mithilfe der JCR-API. TagManager stellt sicher, dass Tags, die als Werte in der cq:tagsString-Array-Eigenschaft eingegeben wurden, nicht dupliziert werden. Er entfernt TagID, die auf nicht vorhandene Tags verweisen, und aktualisiert TagIDfür verschobene oder zusammengefügte Tags. TagManager verwendet einen JCR Observation Listener, der alle falschen Änderungen zurückgesetzt. Die wichtigsten Klassen befinden sich im Paket com.day.cq.tagging:

• JcrTagManagerFactory – gibt eine JCR-basierte Implementierung eines TagManagers zurück. Es ist die Referenzimplementierung der Tagging-API.
• TagManager – ermöglicht das Auflösen und Erstellen von Tags nach Pfaden und Namen.
• Tag - definiert das Tag-Objekt.

Abrufen eines JCR-basierten TagManagers

Um eine TagManager-Instanz abzurufen, benötigen Sie eine JCR-Session und Sie müssen getTagManager(Session) aufrufen:

@Reference
JcrTagManagerFactory jcrTagManagerFactory;

TagManager tagManager = jcrTagManagerFactory.getTagManager(session);

Im typischen Sling-Kontext können Sie sich auch mit dem TagManager an einen ResourceResolver anpassen:

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

Abrufen eines Tag-Objekts

A Tag kann über die TagManager, indem Sie entweder ein vorhandenes Tag auflösen oder eines erstellen:

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

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

Für die JCR-basierte Implementierung, die Tags auf JCR-Nodes abbildet, können Sie den Mechanismus adaptTo von Sling direkt verwenden, wenn Sie die Ressource haben (z. B. /content/cq:tags/default/my/tag):

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

Während ein Tag nur von einer Ressource (kein Knoten) konvertiert werden kann, kann ein Tag sowohl in einen Knoten als auch in eine Ressource konvertiert werden:

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

Abrufen und Festlegen von Tags

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

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

Suchen nach 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);

Löschen von Tags

tagManager.deleteTag(tag);

Replizieren von Tags

Es ist möglich, den Replikations-Service (Replicator) mit Tags zu verwenden, da Tags vom Typ nt:hierarchyNode sind:

replicator.replicate(session, replicationActionType, tagPath);

Der Tag Garbage Collector

Der Tag Garbage Collector ist ein Hintergrund-Service, der die ausgeblendeten und nicht verwendeten Tags bereinigt. Ausgeblendete und nicht verwendete Tags sind Tags unter /content/cq:tags, die eine cq:movedTo-Eigenschaft aufweisen und nicht für einen Inhaltsknoten verwendet werden. Ihre Anzahl beträgt null. Durch Verwenden dieses Lazy-Deletion-Prozesses muss der Inhaltsknoten (d. h. die Eigenschaft cq:tags) nicht als Teil des Verschiebungs- oder des Zusammenführungsvorgangs aktualisiert werden. Die Verweise in der Eigenschaft cq:tags werden automatisch aktualisiert, wenn die Eigenschaft cq:tags aktualisiert wird, z. B. durch das Seiteneigenschaften-Dialogfeld.

Das Garbage Collector Tag wird standardmäßig einmal am Tag ausgeführt. Dies kann konfiguriert werden unter:

http://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

Tag-Suche und Tag-Auflistung

Die Tag-Suche und die Tag-Auflistung funktionieren folgendermaßen:

• Die Suche nach TagID sucht nach den Tags, für die die Eigenschaft cq:movedTo auf TagID gesetzt ist und cq:movedTo-TagIDs folgt.
• Die Suche nach Tag-Titel sucht nur die Tags, die keine Eigenschaft cq:movedTo besitzen.

Tags in verschiedenen Sprachen

Ein title-Tag kann in verschiedenen Sprachen definiert werden. Eine sprachempfindliche Eigenschaft wird dann dem Tag-Knoten hinzugefügt. Diese Eigenschaft weist das Format jcr:title.<locale> auf, beispielsweise jcr:title.fr für die französische Übersetzung. <locale> muss eine ISO-Gebietsschema-Zeichenfolge in Kleinbuchstaben sein und den Unterstrich (_) anstelle des Bindestrichs (-) verwenden. Beispiel: de_ch.

Wenn zum Beispiel das Tag Tiere zur Seite Produkte hinzugefügt wird, wird der Wert stockphotography:animals zur Eigenschaft cq:tags des Knotens /content/wknd/en/products/jcr:content hinzugefügt. Die Übersetzung wird vom Tag-Knoten referenziert.

Die Server-seitige API verfügt über lokalisierte title-bezogene Methoden:

• 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)

In AEM kann die Sprache entweder aus der Seitensprache oder aus der Anwendersprache abgerufen werden.

Beim Tagging hängt die Lokalisierung vom Kontext ab, da Tag-titles in der Seitensprache, in der Anwendersprache oder in jeder anderen Sprache angezeigt werden können.

Hinzufügen einer neuen Sprache zum Dialogfeld „Tag bearbeiten“

Im folgenden Verfahren wird beschrieben, wie Sie dem Dialogfeld Tag bearbeiten eine neue Sprache (z. B. Finnisch) hinzufügen:

1. Bearbeiten Sie in CRXDE die Mehrwerteigenschaft languages des Knotens /content/cq:tags.
2. Fügen Sie fi_fi hinzu, das das finnische Gebietsschema darstellt, und speichern Sie die Änderungen.

Finnisch ist jetzt im Tag-Dialogfeld der Seiteneigenschaften und im Dialogfeld Tag bearbeiten verfügbar, wenn Sie ein Tag in der Tagging-Konsole bearbeiten.